utils::Listeners Class Reference

#include <listeners.h>

Collaboration diagram for utils::Listeners:

[legend]

Data Structures
struct	ListenerData
Public Member Functions
	Listeners (void)
	~Listeners (void)
unsigned long	add_listener (const PluginEvent event_type, EventFunc callback, void *user_data)
bool	remove_listener (unsigned long handler_id)
	Remove listener.
void	broadcast (IPluginUnknown *sender, const PluginEvent event_type, const PluginEventAttrs *plugin_data)
	Broadcast.
	Listeners (void)
	~Listeners (void)
unsigned long	add_listener (const PluginEvent event_type, EventFunc callback, void *user_data)
bool	remove_listener (unsigned long handler_id)
	Remove listener.
void	broadcast (IPluginUnknown *sender, const PluginEvent event_type, const PluginEventAttrs *plugin_data)
	Broadcast.
	Listeners (void)
	~Listeners (void)
unsigned long	add_listener (const PluginEvent event_type, EventFunc callback, void *user_data)
bool	remove_listener (unsigned long handler_id)
	Remove listener.
void	broadcast (IPluginUnknown *sender, const PluginEvent event_type, const PluginEventAttrs *plugin_data)
	Broadcast.

---

Detailed Description

Implement a event listener container. This class enables user to manage listeners for every PluginEvent type. The handler_id will never be zero, so listener can use zero as a special flag.

Definition at line 42 of file images/plugin_impl/listeners.h.

---

Constructor & Destructor Documentation

utils::Listeners::Listeners

(

void

)

Definition at line 32 of file images/plugin_impl/listeners.cpp.

: handler_id(0)
{
}

utils::Listeners::~Listeners

(

void

)

Definition at line 37 of file images/plugin_impl/listeners.cpp.

{
}

utils::Listeners::Listeners

(

void

)

utils::Listeners::~Listeners

(

void

)

utils::Listeners::Listeners

(

void

)

utils::Listeners::~Listeners

(

void

)

---

Member Function Documentation

unsigned long utils::Listeners::add_listener	(	const PluginEvent	event_type,
		EventFunc	callback,
		void *	user_data
	)

Add listener. Repeated adding same callback function is allowed. So this function always returns the new added handler id.

unsigned long utils::Listeners::add_listener	(	const PluginEvent	event_type,
		EventFunc	callback,
		void *	user_data
	)

Add listener. Repeated adding same callback function is allowed. So this function always returns the new added handler id.

unsigned long utils::Listeners::add_listener	(	const PluginEvent	event_type,
		EventFunc	callback,
		void *	user_data
	)

Add listener. Repeated adding same callback function is allowed. So this function always returns the new added handler id.

Definition at line 44 of file images/plugin_impl/listeners.cpp.

References data.

{
    ++handler_id;
    ListenerData * data = new ListenerData;
    data->callback = callback;
    data->user_data = user_data;
    data->handler_id = handler_id;
    listeners[event_type].push_back(data);
    return handler_id;
}

void utils::Listeners::broadcast	(	IPluginUnknown *	sender,
		const PluginEvent	event_type,
		const PluginEventAttrs *	plugin_data
	)

Broadcast.

void utils::Listeners::broadcast	(	IPluginUnknown *	sender,
		const PluginEvent	event_type,
		const PluginEventAttrs *	plugin_data
	)

Broadcast.

void utils::Listeners::broadcast	(	IPluginUnknown *	sender,
		const PluginEvent	event_type,
		const PluginEventAttrs *	plugin_data
	)

Broadcast.

Definition at line 74 of file images/plugin_impl/listeners.cpp.

{
    broadcast_to_vector(listeners[event_type], sender, 
                        event_type, plugin_data);
}

bool utils::Listeners::remove_listener

(

unsigned long

handler_id

)

Remove listener.

bool utils::Listeners::remove_listener

(

unsigned long

handler_id

)

Remove listener.

bool utils::Listeners::remove_listener

(

unsigned long

handler_id

)

Remove listener.

Definition at line 58 of file images/plugin_impl/listeners.cpp.

{
    // Have to search the whole map.
    ListenerMapIter begin = listeners.begin();
    ListenerMapIter end   = listeners.end();
    for(ListenerMapIter it = begin; it != end; ++it)
    {
        if (remove_from_vector(handler_id, it->second))
        {
            return true;
        }
    }
    return false;
}

---

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

• images/plugin_impl/listeners.h
• pdf/plugin_impl/listeners.h
• plaintext/plugin_impl/listeners.h
• images/plugin_impl/listeners.cpp
• pdf/plugin_impl/listeners.cpp
• plaintext/plugin_impl/listeners.cpp