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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*************************************************************************
*
* $RCSfile: XPropertyState.idl,v $
*
* $Revision: 1.2 $
*
* last change: $Author: mi $ $Date: 2000-11-06 13:00:26 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_beans_XPropertyState_idl__
#define __com_sun_star_beans_XPropertyState_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_PropertyState_idl__
#include <com/sun/star/beans/PropertyState.idl>
#endif
#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
#include <com/sun/star/beans/UnknownPropertyException.idl>
#endif
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
#ifndef __com_sun_star_beans_XPropertyStateChangeListener_idl__
#include <com/sun/star/beans/XPropertyStateChangeListener.idl>
#endif
//=============================================================================
module com { module sun { module star { module beans {
//=============================================================================
// DocMerge from xml: interface com::sun::star::beans::XPropertyState
/** makes it possible to query information about the state of
one or more properties.
<p>The state contains the information if:</p>
<ul>
<li>a value is available or void</li>
<li>the value is stored in the object itself, or if a default value is to be used</li>
<li>and if the value cannot be determined, due to ambiguity
(multi selection with multipe values).</li>
</ul>
*/
[ uik(E227A393-33D6-11D1-AABE00A0-249D5590), ident( "XPropertyState", 1.0 ) ]
interface XPropertyState: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::beans::XPropertyState::getPropertyState
/** @returns
the state of the property.
@param aPropertyName
specifies the name of the property.
@throws UnknownPropertyException
if the property does not exist.
*/
com::sun::star::beans::PropertyState getPropertyState( [in] string PropertyName )
raises( com::sun::star::beans::UnknownPropertyException );
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::beans::XPropertyState::getPropertyStates
/** @returns
a sequence of the states of the properties which are specified
by their names.
<p>The order of the states is correlating to the order of the
given property names.
*/
sequence<com::sun::star::beans::PropertyState> getPropertyStates(
[in] sequence<string> aPropertyName )
raises( com::sun::star::beans::UnknownPropertyException );
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::beans::XPropertyState::setPropertyToDefault
/** Sets the property to default value.
<p>The value depends on the implementation of this interface.
If it is a bound property, you must change the value before
the change events are fired. If it is a constrained property, you
must fire the vetoable event before you change the property value.
</p>
*/
void setPropertyToDefault( [in] string PropertyName )
raises( com::sun::star::beans::UnknownPropertyException );
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::beans::XPropertyState::getPropertyDefault
/** @returns
the default value of the property with the name PropertyName.
<p>If no default exists, is not known or is void,
then the return type is <type>void</type>.
@param aPropertyName
specifies the name of the property.
@throws UnknownPropertyException
if the property does not exist.
@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>.
*/
[const] any getPropertyDefault( [in] string aPropertyName )
raises( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException );
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.2 2000/10/09 14:24:53 mi
#78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
Revision 1.1.1.1 2000/09/18 23:34:56 hjs
initial import
Revision 1.5 2000/09/11 11:52:12 mi
documentation merged from XML
Revision 1.3 2000/02/23 12:43:24 mi
missing documentations
Revision 1.2 2000/01/24 12:42:57 mi
#69861# no status change listeners anymore
Revision 1.1.1.1 1999/11/11 09:48:40 jsc
new
=============================================================================*/
#endif
|
