summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl
blob: faf9c1112f58b580a4f846b76a9c50dd94555c76 (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*************************************************************************
 *
 * 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_beans_XHierarchicalPropertySetInfo_idl__ 
#define __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_Property_idl__ 
#include <com/sun/star/beans/Property.idl> 
#endif 
 
#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 
#include <com/sun/star/beans/UnknownPropertyException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module beans {  
 
//============================================================================= 
 
/** specifies a hierarchy of properties.
    
    <p>The specification only describes the properties, it does not contain
    any values.</p>
 */
published interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    /** @returns 
                the property with the specified name from the hierarchy. 
                 
        @param aHierarchicalName  
                specifies the nested name of the property. 
             
        @throws UnknownPropertyException	 
                if the property does not exist.

        @throws com::sun::star::lang::IllegalArgumentException  
                if <var>aHierarchicalName</var> is not a well-formed 
                nested name for this hierarchy.
                   An implementation is not required to detect this
                condition.

     */
    com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName ) 
            raises( com::sun::star::beans::UnknownPropertyException ); 
 
    //------------------------------------------------------------------------- 
     
    /** @returns 
                <TRUE/> if a property with the specified name exists; 
                otherwise <FALSE/> is returned. 
                 
        @param	aHierarchicalName  
                specifies the name of the property.

        @throws com::sun::star::lang::IllegalArgumentException  
                if <var>aHierarchicalName</var> is not a well-formed 
                nested name for this hierarchy.
                   An implementation is not required to detect this
                condition.
     */
    boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif