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