offapi/com/sun/star/script/browse/XBrowseNode.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XBrowseNode.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_script_browse_XBrowseNode_idl__
  32 #define __com_sun_star_script_browse_XBrowseNode_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module script { module browse {
  39 //==============================================================================
  40 /**
  41     This interface represents a node in the hierarchy used to browse
  42     available scripts.
  43     Objects implementing this interface are expected to also implement
  44     com.sun.star.beans.XPropertySet and, optionally,
  45     com.sun.star.script.XInvocation (see the Developers' Guide for
  46     more details).
  47 */
  48 interface XBrowseNode : ::com::sun::star::uno::XInterface
  49 {
  50   //-----------------------------------------------------------------------
  51   /**
  52     Get the name of the node
  53
  54     @return
  55      The <atom>string</atom> name of this node
  56   */
  57   string getName();
  58
  59   //----------------------------------------------------------------------
  60   /**
  61     Get the children of this node
  62
  63     @returns
  64     <type scope="::com::sun::star::script::browse">XBrowseNode</type> sequence of child nodes
  65   */
  66     sequence < XBrowseNode > getChildNodes();
  67
  68   //----------------------------------------------------------------------
  69   /**
  70     Indicates if this node contains any children
  71
  72     @returns
  73     <atom> boolean </atom> true if there are child nodes.
  74   */
  75     boolean hasChildNodes();
  76
  77     //-------------------------------------------------------------------
  78     /** the type of the node.
  79         @returns A <atom>short</atom> reresenting the type of this node.
  80     */
  81     short getType();
  82
  83 };
  84
  85 };  };  };  }; };
  86 #endif