1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_PropertyState_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_beans_PropertyState_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski//=============================================================================
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielskimodule com {  module sun {  module star {  module beans {
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski//=============================================================================
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski/** This enumeration lists the states that a property value can have.
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski	<p>The state consists of two aspects: </p>
36*b1cdbd2cSJim Jagielski	<ol>
37*b1cdbd2cSJim Jagielski		<li>whether a value is available or void, </li>
38*b1cdbd2cSJim Jagielski		<li>whether the value is stored in the property set itself or is a
39*b1cdbd2cSJim Jagielski			default, or ambiguous.  </li>
40*b1cdbd2cSJim Jagielski	</ol>
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski	@see XPropertyState
43*b1cdbd2cSJim Jagielski	@see Property
44*b1cdbd2cSJim Jagielski */
45*b1cdbd2cSJim Jagielskipublished enum PropertyState
46*b1cdbd2cSJim Jagielski{
47*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski	/** The value of the property is stored in the PropertySet itself.
50*b1cdbd2cSJim Jagielski
51*b1cdbd2cSJim Jagielski		<p>The property value must be available and of the specified type.
52*b1cdbd2cSJim Jagielski		If the <member>PropertyAttribute</member> field in the struct
53*b1cdbd2cSJim Jagielski		<type>Property</type> contains <const>PropertyAttribute::MAYBEVOID</const>,
54*b1cdbd2cSJim Jagielski		then the value may be void. </p>
55*b1cdbd2cSJim Jagielski	 */
56*b1cdbd2cSJim Jagielski	DIRECT_VALUE,
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
59*b1cdbd2cSJim Jagielski
60*b1cdbd2cSJim Jagielski	/** The value of the property is available from a master (e.g., template).
61*b1cdbd2cSJim Jagielski
62*b1cdbd2cSJim Jagielski		<p>The <member>PropertyAttribute</member> field in the struct
63*b1cdbd2cSJim Jagielski		<type>Property</type> must contain the
64*b1cdbd2cSJim Jagielski		<const>PropertyAttribute::MAYBEDEFAULT</const> flag. The property
65*b1cdbd2cSJim Jagielski		value must be available and of the specified type. If the
66*b1cdbd2cSJim Jagielski		<member>PropertyAttribute</member> field in the struct <type>Property</type>
67*b1cdbd2cSJim Jagielski		contains <const>PropertyAttribute::MAYBEVOID</const>, then the
68*b1cdbd2cSJim Jagielski		value may be void. </p>
69*b1cdbd2cSJim Jagielski	 */
70*b1cdbd2cSJim Jagielski	DEFAULT_VALUE,
71*b1cdbd2cSJim Jagielski
72*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
73*b1cdbd2cSJim Jagielski
74*b1cdbd2cSJim Jagielski	/** The value of the property is only a recommendation because there
75*b1cdbd2cSJim Jagielski		are multiple values for this property (e.g., from a multi selection).
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski		<p>The <member>PropertyAttribute</member> field in the struct
78*b1cdbd2cSJim Jagielski		<type>Property</type> must contain the
79*b1cdbd2cSJim Jagielski		<const>PropertyAttribute::MAYBEAMBIGUOUS</const> flag. The
80*b1cdbd2cSJim Jagielski		property value must be available and of the specified type.
81*b1cdbd2cSJim Jagielski		If the Attribute field in the struct Property contains
82*b1cdbd2cSJim Jagielski		<const>PropertyAttribute::MAYBEVOID</const>, then the value
83*b1cdbd2cSJim Jagielski		may be void. </p>
84*b1cdbd2cSJim Jagielski	 */
85*b1cdbd2cSJim Jagielski	AMBIGUOUS_VALUE
86*b1cdbd2cSJim Jagielski
87*b1cdbd2cSJim Jagielski};
88*b1cdbd2cSJim Jagielski
89*b1cdbd2cSJim Jagielski//=============================================================================
90*b1cdbd2cSJim Jagielski
91*b1cdbd2cSJim Jagielski}; }; }; };
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski#endif
94