Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: uno ::

deprecated interface XAggregation
Usage Restrictions
deprecated
Deprecation Info
Aggregation will no longer be supported as a high-level concept of UNO. You may still have the option to implement an UNO object consisting of several single objects in your specific programming language, though this depends on your programming language.
Description
Objects which implement this interface can become aggregates of a delegator.

That means if an object "A" aggregates "B", "A" can provide all or some of the interfaces of "B". Whenever the method XInterface::queryInterface() is called on either of the objects, the call will be forwarded to object "A". Object "A" now can determine whether to use the interfaces of "A" or "B" or neither. Actually, any number of aggregates can be used, even nested ones (aggregated objects which are delegators by themselves).

The following rules are to be observed:

  1. All calls to XInterface::acquire() which are made before the delegator was set (using the method setDelegator()) must not be taken back (using the method XInterface::release()) before the delegation is removed by calling xAggregation->setDelegator(NULL).
  2. The constructor of a delegator has to increment its own reference count by calling its method XInterface::acquire() before it sets itself to any aggregate using the method setDelegator(). After that call it has to reset its own reference count without the destructor getting called.
  3. The destructor of a delegator has to reset the delegator in its aggregated objects by calling their method setDelegator() with NULL before it releases its reference to its aggregated objects.
Developers Guide
WritingUNO - Core Interfaces to Implement
WritingUNO - XAggregation

Methods' Summary
setDelegator sets the object to which all calls to the method XInterface::queryInterface() have to be forwarded. @  
queryAggregation is similar to XInterface::queryInterface(), but it is to be processed directly without being forwarded to the delegator. @  
Methods' Details
setDelegator
void
setDelegator( [in] XInterface  pDelegator );

Description
sets the object to which all calls to the method XInterface::queryInterface() have to be forwarded. @
Parameter xDelegator
specifies the object which handles the calls to XInterface::queryInterface(). If xDelegator is NULL, the delegator is removed and thus the object becomes its own delegator and has to handle calls to the method XInterface::queryInterface() itself.
See also
XAggregation::queryAggregation
queryAggregation
any
queryAggregation( [in] type  aType );

Description
is similar to XInterface::queryInterface(), but it is to be processed directly without being forwarded to the delegator. @

This method is only called from within an implementation of XInterface::queryInterface() or XAggregation::queryAggregation(). This method is to be called by the delegator if it does not implement the interface itself. An object which got aggregated cannot depend on getting its own interface when it calls the method XInterface::queryInterface().

See also
XAggregation::setDelegator
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.