summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/script/browse/XBrowseNode.idl
blob: 4321702f3a7fdbf6dca31917ad5c9672a496e43f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

module com { module sun { module star { module script { module browse {
/**
    This interface represents a node in the hierarchy used to browse
    available scripts.
    Objects implementing this interface are expected to also implement
    com.sun.star.beans.XPropertySet and, optionally,
    com.sun.star.script.XInvocation (see the Developer's Guide for
    more details).
*/
interface XBrowseNode : ::com::sun::star::uno::XInterface
{
  /**
    Get the name of the node

    @return
     The `string` name of this node
  */
  string getName();

  /**
    Get the children of this node

    @returns
    ::com::sun::star::script::browse::XBrowseNode sequence of child nodes
  */
    sequence < XBrowseNode > getChildNodes();

  /**
    Indicates if this node contains any children

    @returns
    ` boolean ` true if there are child nodes.
  */
    boolean hasChildNodes();

    /** the type of the node.
        @returns A `short` representing the type of this node.
    */
    short getType();

};

};  };  };  }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */