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