1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_beans_XPropertyContainer_idl__
28#define __com_sun_star_beans_XPropertyContainer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_reflection_XIdlClass_idl__
35#include <com/sun/star/reflection/XIdlClass.idl>
36#endif
37
38#ifndef __com_sun_star_beans_PropertyExistException_idl__
39#include <com/sun/star/beans/PropertyExistException.idl>
40#endif
41
42#ifndef __com_sun_star_beans_IllegalTypeException_idl__
43#include <com/sun/star/beans/IllegalTypeException.idl>
44#endif
45
46#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
47#include <com/sun/star/beans/UnknownPropertyException.idl>
48#endif
49
50#ifndef __com_sun_star_beans_NotRemoveableException_idl__
51#include <com/sun/star/beans/NotRemoveableException.idl>
52#endif
53
54#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
55#include <com/sun/star/lang/IllegalArgumentException.idl>
56#endif
57
58//=============================================================================
59
60module com {  module sun {  module star {  module beans {
61
62//=============================================================================
63
64/** makes it possible to add and remove properties to or from an object.
65
66	<p>Some scripting engines cannot access properties directly when the
67	property set is changed.  Please use <member>XPropertySet::getPropertyValue</member>
68	etc. in this case. </p>
69 */
70published interface XPropertyContainer: com::sun::star::uno::XInterface
71{
72	//-------------------------------------------------------------------------
73
74	/** adds a property to the object.
75
76		@param aName
77			specifies the name of the new property.
78
79		@param Attributes
80			specifies the property attributes, see <type>PropertyAttribute</type>.
81
82		@param DefaultValue
83			specifies the type of the new property and a potential default value.
84
85		@throws PropertyExistException
86			if a property with the same name already exists.
87
88		@throws IllegalTypeException
89			if the specified type is not allowed.
90
91	 */
92	void addProperty( [in] string Name,
93			 		  [in] short Attributes,
94					  [in] any DefaultValue )
95			raises( com::sun::star::beans::PropertyExistException,
96					com::sun::star::beans::IllegalTypeException,
97					com::sun::star::lang::IllegalArgumentException );
98
99	//-------------------------------------------------------------------------
100
101	/** removes a property from the object.
102
103		@param aName
104			specified the name of the property.
105
106		@throws UnknownPropertyException
107			if the property does not exist.
108	 */
109	void removeProperty( [in] string Name )
110			raises( com::sun::star::beans::UnknownPropertyException,
111			        com::sun::star::beans::NotRemoveableException );
112};
113
114//=============================================================================
115
116}; }; }; };
117
118#endif
119