udkapi/com/sun/star/beans/PropertyAttribute.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: PropertyAttribute.idl,v $
  10  * $Revision: 1.18 $
  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_PropertyAttribute_idl__
  31 #define __com_sun_star_beans_PropertyAttribute_idl__
  32
  33 //=============================================================================
  34
  35  module com {  module sun {  module star {  module beans {
  36
  37 //=============================================================================
  38
  39 /** These values are used to specify the behavior of a <type>Property</type>.
  40  */
  41 published constants PropertyAttribute
  42 {
  43     //-------------------------------------------------------------------------
  44
  45     /** indicates that a property value can be void.
  46
  47         <p>It does not mean that the type of the property is void!
  48      */
  49     const short MAYBEVOID = 1;
  50
  51     //-------------------------------------------------------------------------
  52
  53     /** indicates that a <type>PropertyChangeEvent</type> will be fired
  54         to all registered <type>XPropertyChangeListener</type>s whenever the
  55         value of this property changes.
  56      */
  57     const short BOUND = 2;
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** indicates that a <type>PropertyChangeEvent</type> will be fired
  62         to all registered <type>XVetoableChangeListener</type>s whenever the
  63         value of this property changes.
  64
  65             <p>This always implies that the property is <em>bound</em>, too. </p>
  66      */
  67     const short CONSTRAINED = 4;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** indicates that the value of the property is not persistent.
  72      */
  73     const short TRANSIENT = 8;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** indicates that the value of the property is read-only.
  78      */
  79     const short READONLY = 16;
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** indicates that the value of the property can be ambiguous.
  84      */
  85     const short MAYBEAMBIGUOUS = 32;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** indicates that the property can be set to default.
  90      */
  91     const short MAYBEDEFAULT = 64;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** indicates that the property can be removed
  96         (i.e., by calling <member>XPropertyContainer::removeProperty</member>).
  97      */
  98     const short REMOVEABLE = 128;
  99
 100     //-------------------------------------------------------------------------
 101     /** @deprecated
 102         same as <const>PropertyAttribute::REMOVEABLE</const>.
 103      */
 104     const short REMOVABLE = 128;
 105
 106     //-------------------------------------------------------------------------
 107     /** indicates that a property is optional.
 108
 109         <p>This attribute is not of interest for concrete property
 110         implementations. It's needed for property specifications inside
 111         service specifications in UNOIDL.
 112
 113         @see com::sun::star::reflection::XPropertyTypeDescription
 114         @see com::sun::star::reflection::XServiceTypeDescription
 115     @since OOo 1.1.2
 116      */
 117     const short OPTIONAL = 256;
 118 };
 119
 120 //=============================================================================
 121
 122 }; }; }; };
 123
 124 #endif