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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_XPropertyState_idl__
  20 #define __com_sun_star_beans_XPropertyState_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/PropertyState.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27
  28 #include <com/sun/star/lang/WrappedTargetException.idl>
  29
  30 #include <com/sun/star/beans/XPropertyStateChangeListener.idl>
  31
  32
  33
  34 module com {  module sun {  module star {  module beans {
  35
  36
  37 /** makes it possible to query information about the state of
  38     one or more properties.
  39
  40     <p>The state contains the information if:</p>
  41     <ul>
  42         <li>a value is available or void</li>
  43         <li>the value is stored in the object itself, or if a default value is to be used</li>
  44         <li>and if the value cannot be determined, due to ambiguity
  45             (multi selection with multiple values).</li>
  46     </ul>
  47  */
  48 published interface XPropertyState: com::sun::star::uno::XInterface
  49 {
  50
  51     /** @returns
  52                 the state of the property.
  53
  54         @param  PropertyName
  55             specifies the name of the property.
  56
  57         @throws UnknownPropertyException
  58             if the property does not exist.
  59      */
  60     com::sun::star::beans::PropertyState getPropertyState(
  61                 [in] string PropertyName )
  62             raises( com::sun::star::beans::UnknownPropertyException );
  63
  64
  65     /** @returns
  66             a sequence of the states of the properties which are specified
  67                 by their names.
  68
  69         <p>The order of the states is correlating to the order of the
  70         given property names. </p>
  71
  72         @param aPropertyName
  73             contains the sequence of property names.
  74
  75         @throws UnknownPropertyException
  76             if one property does not exist.
  77      */
  78     sequence<com::sun::star::beans::PropertyState> getPropertyStates(
  79             [in] sequence<string> aPropertyName )
  80         raises( com::sun::star::beans::UnknownPropertyException );
  81
  82
  83     /** Sets the property to default value.
  84
  85         <p>The value depends on the implementation of this interface.
  86         If it is a bound property, you must change the value before
  87         the change events are fired.  If it is a constrained property, you
  88         must fire the vetoable event before you change the property value.
  89         </p>
  90
  91         @param PropertyName
  92             specifies the name of the property.
  93
  94         @throws UnknownPropertyException
  95             if the property does not exist.
  96      */
  97     void setPropertyToDefault( [in] string PropertyName )
  98             raises( com::sun::star::beans::UnknownPropertyException );
  99
 100
 101     /** @returns
 102             the default value of the property with the name PropertyName.
 103
 104         <p>If no default exists, is not known or is void,
 105         then the return type is `void`.
 106
 107         @param aPropertyName
 108             specifies the name of the property.
 109
 110         @throws UnknownPropertyException
 111             if the property does not exist.
 112
 113         @throws  com::sun::star::lang::WrappedTargetException
 114             if the implementation has an internal reason for the exception.
 115             In this case the original exception is wrapped into that
 116             com::sun::star::lang::WrappedTargetException.
 117      */
 118     any getPropertyDefault( [in] string aPropertyName )
 119             raises( com::sun::star::beans::UnknownPropertyException,
 120                     com::sun::star::lang::WrappedTargetException );
 121 };
 122
 123
 124 }; }; }; };
 125
 126 #endif
 127
 128 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */