udkapi/com/sun/star/beans/XPropertyState.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: XPropertyState.idl,v $
  10  * $Revision: 1.15 $
  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_XPropertyState_idl__
  31 #define __com_sun_star_beans_XPropertyState_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyState_idl__
  38 #include <com/sun/star/beans/PropertyState.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_UnknownPropertyException_idl__
  42 #include <com/sun/star/beans/UnknownPropertyException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  46 #include <com/sun/star/lang/WrappedTargetException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertyStateChangeListener_idl__
  50 #include <com/sun/star/beans/XPropertyStateChangeListener.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56 module com {  module sun {  module star {  module beans {
  57
  58 //=============================================================================
  59
  60 /** makes it possible to query information about the state of
  61     one or more properties.
  62
  63     <p>The state contains the information if:</p>
  64     <ul>
  65         <li>a value is available or void</li>
  66         <li>the value is stored in the object itself, or if a default value is to be used</li>
  67         <li>and if the value cannot be determined, due to ambiguity
  68             (multi selection with multiple values).</li>
  69     </ul>
  70  */
  71 published interface XPropertyState: com::sun::star::uno::XInterface
  72 {
  73     //-------------------------------------------------------------------------
  74
  75     /** @returns
  76                 the state of the property.
  77
  78         @param  aPropertyName
  79             specifies the name of the property.
  80
  81         @throws UnknownPropertyException
  82             if the property does not exist.
  83      */
  84     com::sun::star::beans::PropertyState getPropertyState( [in] string PropertyName )
  85             raises( com::sun::star::beans::UnknownPropertyException );
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** @returns
  90             a sequence of the states of the properties which are specified
  91                 by their names.
  92
  93         <p>The order of the states is correlating to the order of the
  94         given property names. </p>
  95
  96         @param aPropertyNames
  97             contains the sequence of property names.
  98
  99         @throws UnknownPropertyException
 100             if one property does not exist.
 101      */
 102     sequence<com::sun::star::beans::PropertyState> getPropertyStates(
 103             [in] sequence<string> aPropertyName )
 104         raises( com::sun::star::beans::UnknownPropertyException );
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** Sets the property to default value.
 109
 110         <p>The value depends on the implementation of this interface.
 111         If it is a bound property, you must change the value before
 112         the change events are fired.  If it is a constrained property, you
 113         must fire the vetoable event before you change the property value.
 114         </p>
 115
 116         @param aPropertyname
 117             specifies the name of the property.
 118
 119         @throws UnknownPropertyException
 120             if the property does not exist.
 121      */
 122     void setPropertyToDefault( [in] string PropertyName )
 123             raises( com::sun::star::beans::UnknownPropertyException );
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** @returns
 128             the default value of the property with the name PropertyName.
 129
 130         <p>If no default exists, is not known or is void,
 131         then the return type is <atom>void</atom>.
 132
 133         @param aPropertyName
 134             specifies the name of the property.
 135
 136         @throws UnknownPropertyException
 137             if the property does not exist.
 138
 139         @throws  com::sun::star::lang::WrappedTargetException
 140             if the implementation has an internal reason for the exception.
 141             In this case the original exception is wrapped into that
 142             <type scope="com::sun::star::lang">WrappedTargetException</type>.
 143      */
 144     any getPropertyDefault( [in] string aPropertyName )
 145             raises( com::sun::star::beans::UnknownPropertyException,
 146                     com::sun::star::lang::WrappedTargetException );
 147 };
 148
 149 //=============================================================================
 150
 151 }; }; }; };
 152
 153 #endif