Description of an event handler, class that can receive event. More...

#include <EventHandler.hpp>

Inheritance diagram for castor3d::NonClientEventHandler< Derived >:

[legend]

Collaboration diagram for castor3d::NonClientEventHandler< Derived >:

[legend]

Public Types
using	DerivedPtr = Derived *

using	ClientMouseFunction = EventHandler::ClientMouseFunction

using	ClientKeyboardFunction = EventHandler::ClientKeyboardFunction

using	ClientHandlerFunction = EventHandler::ClientHandlerFunction

using	NonClientMouseFunction = castor::Function< void( DerivedPtr, MouseEvent const & ) >

using	NonClientKeyboardFunction = castor::Function< void( DerivedPtr, KeyboardEvent const & ) >

using	NonClientHandlerFunction = castor::Function< void( DerivedPtr, HandlerEvent const & ) >

using	OnNonClientMouseEvent = castor::SignalT< NonClientMouseFunction >

using	OnNonClientKeyboardEvent = castor::SignalT< NonClientKeyboardFunction >

using	OnNonClientHandlerEvent = castor::SignalT< NonClientHandlerFunction >

using	OnNonClientMouseEventConnection = typename OnNonClientMouseEvent::connection

using	OnNonClientKeyboardEventConnection = typename OnNonClientKeyboardEvent::connection

using	OnNonClientHandlerEventConnection = typename OnNonClientHandlerEvent::connection

Public Types inherited from castor3d::EventHandler
using	ClientMouseFunction = castor::Function< void( MouseEvent const & ) >

using	ClientKeyboardFunction = castor::Function< void( KeyboardEvent const & ) >

using	ClientHandlerFunction = castor::Function< void( HandlerEvent const & ) >

using	EnableFunction = castor::Function< void( bool ) >

using	OnClientMouseEvent = castor::SignalT< ClientMouseFunction >

using	OnClientKeyboardEvent = castor::SignalT< ClientKeyboardFunction >

using	OnClientHandlerEvent = castor::SignalT< ClientHandlerFunction >

using	OnEnable = castor::SignalT< EnableFunction >

using	OnClientMouseEventConnection = OnClientMouseEvent::connection

using	OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection

using	OnClientHandlerEventConnection = OnClientHandlerEvent::connection

using	OnEnableConnection = OnEnable::connection

Public Member Functions
	NonClientEventHandler (castor::String const &name, bool catchMouseEvents)
	Constructor.

void	connectNC (MouseEventType event, NonClientMouseFunction function)
	Connects a function to a non client mouse event.

void	connectNC (KeyboardEventType event, NonClientKeyboardFunction function)
	Connects a function to a non client keyboard event.

void	connectNC (HandlerEventType event, NonClientHandlerFunction function)
	Connects a function to a non client handler event.

Public Member Functions inherited from castor3d::EventHandler
void	pushEvent (MouseEvent const &event)
	Adds a mouse event to the events queue.

void	connect (MouseEventType event, ClientMouseFunction function)
	Connects a function to a mouse event.

bool	catchesMouseEvents () const
	Tells if the control catches mouse events.

void	setCatchesMouseEvents (bool value)
	Sets if the control can catch mouse events.

void	pushEvent (KeyboardEvent const &event)
	Adds a keyboard event to the events queue.

void	connect (KeyboardEventType event, ClientKeyboardFunction function)
	Connects a function to a keyboard event.

bool	catchesTabKey () const
	Tells if the control catches 'tab' key.

bool	catchesReturnKey () const
	Tells if the control catches 'return' key.

	EventHandler (castor::String const &name, bool catchMouseEvents)
	Constructor.

virtual	~EventHandler () noexcept
	Destructor.

void	processEvents ()
	Processes all queued events.

bool	isEnabled () const

void	enable ()
	Sets if the control is enabled.

void	disable ()
	Sets if the control is disabled.

void	pushEvent (HandlerEvent const &event)
	Adds a handler event to the events queue.

void	connect (HandlerEventType event, ClientHandlerFunction function)
	Connects a function to a handler event.

Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.

T const &	getName () const noexcept
	Retrieves the name.

void	rename (T name) noexcept

Protected Types
using	EventHandlerFunction = EventHandler::EventHandlerFunction

using	EventQueue = EventHandler::EventQueue

Protected Types inherited from castor3d::EventHandler
using	EventHandlerFunction = castor::Function< void() >

using	EventQueue = castor::Deque< castor::Pair< UserInputEventSPtr, EventHandlerFunction > >

Protected Attributes
castor::Array< OnNonClientMouseEvent, size_t(MouseEventType::eCount) >	m_ncMouseSlots

castor::Array< castor::Vector< OnNonClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_ncMouseSlotsConnections

castor::Array< OnNonClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlots

castor::Array< castor::Vector< OnNonClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlotsConnections

castor::Array< OnNonClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_ncHandlerSlots

castor::Array< castor::Vector< OnNonClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_ncHandlerSlotsConnections

Protected Attributes inherited from castor3d::EventHandler
castor::Array< OnClientMouseEvent, size_t(MouseEventType::eCount) >	m_mouseSlots

castor::Array< castor::Vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_mouseSlotsConnections

castor::Array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_keyboardSlots

castor::Array< castor::Vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_keyboardSlotsConnections

castor::Array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_handlerSlots

castor::Array< castor::Vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_handlerSlotsConnections

Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Additional Inherited Members
Public Attributes inherited from castor3d::EventHandler
OnEnable	onEnable

Protected Member Functions inherited from castor3d::EventHandler
void	processMouseEvent (MouseEventSPtr event)
	Mouse event processing function.

void	processKeyboardEvent (KeyboardEventSPtr event)
	Keyboard event processing function.

void	processHandlerEvent (HandlerEventSPtr event)
	Handler event processing function.