udkapi/com/sun/star/beans/XPropertyContainer.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_XPropertyContainer_idl__
  20 #define __com_sun_star_beans_XPropertyContainer_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/reflection/XIdlClass.idl>
  25
  26 #include <com/sun/star/beans/PropertyExistException.idl>
  27
  28 #include <com/sun/star/beans/IllegalTypeException.idl>
  29
  30 #include <com/sun/star/beans/UnknownPropertyException.idl>
  31
  32 #include <com/sun/star/beans/NotRemoveableException.idl>
  33
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35
  36
  37 module com {  module sun {  module star {  module beans {
  38
  39
  40 /** makes it possible to add and remove properties to or from an object.
  41
  42     <p>Some scripting engines cannot access properties directly when the
  43     property set is changed.  Please use XPropertySet::getPropertyValue()
  44     etc. in this case. </p>
  45  */
  46 published interface XPropertyContainer: com::sun::star::uno::XInterface
  47 {
  48
  49     /** adds a property to the object.
  50
  51         @param Name
  52             specifies the name of the new property.
  53
  54         @param Attributes
  55             specifies the property attributes, see PropertyAttribute.
  56
  57         @param DefaultValue
  58             specifies the type of the new property and a potential default value.
  59
  60         @throws PropertyExistException
  61             if a property with the same name already exists.
  62
  63         @throws IllegalTypeException
  64             if the specified type is not allowed.
  65
  66      */
  67     void addProperty( [in] string Name,
  68                        [in] short Attributes,
  69                       [in] any DefaultValue )
  70             raises( com::sun::star::beans::PropertyExistException,
  71                     com::sun::star::beans::IllegalTypeException,
  72                     com::sun::star::lang::IllegalArgumentException );
  73
  74
  75     /** removes a property from the object.
  76
  77         @param Name
  78             specified the name of the property.
  79
  80         @throws UnknownPropertyException
  81             if the property does not exist.
  82      */
  83     void removeProperty( [in] string Name )
  84             raises( com::sun::star::beans::UnknownPropertyException,
  85                     com::sun::star::beans::NotRemoveableException );
  86 };
  87
  88
  89 }; }; }; };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */