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