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