udkapi/com/sun/star/beans/XPropertySet.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_XPropertySet_idl__
  20 #define __com_sun_star_beans_XPropertySet_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/XPropertySetInfo.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27
  28 #include <com/sun/star/beans/PropertyVetoException.idl>
  29
  30 #include <com/sun/star/lang/IllegalArgumentException.idl>
  31
  32 #include <com/sun/star/lang/WrappedTargetException.idl>
  33
  34 #include <com/sun/star/beans/XPropertyChangeListener.idl>
  35
  36 #include <com/sun/star/beans/XVetoableChangeListener.idl>
  37
  38
  39
  40 module com {  module sun {  module star {  module beans {
  41
  42
  43 /** provides information about and access to the
  44     properties from an implementation.
  45
  46     <p>There are three types of properties: </p>
  47
  48     <ul>
  49         <li>bound properties </li>
  50         <li>constrained properties </li>
  51         <li>free properties </li>
  52     </ul>
  53
  54     <p>You can listen to changes of bound properties with the
  55     XPropertyChangeListener and you can veto changes
  56     of constrained properties with the XVetoableChangeListener.  </p>
  57
  58     <p>To implement inaccurate name access, you must support the
  59     interface XExactName. </p>
  60
  61     @see com::sun::star::beans::XExactName
  62  */
  63 published interface XPropertySet: com::sun::star::uno::XInterface
  64 {
  65
  66     /** @returns
  67             the XPropertySetInfo interface, which
  68             describes all properties of the object which supplies this
  69             interface.
  70
  71         @returns
  72             NULL if the implementation cannot or will
  73             not provide information about the properties; otherwise the
  74             interface XPropertySetInfo is returned.
  75      */
  76     com::sun::star::beans::XPropertySetInfo getPropertySetInfo();
  77
  78
  79     /** sets the value of the property with the specified name.
  80
  81         <p>If it is a bound property the value will be changed before
  82         the change event is fired.  If it is a constrained property
  83         a vetoable event is fired before the property value can be
  84         changed.  </p>
  85
  86         @throws com::sun::star::beans::PropertyVetoException
  87             if the property is read-only or vetoable
  88             and one of the listeners throws this exception
  89             because of an unaccepted new value.
  90      */
  91     void setPropertyValue( [in] string aPropertyName,
  92              [in] any aValue )
  93             raises( com::sun::star::beans::UnknownPropertyException,
  94                     com::sun::star::beans::PropertyVetoException,
  95                     com::sun::star::lang::IllegalArgumentException,
  96                     com::sun::star::lang::WrappedTargetException );
  97
  98
  99     /** @returns
 100             the value of the property with the specified name.
 101
 102         @param PropertyName
 103             This parameter specifies the name of the property.
 104
 105         @throws UnknownPropertyException
 106             if the property does not exist.
 107
 108         @throws com::sun::star::lang::WrappedTargetException
 109             if the implementation has an internal reason for the exception.
 110             In this case the original exception is wrapped into that
 111             com::sun::star::lang::WrappedTargetException.
 112      */
 113     any getPropertyValue( [in] string PropertyName )
 114             raises( com::sun::star::beans::UnknownPropertyException,
 115                     com::sun::star::lang::WrappedTargetException );
 116
 117
 118     /** adds an XPropertyChangeListener to the specified property.
 119
 120         <p>An empty name ("") registers the listener to all bound
 121         properties. If the property is not bound, the behavior is
 122         not specified.  </p>
 123
 124         <p>It is suggested to allow multiple registration of the same listener,
 125         thus for each time a listener is added, it has to be removed.
 126
 127         @see removePropertyChangeListener
 128      */
 129     void addPropertyChangeListener( [in] string aPropertyName,
 130              [in] com::sun::star::beans::XPropertyChangeListener xListener )
 131             raises( com::sun::star::beans::UnknownPropertyException,
 132                     com::sun::star::lang::WrappedTargetException );
 133
 134
 135     /** removes an XPropertyChangeListener from
 136         the listener list.
 137
 138         <p>It is a "noop" if the listener is not registered.  </p>
 139
 140         <p>It is suggested to allow multiple registration of the same listener,
 141         thus for each time a listener is added, it has to be removed.
 142
 143         @see addPropertyChangeListener
 144      */
 145     void removePropertyChangeListener( [in] string aPropertyName,
 146              [in] com::sun::star::beans::XPropertyChangeListener aListener )
 147             raises( com::sun::star::beans::UnknownPropertyException,
 148                     com::sun::star::lang::WrappedTargetException );
 149
 150
 151     /** adds an XVetoableChangeListener to the specified
 152         property with the name PropertyName.
 153
 154         <p>An empty name ("") registers the listener to all
 155         constrained properties. If the property is not constrained,
 156         the behavior is not specified.  </p>
 157
 158         @see removeVetoableChangeListener
 159      */
 160     void addVetoableChangeListener( [in] string PropertyName,
 161              [in] com::sun::star::beans::XVetoableChangeListener aListener )
 162             raises( com::sun::star::beans::UnknownPropertyException,
 163                     com::sun::star::lang::WrappedTargetException );
 164
 165
 166     /** removes an XVetoableChangeListener from the
 167         listener list.
 168
 169         <p>It is a "noop" if the listener is not registered.  </p>
 170
 171         @see addVetoableChangeListener
 172      */
 173     void removeVetoableChangeListener( [in] string PropertyName,
 174              [in] com::sun::star::beans::XVetoableChangeListener aListener )
 175             raises( com::sun::star::beans::UnknownPropertyException,
 176                     com::sun::star::lang::WrappedTargetException );
 177
 178 };
 179
 180
 181 }; }; }; };
 182
 183 #endif
 184
 185 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */