summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/container/XHierarchicalName.idl
blob: 5913390249c9dc6c9300c2f17eb343d5c4760a73 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_container_XHierarchicalName_idl__
#define __com_sun_star_container_XHierarchicalName_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module container {

//=============================================================================

/** specifies the fully qualified name of the object within a hierarchy.

    <p>The name is generally globally unique in the hierarchy.  </p>

    @see com::sun::star::container::XHierarchicalNameAccess
    @see com::sun::star::container::XNamed
 */
published interface XHierarchicalName: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                the fully qualified hierarchical name of the object.
     */
    string getHierarchicalName();

    //-------------------------------------------------------------------------

    /** builds the hierarchical name of an object, given a relative name

        <p>Can be used to find the name of a descendant object in the hierarchy
        without actually accessing it.  </p>

        @see XHierarchicalNameAccess::hasByHierarchicalName
     */
    string composeHierarchicalName( [in] string aRelativeName )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::lang::NoSupportException );
};

//=============================================================================

}; }; }; };

#endif