1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_script_browse_XBrowseNode_idl__
25#define __com_sun_star_script_browse_XBrowseNode_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31module com { module sun { module star { module script { module browse {
32//==============================================================================
33/**
34    This interface represents a node in the hierarchy used to browse
35    available scripts.
36    Objects implementing this interface are expected to also implement
37    com.sun.star.beans.XPropertySet and, optionally,
38    com.sun.star.script.XInvocation (see the Developers' Guide for
39    more details).
40*/
41interface XBrowseNode : ::com::sun::star::uno::XInterface
42{
43  //-----------------------------------------------------------------------
44  /**
45    Get the name of the node
46
47    @return
48     The <atom>string</atom> name of this node
49  */
50  string getName();
51
52  //----------------------------------------------------------------------
53  /**
54    Get the children of this node
55
56    @returns
57    <type scope="::com::sun::star::script::browse">XBrowseNode</type> sequence of child nodes
58  */
59    sequence < XBrowseNode > getChildNodes();
60
61  //----------------------------------------------------------------------
62  /**
63    Indicates if this node contains any children
64
65    @returns
66    <atom> boolean </atom> true if there are child nodes.
67  */
68    boolean hasChildNodes();
69
70    //-------------------------------------------------------------------
71    /** the type of the node.
72        @returns A <atom>short</atom> reresenting the type of this node.
73    */
74    short getType();
75
76};
77
78};  };  };  }; };
79#endif
80