MeVisLab Toolbox Reference
ml::EventSource Class Reference

#include <mlEventSource.h>

Inheritance diagram for ml::EventSource:
ml::Base ml::RefCountedBase ml::AbstractItemModel ml::CSOList ml::CurveData ml::CurveList ml::DicomConfigurableMessageFilterBaseRefCounted ml::DicomTree ml::MultiFileVolumeListRefCounted ml::PCLBaseObject ml::SelectedClusters ml::VTKObjectWrapper ml::WEM

Public Member Functions

 EventSource ()
 EventSource (const EventSource &evSource)
 ~EventSource () override
void addEventListener (BaseEventCallback *cb, void *userData)
void removeEventListener (BaseEventCallback *cb, void *userData)
bool hasEventListeners () const
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
virtual Base * deepCopy () const
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool isRefCountedBase () const
 Returns whether the instance is derived from RefCountedBase.
virtual std::string detailString () const
virtual bool implementsPersistence (PersistenceInterface) const
virtual std::string persistentState () const
 Returns a string describing the object's internal state.
virtual void setPersistentState (const std::string &state)
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node.
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node.
virtual void writeTo (AbstractPersistenceOutputStream *) const
virtual void readFrom (AbstractPersistenceInputStream *, int)

Protected Member Functions

void sendEvent (BaseEvent *event, void *skipListener=nullptr)

Additional Inherited Members

Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...

Detailed Description

EventSourceBase class adds event listener handling to Base. Events are derived from BaseEvent.

Definition at line 30 of file mlEventSource.h.

Constructor & Destructor Documentation

◆ EventSource() [1/2]

ml::EventSource::EventSource ( )

Referenced by EventSource(), and hasEventListeners().

◆ EventSource() [2/2]

ml::EventSource::EventSource ( const EventSource & evSource)

References EventSource().

◆ ~EventSource()

ml::EventSource::~EventSource ( )
override

Member Function Documentation

◆ addEventListener()

void ml::EventSource::addEventListener ( BaseEventCallback * cb,
void * userData )

Adds event listener callback to this Base object. The userData will be the first argument when the callback is called.

◆ hasEventListeners()

bool ml::EventSource::hasEventListeners ( ) const

Checks whether any event listeners have been added to this Base object; this can be used to skip the sendEvent call and the potentially expensive building of the event object altogether.

References EventSource().

◆ removeEventListener()

void ml::EventSource::removeEventListener ( BaseEventCallback * cb,
void * userData )

Removes event listener callback from this Base object. Arguments must be the same as for the addEventListener call.

◆ sendEvent()

void ml::EventSource::sendEvent ( BaseEvent * event,
void * skipListener = nullptr )
protected

Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h.

Passes event object to all registered listeners, ownership stays with the sender. This way, you can create the event object on the stack. If skipListener is set to a non-NULL value, the event will not be sent to any listeners that have the same userData set. This way, you can avoid to be notified of your own changes.

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