<html> <head> <title>class OPropertySetHelper</title> <link rel="stylesheet" type="text/css" href="../../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../../index.html">Overview</a> </td> <td class="navimain"> <a href="index.html">Namespace</a> </td> <td class="navimainself"> Class </td> <td class="navimain"> <a href="../../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"> <tr> <td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a> | <a href="#publ_static_ops"><font size="-2"><b>STATIC METHODS</b></font></a> | <font size="-2">DATA</font> | <font size="-2">STATIC DATA</font></td> </tr> <tr> <td width="20%"><font size="-2">PROTECTED MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <a href="#prot_ops"><font size="-2"><b>METHODS</b></font></a> | <font size="-2">STATIC METHODS</font> | <a href="#prot_vars"><font size="-2"><b>DATA</b></font></a> | <font size="-2">STATIC DATA</font></td> </tr> <tr> <td width="20%"><font size="-2">PRIVATE MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <a href="#priv_ops"><font size="-2"><b>METHODS</b></font></a> | <font size="-2">STATIC METHODS</font> | <font size="-2">DATA</font> | <font size="-2">STATIC DATA</font></td> </tr> </table> <hr> <a href="../../names/index.html" alt="Global Namespace in C++"><font size="+1"><b>::</b></font></a> <a href="index.html" alt="namespace"><font size="+1"><b>cppu</b></font></a><font size="+1"> :: </font><div class="title"><h2>class OPropertySetHelper</h2> </div><hr> <dl> <dt>Base Classes</dt> <dd><pre style="font-family:monospace;"> <span class="btpubl">com::sun::star::beans::<a href="../../../../common/ref/com/sun/star/beans/XMultiPropertySet.html">XMultiPropertySet</a> (public)</span> | | <span class="btpubl">com::sun::star::beans::<a href="../../../../common/ref/com/sun/star/beans/XFastPropertySet.html">XFastPropertySet</a> (public)</span> | | | | <span class="btpubl">com::sun::star::beans::<a href="../../../../common/ref/com/sun/star/beans/XPropertySet.html">XPropertySet</a> (public)</span> | | | +----+----+--<span class="btself">OPropertySetHelper</span> </pre></dd> </dl> <dl> <dt>Known Derived Classes</dt> <dd>None.</dd> </dl> <br> <table class="flag-table" border="1" cellspacing="0"> <tr> <td width="25%" class="flagname">virtual</td> <td width="25%" class="flagname">abstract</td> <td width="25%" class="flagname">interface</td> <td width="25%" class="flagname">template</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagyes">YES</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <dl> <dt>Description</dt> <dd><pre>This abstract class maps the methods of the interfaces XMultiPropertySet, XFastPropertySet and XPropertySet to the methods getInfoHelper, convertFastPropertyValue, setFastPropertyValue_NoBroadcast and getFastPropertyValue. You must derive from this class and overload the methods. It provides a standard implementation of the XPropertySetInfo. The XPropertiesChangeListener are inserted in the rBHelper.aLC structure. The XPropertyChangeListener and XVetoableChangeListener with no names are inserted in the rBHelper.aLC structure. So it is possible to advise property listeners with the connection point interfaces. But only listeners that listen to all property changes. </pre></dd> </dl> <dl> <dt>File</dt> <dd>propshlp.hxx</dd> </dl> <hr> <dl> <dt class="subtitle"><a name="publ_"><h3>Public Members</h3> </a></dt> <dd><a name="publ_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Methods</h4> </td> </tr> <tr> <td> <br> <a href="OPropertySetHelper/o.html#OPropertySetHelper-3328">OPropertySetHelper</a>( OBroadcastHelper & rBHelper ) throw( );</td> <td width="50%"> </td> </tr> <tr> <td> <br> <a href="OPropertySetHelper/o.html#OPropertySetHelper-3329">OPropertySetHelper</a>( OBroadcastHelper & rBHelper, bool bIgnoreRuntimeExceptionsWhileFiring );</td> <td width="50%"> Constructor. </td> </tr> <tr> <td> <br> <a href="OPropertySetHelper/o.html#OPropertySetHelper-3330">OPropertySetHelper</a>( OBroadcastHelper & rBHelper, IEventNotificationHook * i_pFireEvents, bool bIgnoreRuntimeExceptionsWhileFiring = false );</td> <td width="50%"> Constructor. </td> </tr> <tr> <td>::com::sun::star::uno::Any <br> <a href="OPropertySetHelper/o.html#queryInterface-3331">queryInterface</a>( const ::com::sun::star::uno::Type & rType ) throw( ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> Only returns a reference to XMultiPropertySet, XFastPropertySet, XPropertySet and XEventListener. </td> </tr> <tr> <td>::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > <br> <a href="OPropertySetHelper/o.html#getTypes-3332">getTypes</a>( ) throw( ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> eases implementing XTypeProvider::getTypes, returns the types of XMultiPropertySet, XFastPropertySet, XPropertySet </td> </tr> <tr> <td>void <br> <a href="OPropertySetHelper/o.html#disposing-3333">disposing</a>( ) throw( );</td> <td width="50%"> Send a disposing notification to the listeners in the conatiners aBoundLC and aVetoableLC. </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#setPropertyValue-3334">setPropertyValue</a>( const ::rtl::OUString & rPropertyName, const ::com::sun::star::uno::Any & aValue ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual ::com::sun::star::uno::Any <br> <a href="OPropertySetHelper/o.html#getPropertyValue-3335">getPropertyValue</a>( const ::rtl::OUString & aPropertyName ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> Throw UnknownPropertyException if the property with the name rPropertyName does not exist. </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#addPropertyChangeListener-3336">addPropertyChangeListener</a>( const ::rtl::OUString & aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener > & aListener ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> Ignored if the property is not bound. </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#removePropertyChangeListener-3337">removePropertyChangeListener</a>( const ::rtl::OUString & aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener > & aListener ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> Ignored if the property is not bound. </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#addVetoableChangeListener-3338">addVetoableChangeListener</a>( const ::rtl::OUString & aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener > & aListener ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> Ignored if the property is not constrained. </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#removeVetoableChangeListener-3339">removeVetoableChangeListener</a>( const ::rtl::OUString & aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener > & aListener ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> Ignored if the property is not constrained. </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#setFastPropertyValue-3340">setFastPropertyValue</a>( sal_Int32 nHandle, const ::com::sun::star::uno::Any & rValue ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual ::com::sun::star::uno::Any <br> <a href="OPropertySetHelper/o.html#getFastPropertyValue-3341">getFastPropertyValue</a>( sal_Int32 nHandle ) throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#setPropertyValues-3342">setPropertyValues</a>( const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > & Values ) throw( ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > <br> <a href="OPropertySetHelper/o.html#getPropertyValues-3343">getPropertyValues</a>( const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames ) throw( ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#addPropertiesChangeListener-3344">addPropertiesChangeListener</a>( const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener > & Listener ) throw( ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#removePropertiesChangeListener-3345">removePropertiesChangeListener</a>( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener > & Listener ) throw( ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#firePropertiesChangeEvent-3346">firePropertiesChangeEvent</a>( const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener > & Listener ) throw( ::com::sun::star::uno::RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td> <br> <a href="OPropertySetHelper/o.html#~OPropertySetHelper-3360">~OPropertySetHelper</a>( ) throw( );</td> <td width="50%"> You must call disposing before destruction. </td> </tr> </table> <hr> <a name="publ_static_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Static Methods</h4> </td> </tr> <tr> <td>static ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > <br> <a href="OPropertySetHelper/o.html#createPropertySetInfo-3347">createPropertySetInfo</a>( IPropertyArrayHelper & rProperties ) throw( );</td> <td width="50%"> The property sequence is created in the call. The interface isn't used after the call. </td> </tr> </table> <hr> </dd> </dl> <dl> <dt class="subtitle"><a name="prot_"><h3>Protected Members</h3> </a></dt> <dd><a name="prot_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Methods</h4> </td> </tr> <tr> <td>void <br> <a href="OPropertySetHelper/o.html#fire-3348">fire</a>( sal_Int32 * pnHandles, const ::com::sun::star::uno::Any * pNewValues, const ::com::sun::star::uno::Any * pOldValues, sal_Int32 nCount, sal_Bool bVetoable );</td> <td width="50%"> This method fire events to all registered property listeners. </td> </tr> <tr> <td>void <br> <a href="OPropertySetHelper/o.html#setFastPropertyValues-3349">setFastPropertyValues</a>( sal_Int32 nSeqLen, sal_Int32 * pHandles, const ::com::sun::star::uno::Any * pValues, sal_Int32 nHitCount ) throw( ::com::sun::star::uno::Exception );</td> <td width="50%"> Set multiple properties with the handles. </td> </tr> <tr> <td>virtual IPropertyArrayHelper & <br> <a href="OPropertySetHelper/o.html#getInfoHelper-3350">getInfoHelper</a>( ) = 0;</td> <td width="50%"> This abstract method must return the name to index table. This table contains all property names and types of this object. The method is not implemented in this class. </td> </tr> <tr> <td>virtual sal_Bool <br> <a href="OPropertySetHelper/o.html#convertFastPropertyValue-3351">convertFastPropertyValue</a>( ::com::sun::star::uno::Any & rConvertedValue, ::com::sun::star::uno::Any & rOldValue, sal_Int32 nHandle, const ::com::sun::star::uno::Any & rValue ) throw( ::com::sun::star::lang::IllegalArgumentException ) = 0;</td> <td width="50%"> </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#setFastPropertyValue_NoBroadcast-3352">setFastPropertyValue_NoBroadcast</a>( sal_Int32 nHandle, const ::com::sun::star::uno::Any & rValue ) throw( ::com::sun::star::uno::Exception ) = 0;</td> <td width="50%"> </td> </tr> <tr> <td>virtual void <br> <a href="OPropertySetHelper/o.html#getFastPropertyValue-3353">getFastPropertyValue</a>( ::com::sun::star::uno::Any & rValue, sal_Int32 nHandle ) const = 0;</td> <td width="50%"> </td> </tr> </table> <hr> <a name="prot_vars"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Data</h4> </td> </tr> <tr bgcolor="white"> <td><a href="t-OBroadcastHelper.html">OBroadcastHelper</a> & <a href="OPropertySetHelper/d.html#rBHelper"><strong>rBHelper;</strong></a></td> <td>The common data of a broadcaster. Use the mutex, disposing state and the listener container. </td> </tr> <tr bgcolor="white"> <td><a href="c-OMultiTypeInterfaceContainerHelperInt32.html">OMultiTypeInterfaceContainerHelperInt32</a> <a href="OPropertySetHelper/d.html#aBoundLC"><strong>aBoundLC;</strong></a></td> <td>Container for the XProperyChangedListener. The listeners are inserted by handle. </td> </tr> <tr bgcolor="white"> <td><a href="c-OMultiTypeInterfaceContainerHelperInt32.html">OMultiTypeInterfaceContainerHelperInt32</a> <a href="OPropertySetHelper/d.html#aVetoableLC"><strong>aVetoableLC;</strong></a></td> <td>Container for the XPropertyVetoableListener. The listeners are inserted by handle. </td> </tr> <tr bgcolor="white"> <td>const std::auto_ptr< const Impl > <a href="OPropertySetHelper/d.html#m_pReserved"><strong>m_pReserved;</strong></a></td> <td>reserved for future use. finally, the future has arrived... </td> </tr> </table> <hr> </dd> </dl> <dl> <dt class="subtitle"><a name="priv_"><h3>Private Members</h3> </a></dt> <dd><a name="priv_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Methods</h4> </td> </tr> <tr> <td> <br> <a href="OPropertySetHelper/o.html#OPropertySetHelper-3358">OPropertySetHelper</a>( const OPropertySetHelper & ) throw( );</td> <td width="50%"> </td> </tr> <tr> <td>OPropertySetHelper & <br> <a href="OPropertySetHelper/o.html#operator=-3359">operator=</a>( const OPropertySetHelper & ) throw( );</td> <td width="50%"> </td> </tr> </table> <hr> </dd> </dl> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-cppref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
9283
