LibreOffice LibreOffice 25.2 SDK API Reference

XPropertySet.idl
Go to the documentation of this file.
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
20
21
22module com { module sun { module star { module beans {
23
24
45published interface XPropertySet: com::sun::star::uno::XInterface
46{
47
58 com::sun::star::beans::XPropertySetInfo getPropertySetInfo();
59
60
73 void setPropertyValue( [in] string aPropertyName,
74 [in] any aValue )
75 raises( com::sun::star::beans::UnknownPropertyException,
76 com::sun::star::beans::PropertyVetoException,
77 com::sun::star::lang::IllegalArgumentException,
78 com::sun::star::lang::WrappedTargetException );
79
80
95 any getPropertyValue( [in] string PropertyName )
96 raises( com::sun::star::beans::UnknownPropertyException,
97 com::sun::star::lang::WrappedTargetException );
98
99
111 void addPropertyChangeListener( [in] string aPropertyName,
112 [in] com::sun::star::beans::XPropertyChangeListener xListener )
113 raises( com::sun::star::beans::UnknownPropertyException,
114 com::sun::star::lang::WrappedTargetException );
115
116
127 void removePropertyChangeListener( [in] string aPropertyName,
128 [in] com::sun::star::beans::XPropertyChangeListener aListener )
129 raises( com::sun::star::beans::UnknownPropertyException,
130 com::sun::star::lang::WrappedTargetException );
131
132
142 void addVetoableChangeListener( [in] string PropertyName,
143 [in] com::sun::star::beans::XVetoableChangeListener aListener )
144 raises( com::sun::star::beans::UnknownPropertyException,
145 com::sun::star::lang::WrappedTargetException );
146
147
155 void removeVetoableChangeListener( [in] string PropertyName,
156 [in] com::sun::star::beans::XVetoableChangeListener aListener )
157 raises( com::sun::star::beans::UnknownPropertyException,
158 com::sun::star::lang::WrappedTargetException );
159
160};
161
162
163}; }; }; };
164
165/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::PropertyVetoException
This exception is thrown when a proposed change to a property represents an unacceptable value.
Definition: PropertyVetoException.idl:31
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:34
com::sun::star::beans::XPropertyChangeListener
is used to receive PropertyChangeEvents whenever a bound property is changed.
Definition: XPropertyChangeListener.idl:29
com::sun::star::beans::XPropertySetInfo
specifies a set of properties.
Definition: XPropertySetInfo.idl:38
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::beans::XPropertySet::getPropertyValue
any getPropertyValue([in] string PropertyName)
com::sun::star::beans::XPropertySet::addVetoableChangeListener
void addVetoableChangeListener([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener)
adds an XVetoableChangeListener to the specified property with the name PropertyName.
com::sun::star::beans::XPropertySet::removePropertyChangeListener
void removePropertyChangeListener([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener)
removes an XPropertyChangeListener from the listener list.
com::sun::star::beans::XPropertySet::setPropertyValue
void setPropertyValue([in] string aPropertyName, [in] any aValue)
sets the value of the property with the specified name.
com::sun::star::beans::XPropertySet::removeVetoableChangeListener
void removeVetoableChangeListener([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener)
removes an XVetoableChangeListener from the listener list.
com::sun::star::beans::XPropertySet::getPropertySetInfo
com::sun::star::beans::XPropertySetInfo getPropertySetInfo()
com::sun::star::beans::XPropertySet::addPropertyChangeListener
void addPropertyChangeListener([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener)
adds an XPropertyChangeListener to the specified property.
com::sun::star::beans::XVetoableChangeListener
is used to receive PropertyChangeEvents whenever a "constrained" property is changed.
Definition: XVetoableChangeListener.idl:32
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20