/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: PropertyState.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/09 14:48:27 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_beans_PropertyState_idl__ 
#define __com_sun_star_beans_PropertyState_idl__ 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module beans {  
 
//============================================================================= 
 
/** This enumeration lists the states that a property value can have.
	
	<p>The state consists of two aspects: </p>
	<ol>
		<li>whether a value is available or void, </li>
		<li>whether the value is stored in the property set itself or is a
			default, or ambiguous.  </li>
	</ol>
	
	@see XPropertyState 
	@see Property
 */
published enum PropertyState
{ 
	//------------------------------------------------------------------------- 
	 
	/** The value of the property is stored in the PropertySet itself. 
		
		<p>The property value must be available and of the specified type.
		If the <member>PropertyAttribute</member> field in the struct 
		<type>Property</type> contains <const>PropertyAttribute::MAYBEVOID</const>, 
		then the value may be void. </p>
	 */
	DIRECT_VALUE, 
 
	//------------------------------------------------------------------------- 
	 
	/** The value of the property is available from a master (e.g., template). 
		
		<p>The <member>PropertyAttribute</member> field in the struct 
		<type>Property</type> must contain the 
		<const>PropertyAttribute::MAYBEDEFAULT</const> flag. The property
		value must be available and of the specified type. If the 
		<member>PropertyAttribute</member> field in the struct <type>Property</type> 
		contains <const>PropertyAttribute::MAYBEVOID</const>, then the 
		value may be void. </p>
	 */
	DEFAULT_VALUE, 
 
	//------------------------------------------------------------------------- 
	 
	/** The value of the property is only a recommendation because there
		are multiple values for this property (e.g., from a multi selection). 
		
		<p>The <member>PropertyAttribute</member> field in the struct 
		<type>Property</type> must contain the 
		<const>PropertyAttribute::MAYBEAMBIGUOUS</const> flag. The 
		property value must be available and of the specified type.
		If the Attribute field in the struct Property contains 
		<const>PropertyAttribute::MAYBEVOID</const>, then the value 
		may be void. </p>
	 */
	AMBIGUOUS_VALUE 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif 
