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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*************************************************************************
*
* 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_XHierarchicalPropertySet_idl__
#define __com_sun_star_beans_XHierarchicalPropertySet_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
#include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl>
#endif
#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
#include <com/sun/star/beans/UnknownPropertyException.idl>
#endif
#ifndef __com_sun_star_beans_PropertyVetoException_idl__
#include <com/sun/star/beans/PropertyVetoException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
//=============================================================================
module com { module sun { module star { module beans {
//=============================================================================
/** provides information about and access to the
a hierarchy of properties from an implementation.
<p> Usually an object that implements this interface
also implements <type>XPropertySet</type> and at
least some of the properties have subproperties. </p>
<p> This interface allows direct access to subsubproperties, ...
up to an arbitrary nesting depth. Often the intermediate
elements of the hierarchy implement <type>XProperty</type>. </p>
<p> Each implementation specifies how the
hierarchical property names, that are
used to access the elements of the hierarchy,
are formed. </p>
<p> Commonly a notation similar to filesystem pathes
(separated by '/' slashes) or nested module names
(separated by dots '.' or '::') is used. </p>
*/
published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** retrieve information about the hierarchy of properties
@returns
the <type>XHierarchicalPropertySetInfo</type> interface,
which describes the property hierarchy of the object which
supplies this interface.
@returns
<NULL/> if the implementation cannot or will
not provide information about the properties; otherwise the
interface <type>XHierarchicalPropertySetInfo</type> is returned.
*/
com::sun::star::beans::XHierarchicalPropertySetInfo
getHierarchicalPropertySetInfo();
//-------------------------------------------------------------------------
/** sets the value of the property with the specified nested name.
@param aHierarchicalPropertyName
This parameter specifies the name of the property.
@param aValue
This parameter specifies the new value for the property.
@throws UnknownPropertyException
if the property does not exist.
@throws PropertyVetoException
if the property is constrained and the change is vetoed by a
<type>XVetoableChangeListener</type>.
@throws com::sun::star::uno::lang::IllegalArgumentException
if <var>aValue</var> is not a legal value for this property or
if <var>aHierarchicalPropertyName</var> is not a well-formed
nested name for this hierarchy.
An implementation is not required to detect the latter condition.
@throws com::sun::star::lang::WrappedTargetException
if the implementation has an internal reason for the exception.
In this case the original exception is wrapped into that
<type scope="com::sun::star::lang">WrappedTargetException</type>.
@see XPropertySet::setPropertyValue
*/
void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName,
[in] any aValue )
raises( com::sun::star::beans::UnknownPropertyException,
com::sun::star::beans::PropertyVetoException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
/** @returns
the value of the property with the specified nested name.
@param aHierarchicalPropertyName
This parameter specifies the name of the property.
@throws UnknownPropertyException
if the property does not exist.
@throws com::sun::star::uno::lang::IllegalArgumentException
if <var>aHierarchicalPropertyName</var> is not a well-formed
nested name for this hierarchy.
An implementation is not required to detect this
condition.
@throws com::sun::star::lang::WrappedTargetException
if the implementation has an internal reason for the exception.
In this case the original exception is wrapped into that
<type scope="com::sun::star::lang">WrappedTargetException</type>.
@see XPropertySet::getPropertyValue
*/
any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName )
raises( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
};
//=============================================================================
}; }; }; };
#endif
|
