summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/XFastPropertySet.idl
diff options
context:
space:
mode:
Diffstat (limited to 'udkapi/com/sun/star/beans/XFastPropertySet.idl')
-rw-r--r--udkapi/com/sun/star/beans/XFastPropertySet.idl126
1 files changed, 126 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/beans/XFastPropertySet.idl b/udkapi/com/sun/star/beans/XFastPropertySet.idl
new file mode 100644
index 000000000000..89ffd4a4288d
--- /dev/null
+++ b/udkapi/com/sun/star/beans/XFastPropertySet.idl
@@ -0,0 +1,126 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_beans_XFastPropertySet_idl__
+#define __com_sun_star_beans_XFastPropertySet_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
+#include <com/sun/star/beans/UnknownPropertyException.idl>
+#endif
+
+#ifndef __com_sun_star_beans_PropertyVetoException_idl__
+#include <com/sun/star/beans/PropertyVetoException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_WrappedTargetException_idl__
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module beans {
+
+//=============================================================================
+
+/** provides a fast way of accessing and changing property values.
+
+ <p>This interface is an extension to the <type>XPropertySet</type>
+ interface. The get and set methods use handles to access the
+ property values instead of character strings.</p>
+ */
+published interface XFastPropertySet: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+
+ /** sets the value to the property with the specified name.
+
+ @param nHandle
+ contains the implementation handle of the
+ implementation for the property.
+
+ @param aValue
+ contains the new value of the property.
+
+ @throws UnknownPropertyException
+ if the property does not exist.
+
+ @throws PropertyVetoException
+ if a vetoable listener does not approve the change of
+ a property value.
+
+ @throws IllegalArgumentException
+ if the new value cannot be converted to the type of the
+ underlying property by an identity or widening conversion.
+
+ @throws stardiv::uno::lang::WrappedTargetException
+ if the implementation has an internal reason for the exception.
+ In this case the original exception is wrapped into this
+ <type scope="com::sun::star::lang">WrappedTargetException</type>.
+
+ */
+ void setFastPropertyValue( [in] long nHandle,
+ [in] any aValue )
+ raises( com::sun::star::beans::UnknownPropertyException,
+ com::sun::star::beans::PropertyVetoException,
+ com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+ /** @returns
+ the value of the property with the name PropertyName.
+
+ @param nHandle
+ contains the implementation handle of the implementation for the property.
+
+ @throws UnknownPropertyException
+ if the property does not exist.
+
+ @throws com::sun::star::lang::WrappedTargetException
+ if the implementation has an internal reason for the exception.
+ In this case the original exception is wrapped into that
+ <type scope="com::sun::star::lang">WrappedTargetException</type>.
+ */
+ any getFastPropertyValue( [in] long nHandle )
+ raises( com::sun::star::beans::UnknownPropertyException,
+ com::sun::star::lang::WrappedTargetException );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif