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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XPropertyWithState.idl,v $
* $Revision: 1.12 $
*
* 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_XPropertyWithState_idl__
#define __com_sun_star_beans_XPropertyWithState_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_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
//=============================================================================
module com { module sun { module star { module beans {
//=============================================================================
/** makes it possible to query information about the state of
this object, seen as a property contained in a property set.
<p> This interface provides direct access to operations
that are available if the containing property set
implements <type>XPropertyState</type>.
</p>
<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 being used</li>
<li>or if the value cannot be determined, due to ambiguity
(multi selection with multiple values).</li>
</ul>
<p> Generally objects that implement this interface
also implement <type>XProperty</type>.
</p>
*/
published interface XPropertyWithState: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** @returns
the state of this as a property.
*/
com::sun::star::beans::PropertyState getStateAsProperty( );
//-------------------------------------------------------------------------
/** sets this to its default value.
<p> The value depends on the implementation of this interface.
If this is a bound property, the value changes before
the change events are fired. If this is a constrained property,
the vetoable event is fired before the property value changes.
</p>
@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>.
*/
void setToDefaultAsProperty( )
raises( com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
/** @returns
an object representing the default state of this object (as a property).
<p> If no default exists, is not known or is void,
then the return value is <NULL/>.
</p>
@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>.
*/
com::sun::star::uno::XInterface getDefaultAsProperty( )
raises( com::sun::star::lang::WrappedTargetException );
};
//=============================================================================
}; }; }; };
#endif
|
