lxgui::gui::event_receiver Class Reference

Utility object to store and manage connections to event signals. More...

#include <gui_event_receiver.hpp>

Public Member Functions
	event_receiver (event_emitter &emitter)
	Constructor.
	event_receiver (const event_receiver &)=delete
	event_receiver (event_receiver &&)=delete
event_receiver &	operator= (const event_receiver &)=delete
event_receiver &	operator= (event_receiver &&)=delete
void	register_event (const std::string &event_name, event_handler_function callback)
	Enables reaction to an event.
void	unregister_event (const std::string &event_name)
	Disables reaction to an event.

Detailed Description

Utility object to store and manage connections to event signals.

This class enables registering callbacks to multiple events, and automatically manages the lifetime of the callbacks.

Definition at line 19 of file gui_event_receiver.hpp.

Constructor & Destructor Documentation

event_receiver() [1/3]

lxgui::gui::event_receiver::event_receiver ( event_emitter &  emitter )

explicit

Constructor.

Parameters

emitter

The event emitter to listen to

Definition at line 9 of file gui_event_receiver.cpp.

event_receiver() [2/3]

lxgui::gui::event_receiver::event_receiver ( const event_receiver &  )

delete

event_receiver() [3/3]

lxgui::gui::event_receiver::event_receiver ( event_receiver &&  )

delete

Member Function Documentation

operator=() [1/2]

event_receiver & lxgui::gui::event_receiver::operator= ( const event_receiver &  )

delete

operator=() [2/2]

event_receiver & lxgui::gui::event_receiver::operator= ( event_receiver &&  )

delete

register_event()

void lxgui::gui::event_receiver::register_event	(	const std::string &	event_name,
		event_handler_function	callback
	)

Enables reaction to an event.

Parameters

event_name	The name of the event this class should react to
callback	The callback function to register to this event

Definition at line 11 of file gui_event_receiver.cpp.

unregister_event()

void lxgui::gui::event_receiver::unregister_event

(

const std::string &

event_name

)

Disables reaction to an event.

Parameters

event_name

The name of the event this class shouldn't react to anymore

Definition at line 17 of file gui_event_receiver.cpp.

---

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

• /home/runner/work/lxgui/lxgui/include/lxgui/gui_event_receiver.hpp
• /home/runner/work/lxgui/lxgui/src/gui_event_receiver.cpp