udkapi/com/sun/star/beans/XMultiPropertyStates.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: XMultiPropertyStates.idl,v $
  10  * $Revision: 1.13 $
  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_XMultiPropertyState_idl__
  31 #define __com_sun_star_beans_XMultiPropertyState_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 /** makes it possible to query information about the state of
  60     one or more properties.
  61
  62     <p>The state of a property contains information about the source of
  63     the value, e.g. the object itself, a default or a stylesheet.
  64     For more information see <type>PropertyState</type>.
  65 */
  66 published interface XMultiPropertyStates: com::sun::star::uno::XInterface
  67 {
  68     //-------------------------------------------------------------------------
  69     /** @returns
  70             a sequence of the states of the properties which are specified
  71             by their names.
  72
  73         <p>The order of the states is correlating to the order of the
  74         given property names.
  75
  76         @param aPropertyName
  77             specifies the names of the properties. All names must be unique.
  78             This sequence must be alphabetically sorted.
  79     */
  80     sequence<com::sun::star::beans::PropertyState> getPropertyStates(
  81             [in] sequence<string> aPropertyName )
  82         raises( com::sun::star::beans::UnknownPropertyException );
  83
  84     //-------------------------------------------------------------------------
  85     /** sets all properties to their default values.
  86
  87         <p>Each value depends on the implementation of this interface.
  88         If it is a bound property, you must change the value before
  89         the change events are fired.  If it is a constrained property, you
  90         must fire the vetoable event before you change the property value.
  91         </p>
  92     */
  93     void setAllPropertiesToDefault();
  94
  95     //-------------------------------------------------------------------------
  96     /** sets the specified properties to their default values.
  97
  98         <p>Each value depends on the implementation of this interface.
  99         If it is a bound property, you must change the value before
 100         the change events are fired.  If it is a constrained property, you
 101         must fire the vetoable event before you change the property value. </p>
 102
 103         @param aPropertyName
 104             specifies the names of the properties. All names must be unique.
 105             This sequence must be alphabetically sorted.
 106
 107         @throws UnknownPropertyException
 108             if one of the properties does not exist.
 109     */
 110     void setPropertiesToDefault( [in] sequence<string> aPropertyNames )
 111             raises( com::sun::star::beans::UnknownPropertyException );
 112
 113     //-------------------------------------------------------------------------
 114     /** @returns
 115             the default values of the propertes with the specified names.
 116
 117         <p>If no default exists, is not known, or is void,
 118         then the return type at the corresponding position in the
 119         sequence returned is <atom>void</atom>. </p>
 120
 121         @param aPropertyName
 122             specifies the names of the properties. All names must be unique.
 123             This sequence must be alphabetically sorted.
 124
 125         @throws UnknownPropertyException
 126             if one of the propertes does not exist.
 127
 128         @throws  com::sun::star::lang::WrappedTargetException
 129             if the implementation has an internal reason for the exception.
 130             In this case the original exception is wrapped into that
 131             <type scope="com::sun::star::lang">WrappedTargetException</type>.
 132     */
 133     sequence<any> getPropertyDefaults(
 134                 [in] sequence<string> aPropertyNames )
 135             raises( com::sun::star::beans::UnknownPropertyException,
 136                     com::sun::star::lang::WrappedTargetException );
 137 };
 138
 139 //=============================================================================
 140
 141 }; }; }; };
 142
 143 #endif