1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_beans_PropertyState_idl__ 28#define __com_sun_star_beans_PropertyState_idl__ 29 30 31//============================================================================= 32 33module com { module sun { module star { module beans { 34 35//============================================================================= 36 37/** This enumeration lists the states that a property value can have. 38 39 <p>The state consists of two aspects: </p> 40 <ol> 41 <li>whether a value is available or void, </li> 42 <li>whether the value is stored in the property set itself or is a 43 default, or ambiguous. </li> 44 </ol> 45 46 @see XPropertyState 47 @see Property 48 */ 49published enum PropertyState 50{ 51 //------------------------------------------------------------------------- 52 53 /** The value of the property is stored in the PropertySet itself. 54 55 <p>The property value must be available and of the specified type. 56 If the <member>PropertyAttribute</member> field in the struct 57 <type>Property</type> contains <const>PropertyAttribute::MAYBEVOID</const>, 58 then the value may be void. </p> 59 */ 60 DIRECT_VALUE, 61 62 //------------------------------------------------------------------------- 63 64 /** The value of the property is available from a master (e.g., template). 65 66 <p>The <member>PropertyAttribute</member> field in the struct 67 <type>Property</type> must contain the 68 <const>PropertyAttribute::MAYBEDEFAULT</const> flag. The property 69 value must be available and of the specified type. If the 70 <member>PropertyAttribute</member> field in the struct <type>Property</type> 71 contains <const>PropertyAttribute::MAYBEVOID</const>, then the 72 value may be void. </p> 73 */ 74 DEFAULT_VALUE, 75 76 //------------------------------------------------------------------------- 77 78 /** The value of the property is only a recommendation because there 79 are multiple values for this property (e.g., from a multi selection). 80 81 <p>The <member>PropertyAttribute</member> field in the struct 82 <type>Property</type> must contain the 83 <const>PropertyAttribute::MAYBEAMBIGUOUS</const> flag. The 84 property value must be available and of the specified type. 85 If the Attribute field in the struct Property contains 86 <const>PropertyAttribute::MAYBEVOID</const>, then the value 87 may be void. </p> 88 */ 89 AMBIGUOUS_VALUE 90 91}; 92 93//============================================================================= 94 95}; }; }; }; 96 97#endif 98