LibreOffice Module cppuhelper (master)  1
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl > Class Template Reference

A helper class to store interface references of different types. More...

#include <interfacecontainer.h>

Inheritance diagram for cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >:
[legend]

Public Types

typedef key keyType
 

Public Member Functions

 OMultiTypeInterfaceContainerHelperVar (::osl::Mutex &rMutex)
 Create a container of interface containers. More...
 
 ~OMultiTypeInterfaceContainerHelperVar ()
 Deletes all containers. More...
 
css::uno::Sequence< key > SAL_CALL getContainedTypes () const
 Return all id's under which at least one interface is added. More...
 
OInterfaceContainerHelper *SAL_CALL getContainer (const key &) const
 Return the container created under this key. More...
 
sal_Int32 SAL_CALL addInterface (const key &rKey, const css::uno::Reference< css::uno::XInterface > &r)
 Inserts an element into the container with the specified key. More...
 
sal_Int32 SAL_CALL removeInterface (const key &rKey, const css::uno::Reference< css::uno::XInterface > &rxIFace)
 Removes an element from the container with the specified key. More...
 
void SAL_CALL disposeAndClear (const css::lang::EventObject &rEvt)
 Call disposing on all references in the container, that support XEventListener. More...
 
void SAL_CALL clear ()
 Remove all elements of all containers. More...
 

Static Public Member Functions

static void *SAL_CALL operator new (size_t nSize)
 
static void SAL_CALL operator delete (void *pMem)
 
static void *SAL_CALL operator new (size_t, void *pMem)
 
static void SAL_CALL operator delete (void *, void *)
 

Private Types

typedef ::std::vector< std::pair< key, void * > > InterfaceMap
 

Private Member Functions

InterfaceMap::iterator find (const key &rKey) const
 
 OMultiTypeInterfaceContainerHelperVar (const OMultiTypeInterfaceContainerHelperVar &) SAL_DELETED_FUNCTION
 
OMultiTypeInterfaceContainerHelperVaroperator= (const OMultiTypeInterfaceContainerHelperVar &) SAL_DELETED_FUNCTION
 

Private Attributes

InterfaceMapm_pMap
 
::osl::Mutex & rMutex
 

Detailed Description

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
class cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >

A helper class to store interface references of different types.

See also
OInterfaceIteratorHelper
OInterfaceContainerHelper

Definition at line 312 of file interfacecontainer.h.

Member Typedef Documentation

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
typedef ::std::vector< std::pair < key , void* > > cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::InterfaceMap
private

Definition at line 400 of file interfacecontainer.h.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
typedef key cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::keyType

Definition at line 398 of file interfacecontainer.h.

Constructor & Destructor Documentation

template<class key , class hashImpl , class equalImpl >
cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::OMultiTypeInterfaceContainerHelperVar ( ::osl::Mutex &  rMutex)
inline

Create a container of interface containers.

Parameters
rMutexthe mutex to protect multi thread access. The lifetime must be longer than the lifetime of this object.

Definition at line 33 of file interfacecontainer.hxx.

References cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::m_pMap.

template<class key , class hashImpl , class equalImpl >
cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::~OMultiTypeInterfaceContainerHelperVar ( )
inline

Deletes all containers.

Definition at line 41 of file interfacecontainer.hxx.

References end.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::OMultiTypeInterfaceContainerHelperVar ( const OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl > &  )
private

Member Function Documentation

template<class key, class hashImpl , class equalImpl >
sal_Int32 cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::addInterface ( const key &  rKey,
const css::uno::Reference< css::uno::XInterface > &  r 
)
inline

Inserts an element into the container with the specified key.

The position is not specified, thus it is not specified in which order events are fired.

Attention:

If you add the same interface more than once, then it will be added to the elements list more than once and thus if you want to remove that interface from the list, you have to call removeInterface() the same number of times. In the latter case, you will also get events fired more than once (if the interface is a listener interface).

Parameters
rKeythe id of the container
rinterface to be added; it is allowed, to insert null or the same interface more than once
Returns
the new count of elements in the container

Definition at line 102 of file interfacecontainer.hxx.

References cppu::OInterfaceContainerHelper::addInterface(), and find().

template<class key , class hashImpl , class equalImpl >
void cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::clear ( )
inline

Remove all elements of all containers.

Does not delete the container.

Definition at line 175 of file interfacecontainer.hxx.

References end.

template<class key , class hashImpl , class equalImpl >
void cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::disposeAndClear ( const css::lang::EventObject &  rEvt)
inline

Call disposing on all references in the container, that support XEventListener.

Then clears the container.

Parameters
rEvtthe event object which is passed during disposing() call

Definition at line 138 of file interfacecontainer.hxx.

References cppu::OInterfaceContainerHelper::disposeAndClear(), end, i, and NULL.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
InterfaceMap::iterator cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::find ( const key &  rKey) const
inlineprivate

Definition at line 404 of file interfacecontainer.h.

template<class key , class hashImpl , class equalImpl >
css::uno::Sequence< key > cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::getContainedTypes ( ) const
inline

Return all id's under which at least one interface is added.

Definition at line 57 of file interfacecontainer.hxx.

References end, and i.

template<class key, class hashImpl , class equalImpl >
OInterfaceContainerHelper * cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::getContainer ( const key &  rKey) const
inline

Return the container created under this key.

The InterfaceContainerHelper exists until the whole MultiTypeContainer is destroyed.

Returns
the container created under this key. If the container was not created, null was returned.

Definition at line 89 of file interfacecontainer.hxx.

References find(), and NULL.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
static void SAL_CALL cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::operator delete ( void pMem)
inlinestatic

Definition at line 318 of file interfacecontainer.h.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
static void SAL_CALL cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::operator delete ( void ,
void  
)
inlinestatic

Definition at line 322 of file interfacecontainer.h.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
static void* SAL_CALL cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::operator new ( size_t  nSize)
inlinestatic

Definition at line 316 of file interfacecontainer.h.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
static void* SAL_CALL cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::operator new ( size_t  ,
void pMem 
)
inlinestatic

Definition at line 320 of file interfacecontainer.h.

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
OMultiTypeInterfaceContainerHelperVar& cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::operator= ( const OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl > &  )
private
template<class key, class hashImpl , class equalImpl >
sal_Int32 cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::removeInterface ( const key &  rKey,
const css::uno::Reference< css::uno::XInterface > &  rxIFace 
)
inline

Removes an element from the container with the specified key.

It uses interface equality to remove the interface.

Parameters
rKeythe id of the container
rxIFaceinterface to be removed
Returns
the new count of elements in the container

Definition at line 120 of file interfacecontainer.hxx.

References find().

Member Data Documentation

template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
InterfaceMap* cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::m_pMap
private
template<class key, class hashImpl = void, class equalImpl = std::equal_to<key>>
::osl::Mutex& cppu::OMultiTypeInterfaceContainerHelperVar< key, hashImpl, equalImpl >::rMutex
private

Definition at line 402 of file interfacecontainer.h.


The documentation for this class was generated from the following files: