EventSourceBase class adds event listener handling to Base. More...

#include <mlEventSource.h>

Inheritance diagram for ml::EventSource:

Public Member Functions
	EventSource ()

	EventSource (const EventSource &evSource)

	~EventSource () override

void	addEventListener (BaseEventCallback cb, void userData)
	add event listener callback to this Base object - the userData will be the first argument when the callback is called More...

void	removeEventListener (BaseEventCallback cb, void userData)
	remove event listener callback from this Base object - arguments must be the same as for the addEventListener call More...

bool	hasEventListeners () const
	check if 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 More...

Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...

virtual	~Base ()
	Destructor. More...

virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion() More...

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument. More...

virtual bool	isRefCountedBase () const
	Returns if the instance is derived from RefCountedBase. More...

virtual std::string	detailString () const
	Return a string describing this object. More...

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class. More...

virtual std::string	persistentState () const
	Returns a string describing the object's internal state. More...

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`. More...

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node. More...

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node. More...

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Write the objects state to the data stream object. More...

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object. More...

Protected Member Functions
void	sendEvent (BaseEvent event, void skipListener=nullptr)
	Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h. More...

Protected Member Functions inherited from ml::Base
virtual char *	getPersistentState () const
	Returns a C string describing the object's internal state. More...

virtual void	setPersistentState (const char *)
	Restores the object's internal state from a string that had been previously generated using `getPersistentState()`. More...

virtual void	clearPersistentState (char *) const
	Disposes a string previously allocated by `getPersistentState()`. More...

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 ( )

◆ EventSource() [2/2]

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

◆ ~EventSource()

ml::EventSource::~EventSource ( )

override

Member Function Documentation

◆ addEventListener()

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

add 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

check if 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

◆ removeEventListener()

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

remove 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.

pass event object to all registered listeners, ownership stays with the sender (so 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, so you can avoid to be notified of your own changes.

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

MeVis/Foundation/Sources/MLUtilities/mlEventSource.h

Public Member Functions

Protected Member Functions

Additional Inherited Members