/usr/include/libreoffice/cppuhelper/propshlp.hxx is in libreoffice-dev 1:3.5.2-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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 _CPPUHELPER_PROPSHLP_HXX
#define _CPPUHELPER_PROPSHLP_HXX
#include <rtl/alloc.h>
#include <cppuhelper/interfacecontainer.hxx>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertySetOption.hpp>
#include <com/sun/star/beans/XMultiPropertySet.hpp>
#include <com/sun/star/beans/XFastPropertySet.hpp>
#include <memory>
namespace cppu
{
/*************************************************************************
*************************************************************************/
/**
This interface is used by the OPropertyHelper, to access the property description.
*/
class IPropertyArrayHelper
{
public:
// these are here to force memory de/allocation to sal lib.
inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW( () )
{}
/**
Following the rule, the first virtual method implies a virtual destructor.
*/
virtual ~IPropertyArrayHelper();
/**
Return the property members Name and Attribute from the handle nHandle.
@param nHandle the handle of a property. If the values of the handles
are sorted in the same way as the names and the highest handle value
is getCount() -1, than it must be an indexed acces to the property array.
@param pPropName is an out parameter filled with property name of the property with the
handle nHandle. May be NULL.
@param rAttributes is an out parameter filled with attributes of the property with the
handle nHandle. May be NULL.
@return True, if the handle exist, otherwise false.
*/
virtual sal_Bool SAL_CALL fillPropertyMembersByHandle(
::rtl::OUString * pPropName, sal_Int16 * pAttributes, sal_Int32 nHandle ) = 0;
/**
Return the sequence of properties. The sequence is sorted by name.
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL getProperties(void) = 0;
/**
Return the property with the name rPropertyName.
@param rPropertyName the name of the property.
@exception UnknownPropertyException thrown if the property name is unknown.
*/
virtual ::com::sun::star::beans::Property SAL_CALL getPropertyByName(
const ::rtl::OUString& rPropertyName )
throw (::com::sun::star::beans::UnknownPropertyException) = 0;
/**
Return true if the property with the name rPropertyName exist, otherwise false.
@param rPropertyName the name of the property.
*/
virtual sal_Bool SAL_CALL hasPropertyByName(const ::rtl::OUString& rPropertyName) = 0;
/**
Return the handle of the property with the name rPropertyName.
If the property does not exist -1 is returned.
@param rPropertyName the name of the property.
*/
virtual sal_Int32 SAL_CALL getHandleByName( const ::rtl::OUString & rPropertyName ) = 0;
/**
Fill the array with the handles of the properties.
@return the handles of the names from the pHandles array. -1
indicates an unknown property name.
*/
virtual sal_Int32 SAL_CALL fillHandles(
/*out*/ sal_Int32 * pHandles, const ::com::sun::star::uno::Sequence< ::rtl::OUString > & rPropNames ) = 0;
};
/**
You can use this helper class to map a XPropertySet-Interface to a XFast-
or a XMultiPropertySet interface.
*/
class OPropertyArrayHelper : public IPropertyArrayHelper
{
public:
/**
Create an object which supports the common property interfaces.
@param pProps array of properties
The array pProps should be sorted.
@param nElements is the number of properties in the pProps structure.
@param bSorted indicates that the elements are sorted.
*********/
OPropertyArrayHelper(
::com::sun::star::beans::Property *pProps,
sal_Int32 nElements ,
sal_Bool bSorted = sal_True )
SAL_THROW( () );
/**
Create an object which supports the common property interfaces.
@param aProps sequence of properties which are supported by this helper.
The sequence aProps should be sorted.
@param bSorted indicates that the elements are sorted.
*/
OPropertyArrayHelper(
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > & aProps,
sal_Bool bSorted = sal_True )
SAL_THROW( () );
/**
Return the number of properties.
*/
sal_Int32 SAL_CALL getCount() const SAL_THROW( () );
/**
Return the property members Name and Attribute from the handle nHandle.
@param nHandle the handle of a property. If the values of the handles
are sorted in the same way as the names and the highest handle value
is getCount() -1, than it is only an indexed acces to the property array.
Otherwise it is a linear search through the array.
@param pPropName is an out parameter filled with property name of the property with the
handle nHandle. May be NULL.
@param rAttributes is an out parameter filled with attributes of the property with the
handle nHandle. May be NULL.
@return True, if the handle exist, otherwise false.
*/
virtual sal_Bool SAL_CALL fillPropertyMembersByHandle(
::rtl::OUString * pPropName, sal_Int16 * pAttributes, sal_Int32 nHandle );
/**
Return the sequence of properties. The sequence is sorted by name.
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL getProperties(void);
/**
Return the property with the name rPropertyName.
@param rPropertyName the name of the property.
@exception UnknownPropertyException thrown if the property name is unknown.
*/
virtual ::com::sun::star::beans::Property SAL_CALL getPropertyByName(
const ::rtl::OUString& rPropertyName )
throw (::com::sun::star::beans::UnknownPropertyException);
/**
Return true if the property with the name rPropertyName exist, otherwise false.
@param rPropertyName the name of the property.
*/
virtual sal_Bool SAL_CALL hasPropertyByName(const ::rtl::OUString& rPropertyName);
/**
Return the handle of the property with the name rPropertyName.
If the property does not exist -1 is returned.
@param rPropertyName the name of the property.
*/
virtual sal_Int32 SAL_CALL getHandleByName( const ::rtl::OUString & rPropertyName );
/**
Fill the array with the handles of the properties.
@return the handles of the names from the pHandles array. -1
indicates an unknown property name.
*/
virtual sal_Int32 SAL_CALL fillHandles(
/*out*/sal_Int32 * pHandles, const ::com::sun::star::uno::Sequence< ::rtl::OUString > & rPropNames );
protected:
/** reserved for future use. do not use.
*/
void * m_pReserved;
private:
void init( sal_Bool bSorted ) SAL_THROW( () );
/** The sequence generated from the pProperties array. */
::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > aInfos;
/**
True, If the values of the handles are sorted in the same way as the names
and the highest handle value is getCount() -1, otherwise false.
*/
sal_Bool bRightOrdered;
};
//-----------------------------------------------------------------------------
// helper defines needed for an interface container with a 32 bit key values
struct equalInt32_Impl
{
bool operator()(const sal_Int32 & i1 , const sal_Int32 & i2) const SAL_THROW( () )
{ return i1 == i2; }
};
struct hashInt32_Impl
{
size_t operator()(const sal_Int32 & i) const SAL_THROW( () )
{ return i; }
};
/** Specialized class for key type sal_Int32,
without explicit usage of STL symbols.
*/
class OMultiTypeInterfaceContainerHelperInt32
{
public:
// these are here to force memory de/allocation to sal lib.
inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW( () )
{}
/**
Create a container of interface containers.
@param rMutex the mutex to protect multi thread access.
The lifetime must be longer than the lifetime
of this object.
*/
OMultiTypeInterfaceContainerHelperInt32( ::osl::Mutex & ) SAL_THROW( () );
/**
Delete all containers.
*/
~OMultiTypeInterfaceContainerHelperInt32() SAL_THROW( () );
/**
Return all id's under which at least one interface is added.
*/
::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL getContainedTypes() const SAL_THROW( () );
/**
Return the container created under this key.
@return the container created under this key. If the container
was not created, null was returned.
*/
OInterfaceContainerHelper * SAL_CALL getContainer( const sal_Int32 & rKey ) const SAL_THROW( () );
/**
Insert an element in the container specified with the key. The position is not specified.
@param rKey the id of the container.
@param rxIFace the added interface. It is allowed to insert null or
the same pointer more than once.
@return the new count of elements in the container.
*/
sal_Int32 SAL_CALL addInterface(
const sal_Int32 & rKey,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & r )
SAL_THROW( () );
/**
Remove an element from the container specified with the key.
It uses the equal definition of uno objects to remove the interfaces.
@param rKey the id of the container.
@param rxIFace the removed interface.
@return the new count of elements in the container.
*/
sal_Int32 SAL_CALL removeInterface(
const sal_Int32 & rKey,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & rxIFace )
SAL_THROW( () );
/**
Call disposing on all objects in the container that
support XEventListener. Then clear the container.
*/
void SAL_CALL disposeAndClear( const ::com::sun::star::lang::EventObject & rEvt ) SAL_THROW( () );
/**
Remove all elements of all containers. Does not delete the container.
*/
void SAL_CALL clear() SAL_THROW( () );
typedef sal_Int32 keyType;
private:
void *m_pMap;
::osl::Mutex & rMutex;
inline OMultiTypeInterfaceContainerHelperInt32( const OMultiTypeInterfaceContainerHelperInt32 & ) SAL_THROW( () );
inline OMultiTypeInterfaceContainerHelperInt32 & operator = ( const OMultiTypeInterfaceContainerHelperInt32 & ) SAL_THROW( () );
};
/** An interface to extend event notification actions.
*/
class IEventNotificationHook
{
public:
/**
Method to be called by OPropertySetHelper::fire.
@param bIgnoreRuntimeExceptionsWhileFiring
indicates whether occuring RuntimeExceptions shall be
ignored when firing notifications
@see OPropertySetHelper::fire
*/
virtual void fireEvents(
sal_Int32 * pnHandles,
sal_Int32 nCount,
sal_Bool bVetoable,
bool bIgnoreRuntimeExceptionsWhileFiring) = 0;
};
/**
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.
*/
class OPropertySetHelper : public ::com::sun::star::beans::XMultiPropertySet,
public ::com::sun::star::beans::XFastPropertySet,
public ::com::sun::star::beans::XPropertySet
{
public:
/**
@param rBHelper this structure contains the basic members of
a broadcaster.
The lifetime must be longer than the lifetime
of this object. Stored in the variable rBHelper.
*/
OPropertySetHelper( OBroadcastHelper & rBHelper ) SAL_THROW( () );
/** Constructor.
@param rBHelper
this structure contains the basic members of
a broadcaster.
The lifetime must be longer than the lifetime
of this object. Stored in the variable rBHelper.
@param bIgnoreRuntimeExceptionsWhileFiring
indicates whether occurring RuntimeExceptions will be
ignored when firing notifications
(vetoableChange(), propertyChange())
to listeners.
PropertyVetoExceptions may still be thrown.
This flag is useful in an inter-process scenario when
remote bridges may break down
(firing DisposedExceptions).
*/
OPropertySetHelper(
OBroadcastHelper & rBHelper, bool bIgnoreRuntimeExceptionsWhileFiring );
/** Constructor.
@param rBHelper
this structure contains the basic members of
a broadcaster.
The lifetime must be longer than the lifetime
of this object. Stored in the variable rBHelper.
@param i_pFireEvents
additional event notifier
@param bIgnoreRuntimeExceptionsWhileFiring
indicates whether occurring RuntimeExceptions will be
ignored when firing notifications
(vetoableChange(), propertyChange())
to listeners.
PropertyVetoExceptions may still be thrown.
This flag is useful in an inter-process scenario when
remote bridges may break down
(firing DisposedExceptions).
*/
OPropertySetHelper(
OBroadcastHelper & rBHelper,
IEventNotificationHook *i_pFireEvents,
bool bIgnoreRuntimeExceptionsWhileFiring = false);
/**
Only returns a reference to XMultiPropertySet, XFastPropertySet, XPropertySet and
XEventListener.
*/
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType )
throw (::com::sun::star::uno::RuntimeException);
/** eases implementing XTypeProvider::getTypes, returns the types of XMultiPropertySet, XFastPropertySet, XPropertySet
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > getTypes()
throw(::com::sun::star::uno::RuntimeException);
/**
Send a disposing notification to the listeners in the conatiners aBoundLC
and aVetoableLC.
@see OComponentHelper
*/
void SAL_CALL disposing() SAL_THROW( () );
/**
Throw UnknownPropertyException or PropertyVetoException if the property with the name
rPropertyName does not exist or is readonly. Otherwise rPropertyName is changed to its handle
value and setFastPropertyValue is called.
*/
virtual void SAL_CALL setPropertyValue( 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);
/**
Throw UnknownPropertyException if the property with the name
rPropertyName does not exist.
*/
virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue(const ::rtl::OUString& aPropertyName)
throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
/** Ignored if the property is not bound. */
virtual void SAL_CALL addPropertyChangeListener(
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);
/** Ignored if the property is not bound. */
virtual void SAL_CALL removePropertyChangeListener(
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);
/** Ignored if the property is not constrained. */
virtual void SAL_CALL addVetoableChangeListener(
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);
/** Ignored if the property is not constrained. */
virtual void SAL_CALL removeVetoableChangeListener(
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);
/**
Throw UnknownPropertyException or PropertyVetoException if the property with the name
rPropertyName does not exist or is readonly. Otherwise the method convertFastPropertyValue
is called, then the vetoable listeners are notified. After this the value of the property
is changed with the setFastPropertyValue_NoBroadcast method and the bound listeners are
notified.
*/
virtual void SAL_CALL setFastPropertyValue( 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);
/**
@exception com::sun::star::beans::UnknownPropertyException
if the property with the handle nHandle does not exist.
*/
virtual ::com::sun::star::uno::Any SAL_CALL getFastPropertyValue( sal_Int32 nHandle )
throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
// XMultiPropertySet
virtual void SAL_CALL setPropertyValues(
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);
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > SAL_CALL getPropertyValues(
const ::com::sun::star::uno::Sequence< ::rtl::OUString >& PropertyNames )
throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addPropertiesChangeListener(
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);
virtual void SAL_CALL removePropertiesChangeListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener >& Listener )
throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL firePropertiesChangeEvent(
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);
/**
The property sequence is created in the call. The interface isn't used after the call.
*/
static ::com::sun::star::uno::Reference < ::com::sun::star::beans::XPropertySetInfo > SAL_CALL
createPropertySetInfo( IPropertyArrayHelper & rProperties ) SAL_THROW( () );
protected:
/**
This method fire events to all registered property listeners.
@param pnHandles the id's of the properties that changed.
@param pNewValues the new values of the properties.
@param pOldValues the old values of the properties.
@param nCount the number of elements in the arrays pnHandles, pNewValues and pOldValues.
@param bVetoable true means fire to VetoableChangeListener, false means fire to
XPropertyChangedListener and XMultiPropertyChangedListener.
*/
void SAL_CALL fire(
sal_Int32 * pnHandles,
const ::com::sun::star::uno::Any * pNewValues,
const ::com::sun::star::uno::Any * pOldValues,
sal_Int32 nCount,
sal_Bool bVetoable );
/**
Set multiple properties with the handles.
@param nSeqLen the length of the arrays pHandles and Values.
@param pHandles the handles of the properties. The number of elements
in the Values sequence is the length of the handle array. A value of -1
of a handle means invalid property. These are ignored.
@param pValues the values of the properties.
@param nHitCount the number of valid entries in the handle array.
*/
void SAL_CALL setFastPropertyValues(
sal_Int32 nSeqLen,
sal_Int32 * pHandles,
const ::com::sun::star::uno::Any * pValues,
sal_Int32 nHitCount )
SAL_THROW( (::com::sun::star::uno::Exception) );
/**
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.
*/
virtual IPropertyArrayHelper & SAL_CALL getInfoHelper() = 0;
/**
Converted the value rValue and return the result in rConvertedValue and the
old value in rOldValue. A IllegalArgumentException is thrown.
The method is not implemented in this class. After this call the vetoable
listeners are notified.
@param rConvertedValue the converted value. Only set if return is true.
@param rOldValue the old value. Only set if return is true.
@param nHandle the handle of the proberty.
@return true if the value converted.
*/
virtual sal_Bool SAL_CALL convertFastPropertyValue(
::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;
/** The same as setFastProperyValue; nHandle is always valid.
The changes must not be broadcasted in this method.
The method is implemented in a derived class.
@attention
Although you are permitted to throw any UNO exception, only the following
are valid for usage:
-- ::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
@param nHandle
handle
@param rValue
value
*/
virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
sal_Int32 nHandle,
const ::com::sun::star::uno::Any& rValue )
throw (::com::sun::star::uno::Exception) = 0;
/**
The same as getFastProperyValue, but return the value through rValue and nHandle
is always valid.
The method is not implemented in this class.
*/
virtual void SAL_CALL getFastPropertyValue(
::com::sun::star::uno::Any& rValue,
sal_Int32 nHandle ) const = 0;
/** sets an dependent property's value
<p>Sometimes setting a given property needs to implicitly modify another property's value. Calling |setPropertyValue|
from within |setFastPropertyValue_NoBroadcast| is not an option here, as it would notify the property listeners
while our mutex is still locked. Setting the dependent property's value directly (e.g. by calling |setFastPropertyValue_NoBroadcast|
recursively) is not an option, too, since it would miss firing the property change event.</p>
<p>So, in such cases, you use |setDependentFastPropertyValue| from within |setFastPropertyValue_NoBroadcast|.
It will convert and actually set the property value (invoking |convertFastPropertyValue| and |setFastPropertyValue_NoBroadcast|
for the given handle and value), and add the property change event to the list of events to be notified
when the bottom-most |setFastPropertyValue_NoBroadcast| on the stack returns.</p>
<p><strong>Note</strong>: The method will <em>not</em> invoke veto listeners for the property.</p>
<p><strong>Note</strong>: It's the caller's responsibility to ensure that our mutex is locked. This is
canonically given when the method is invoked from within |setFastPropertyValue_NoBroadcast|, in other
contexts, you might need to take own measures.</p>
*/
void setDependentFastPropertyValue(
sal_Int32 i_handle,
const ::com::sun::star::uno::Any& i_value
);
/** The common data of a broadcaster. Use the mutex, disposing state and the listener container. */
OBroadcastHelper &rBHelper;
/**
Container for the XProperyChangedListener. The listeners are inserted by handle.
*/
OMultiTypeInterfaceContainerHelperInt32 aBoundLC;
/**
Container for the XPropertyVetoableListener. The listeners are inserted by handle.
*/
OMultiTypeInterfaceContainerHelperInt32 aVetoableLC;
class Impl;
/** reserved for future use. finally, the future has arrived...
*/
const std::auto_ptr<Impl> m_pReserved;
private:
OPropertySetHelper( const OPropertySetHelper & ) SAL_THROW( () );
OPropertySetHelper & operator = ( const OPropertySetHelper & ) SAL_THROW( () );
/** notifies the given changes in property's values, <em>plus</em> all property changes collected during recent
|setDependentFastPropertyValue| calls.
*/
void impl_fireAll(
sal_Int32* i_handles,
const ::com::sun::star::uno::Any * i_newValues,
const ::com::sun::star::uno::Any * i_oldValues,
sal_Int32 i_count
);
public:
// Suppress warning about virtual functions but non-virtual destructor:
#if defined __GNUC__
#pragma GCC system_header
#elif defined _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4265)
#endif
/**
You must call disposing before destruction.
*/
~OPropertySetHelper() SAL_THROW( () );
};
#if defined _MSC_VER
#pragma warning(pop)
#endif
/**
OPropertySetHelper plus XPropertySetOption
*/
class OPropertySetHelper2 : public OPropertySetHelper,
public ::com::sun::star::beans::XPropertySetOption
{
public:
/** Constructor.
See OPropertySetHelper constructors documentation
*/
explicit OPropertySetHelper2(
OBroadcastHelper & rBHelper,
IEventNotificationHook *i_pFireEvents = NULL,
bool bIgnoreRuntimeExceptionsWhileFiring = false);
// XInterface
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType )
throw (::com::sun::star::uno::RuntimeException);
// XPropertySetOption
virtual void SAL_CALL enableChangeListenerNotification( sal_Bool bEnable )
throw(::com::sun::star::uno::RuntimeException);
private:
OPropertySetHelper2( const OPropertySetHelper2 & ) SAL_THROW( () );
OPropertySetHelper2 & operator = ( const OPropertySetHelper2 & ) SAL_THROW( () );
public:
// Suppress warning about virtual functions but non-virtual destructor:
/**
You must call disposing before destruction.
*/
virtual ~OPropertySetHelper2() SAL_THROW( () );
};
} // end namespace cppuhelper
#endif //
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|