udkapi/com/sun/star/beans/PropertyState.idl

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