GCF LOGO VCL LOGO
GCF::MapToObjectEventBroadcaster Class Reference

MapToObjectEventBroadcaster broadcasts inserted, removed and deleted events of MapToObject. More...

#include <GCF3/MapToObject>

Public Member Functions

void addListener (MapToObjectEventListener *listener)
 
void removeListener (MapToObjectEventListener *listener)
 
void removeAllListeners ()
 
MapToObjectEventListenerlistenerAt (int index) const
 
QString listenerType () const
 
void objectInserted (QObject *obj)
 
void objectRemoved (QObject *obj)
 
void objectDeleted (QObject *obj)
 
- Public Member Functions inherited from GCF::MapToObjectEventListener
 MapToObjectEventListener ()
 
virtual ~MapToObjectEventListener ()
 

Detailed Description

MapToObjectEventBroadcaster broadcasts inserted, removed and deleted events of MapToObject to all the GCF::MapToObjectEventListener's added to it. You can add or remove a GCF::MapToObjectEventListener to this using addListener(MapToObjectEventListener *listener)/ removeListener(MapToObjectEventListener *listener) functions.

This class inherits from GCF::MapToObjectEventListener. To send notifications to GCF::MapToObjectEventListeners added to this; you first need to set event broadcast listener as GCF::MapToObjectEventListener of the GCF::MapToObject.

Member Function Documentation

GCF::MapToObjectEventBroadcaster::addListener ( MapToObjectEventListener listener)

Adds the GCF::MapToObjectEventListener to the broadcast list. After listener gets added, it will also get notifications for events on currently listening GCF::MapToObject.

Parameters
listenerGCF::MapToObjectEventListener that needs to be added to the broadcast list.
GCF::MapToObjectEventBroadcaster::removeListener ( MapToObjectEventListener listener)

Removes the GCF::MapToObjectEventListener from the broadcast list.

Parameters
listenerGCF::MapToObjectEventListener that needs to be removed from the broadcast list.
GCF::MapToObjectEventBroadcaster::removeAllListeners ( )

Removes all MapToObjectEventListeners from the broadcast list.

GCF::MapToObjectEventBroadcaster::listenerAt ( int  index) const

Returns the GCF::MapToObjectEventListener at the specified index.

Parameters
indexindex of which GCF::MapToObjectEventListener needs to be returned.
Returns
MapToObjectEventListener at the specified index.
GCF::MapToObjectEventBroadcaster::listenerType ( ) const
virtual

Returns the listener type of this class. Default listener type is "GCF::MapToObjectEventBroadcaster".

Returns
listener type string.

Reimplemented from GCF::MapToObjectEventListener.

void GCF::MapToObjectEventBroadcaster::objectInserted ( QObject *  obj)
virtual

By default there is no implementation. This function will be called when a Value- QObject pointer pair is inserted into the listening GCF::MapToObject.

Parameters
objQObject pointer which was inserted into the listening ref GCF::MapToObject.

Reimplemented from GCF::MapToObjectEventListener.

void GCF::MapToObjectEventBroadcaster::objectRemoved ( QObject *  obj)
virtual

By default there is no implementation. This function will be called when a Value- QObject pointer pair is removed from the listening GCF::MapToObject.

Parameters
objQObject pointer which was removed from the listening GCF::MapToObject.

Reimplemented from GCF::MapToObjectEventListener.

void GCF::MapToObjectEventBroadcaster::objectDeleted ( QObject *  obj)
virtual

By default there is no implementation. This function will be called when an QObject is in the listening GCF::MapToObject.

Parameters
objQObject pointer which was deleted.

Reimplemented from GCF::MapToObjectEventListener.