udkapi/com/sun/star/beans/XPropertyWithState.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_XPropertyWithState_idl__
  20 #define __com_sun_star_beans_XPropertyWithState_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/lang/WrappedTargetException.idl>
  27
  28
  29 module com {  module sun {  module star {  module beans {
  30
  31
  32 /** makes it possible to query information about the state of
  33     this object, seen as a property contained in a property set.
  34
  35     <p> This interface provides direct access to operations
  36         that are available if the containing property set
  37         implements XPropertyState.
  38     </p>
  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 being used</li>
  44         <li>or if the value cannot be determined, due to ambiguity
  45             (multi selection with multiple values).</li>
  46     </ul>
  47
  48     <p> Generally objects that implement this interface
  49         also implement XProperty.
  50     </p>
  51  */
  52 published interface XPropertyWithState: com::sun::star::uno::XInterface
  53 {
  54
  55     /** @returns
  56                 the state of this as a property.
  57      */
  58     com::sun::star::beans::PropertyState getStateAsProperty( );
  59
  60
  61     /** sets this to its default value.
  62
  63         <p> The value depends on the implementation of this interface.
  64             If this is a bound property, the value changes before
  65             the change events are fired.  If this is a constrained property,
  66             the vetoable event is fired before the property value changes.
  67         </p>
  68
  69             @throws  com::sun::star::lang::WrappedTargetException
  70                 if the implementation has an internal reason for the exception.
  71                 In this case the original exception is wrapped into that
  72                 com::sun::star::lang::WrappedTargetException.
  73      */
  74     void setToDefaultAsProperty( )
  75             raises( com::sun::star::lang::WrappedTargetException );
  76
  77
  78     /**     @returns
  79                 an object representing the default state of this object (as a property).
  80
  81             <p> If no default exists, is not known or is void,
  82                 then the return value is `NULL`.
  83             </p>
  84
  85             @throws  com::sun::star::lang::WrappedTargetException
  86                 if the implementation has an internal reason for the exception.
  87                 In this case the original exception is wrapped into that
  88                 com::sun::star::lang::WrappedTargetException.
  89      */
  90     com::sun::star::uno::XInterface getDefaultAsProperty( )
  91             raises( com::sun::star::lang::WrappedTargetException );
  92 };
  93
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */