Description d'un gestionnaire d'évènements, classe pouvant recevoir des évènements. Plus de détails...

#include <EventHandler.hpp>

Graphe d'héritage de castor3d::NonClientEventHandler< Derived >:

Graphe de collaboration de castor3d::NonClientEventHandler< Derived >:

[légende]

Types publics
using	ClientMouseFunction = EventHandler::ClientMouseFunction

using	ClientKeyboardFunction = EventHandler::ClientKeyboardFunction

using	ClientHandlerFunction = EventHandler::ClientHandlerFunction

using	NonClientMouseFunction = std::function< void(DerivedSPtr, MouseEvent const &) >

using	NonClientKeyboardFunction = std::function< void(DerivedSPtr, KeyboardEvent const &) >

using	NonClientHandlerFunction = std::function< void(DerivedSPtr, 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

Types publics hérités de castor3d::EventHandler
using	ClientMouseFunction = std::function< void(MouseEvent const &) >

using	ClientKeyboardFunction = std::function< void(KeyboardEvent const &) >

using	ClientHandlerFunction = std::function< void(HandlerEvent const &) >

using	EnableFunction = std::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

Fonctions membres publiques
	CU_DeclareSmartPtr (Derived)

	NonClientEventHandler (castor::String const &name, bool catchMouseEvents)

void	connectNC (MouseEventType event, NonClientMouseFunction function)

void	connectNC (KeyboardEventType event, NonClientKeyboardFunction function)

void	connectNC (HandlerEventType event, NonClientHandlerFunction function)

Fonctions membres publiques hérités de castor3d::EventHandler
	EventHandler (castor::String const &name, bool catchMouseEvents)

virtual	~EventHandler ()

void	processEvents ()

void	pushEvent (MouseEvent const &event)

void	connect (MouseEventType event, ClientMouseFunction function)

void	pushEvent (KeyboardEvent const &event)

void	connect (KeyboardEventType event, ClientKeyboardFunction function)

bool	catchesMouseEvents () const

void	setCatchesMouseEvents (bool value)

bool	isEnabled () const

void	enable ()

void	disable ()

void	pushEvent (HandlerEvent const &event)

void	connect (HandlerEventType event, ClientHandlerFunction function)

bool	catchesTabKey () const

bool	catchesReturnKey () const

Types protégés
using	EventHandlerFunction = EventHandler::EventHandlerFunction

using	EventQueue = EventHandler::EventQueue

Types protégés hérités de castor3d::EventHandler
using	EventHandlerFunction = std::function< void() >

using	EventQueue = std::deque< std::pair< UserInputEventSPtr, EventHandlerFunction > >

Attributs protégés
std::array< OnNonClientMouseEvent, size_t(MouseEventType::eCount) >	m_ncMouseSlots

std::array< std::vector< OnNonClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_ncMouseSlotsConnections

std::array< OnNonClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlots

std::array< std::vector< OnNonClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlotsConnections

std::array< OnNonClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_ncHandlerSlots

std::array< std::vector< OnNonClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_ncHandlerSlotsConnections

Attributs protégés hérités de castor3d::EventHandler
std::array< OnClientMouseEvent, size_t(MouseEventType::eCount) >	m_mouseSlots

std::array< std::vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_mouseSlotsConnections

std::array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_keyboardSlots

std::array< std::vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_keyboardSlotsConnections

std::array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_handlerSlots

std::array< std::vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_handlerSlotsConnections

Membres hérités additionnels
Attributs publics hérités de castor3d::EventHandler
OnEnable	onEnable

Fonctions membres protégées hérités de castor3d::EventHandler
void	processMouseEvent (MouseEventSPtr event)

void	processKeyboardEvent (KeyboardEventSPtr event)

void	processHandlerEvent (HandlerEventSPtr event)

Description détaillée

template<class Derived>
class castor3d::NonClientEventHandler< Derived >

Description d'un gestionnaire d'évènements, classe pouvant recevoir des évènements.

Documentation des définitions de type membres

◆ ClientHandlerFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::ClientHandlerFunction = EventHandler::ClientHandlerFunction

◆ ClientKeyboardFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::ClientKeyboardFunction = EventHandler::ClientKeyboardFunction

◆ ClientMouseFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::ClientMouseFunction = EventHandler::ClientMouseFunction

◆ EventHandlerFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::EventHandlerFunction = EventHandler::EventHandlerFunction

protected

◆ EventQueue

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::EventQueue = EventHandler::EventQueue

protected

◆ NonClientHandlerFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::NonClientHandlerFunction = std::function< void( DerivedSPtr, HandlerEvent const & ) >

Définition d'une fonction de traitement d'évènement non client de gestionnaire.

◆ NonClientKeyboardFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::NonClientKeyboardFunction = std::function< void( DerivedSPtr, KeyboardEvent const & ) >

Définition d'une fonction de traitement d'évènement non client de clavier.

◆ NonClientMouseFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::NonClientMouseFunction = std::function< void( DerivedSPtr, MouseEvent const & ) >

Définition d'une fonction de traitement d'évènement non client de souris.

◆ OnNonClientHandlerEvent

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientHandlerEvent = castor::SignalT< NonClientHandlerFunction >

Définition d'un signal d'évènement non client de gestionnaire.

◆ OnNonClientHandlerEventConnection

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientHandlerEventConnection = typename OnNonClientHandlerEvent::connection

Définition d'une connexion au signal d'évènement non client de gestionnaire.

◆ OnNonClientKeyboardEvent

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientKeyboardEvent = castor::SignalT< NonClientKeyboardFunction >

Définition d'un signal d'évènement non client de clavier.

◆ OnNonClientKeyboardEventConnection

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientKeyboardEventConnection = typename OnNonClientKeyboardEvent::connection

Définition d'une connexion au signal d'évènement non client de clavier.

◆ OnNonClientMouseEvent

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientMouseEvent = castor::SignalT< NonClientMouseFunction >

Définition d'un signal d'évènement non client de souris.

◆ OnNonClientMouseEventConnection

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientMouseEventConnection = typename OnNonClientMouseEvent::connection

Définition d'une connexion au signal d'évènement non client de souris.

Documentation des constructeurs et destructeur

◆ NonClientEventHandler()

template<class Derived >

castor3d::NonClientEventHandler< Derived >::NonClientEventHandler	(	castor::String const &	name,
		bool	catchMouseEvents
	)

inlineexplicit

Documentation des fonctions membres

◆ connectNC() [1/3]

template<class Derived >

void castor3d::NonClientEventHandler< Derived >::connectNC	(	HandlerEventType	event,
		NonClientHandlerFunction	function
	)

inline

Références castor3d::EventHandler::connect(), castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlots, et castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ connectNC() [2/3]

template<class Derived >

void castor3d::NonClientEventHandler< Derived >::connectNC	(	KeyboardEventType	event,
		NonClientKeyboardFunction	function
	)

inline

Références castor3d::EventHandler::connect(), castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlots, et castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ connectNC() [3/3]

template<class Derived >

void castor3d::NonClientEventHandler< Derived >::connectNC	(	MouseEventType	event,
		NonClientMouseFunction	function
	)

inline

Références castor3d::EventHandler::connect(), castor3d::NonClientEventHandler< Derived >::m_ncMouseSlots, et castor3d::NonClientEventHandler< Derived >::m_ncMouseSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ CU_DeclareSmartPtr()

template<class Derived >

castor3d::NonClientEventHandler< Derived >::CU_DeclareSmartPtr ( Derived )

Documentation des données membres

◆ m_ncHandlerSlots

template<class Derived >

std::array< OnNonClientHandlerEvent, size_t( HandlerEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlots

protected

Les slots d'évènements de gestionnaire non clients.

Référencé par castor3d::NonClientEventHandler< Derived >::connectNC().

◆ m_ncHandlerSlotsConnections

template<class Derived >

std::array< std::vector< OnNonClientHandlerEventConnection >, size_t( HandlerEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlotsConnections

protected

Les slots d'évènements de gestionnaire non clients.

Référencé par castor3d::NonClientEventHandler< Derived >::connectNC().

◆ m_ncKeyboardSlots

template<class Derived >

std::array< OnNonClientKeyboardEvent, size_t( KeyboardEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlots

protected

Les slots d'évènements clavier non clients.

Référencé par castor3d::NonClientEventHandler< Derived >::connectNC().

◆ m_ncKeyboardSlotsConnections

template<class Derived >

std::array< std::vector< OnNonClientKeyboardEventConnection >, size_t( KeyboardEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlotsConnections

protected

Les slots d'évènements clavier non clients.

Référencé par castor3d::NonClientEventHandler< Derived >::connectNC().

◆ m_ncMouseSlots

template<class Derived >

std::array< OnNonClientMouseEvent, size_t( MouseEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncMouseSlots

protected

Les slots d'évènements souris non clients.

Référencé par castor3d::NonClientEventHandler< Derived >::connectNC().

◆ m_ncMouseSlotsConnections

template<class Derived >

std::array< std::vector< OnNonClientMouseEventConnection >, size_t( MouseEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncMouseSlotsConnections

protected

Les slots d'évènements souris non clients.

Référencé par castor3d::NonClientEventHandler< Derived >::connectNC().

La documentation de cette classe a été générée à partir du fichier suivant :

Event/UserInput/EventHandler.hpp

Types publics

Fonctions membres publiques

Types protégés

Attributs protégés

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ ClientHandlerFunction

◆ ClientKeyboardFunction

◆ ClientMouseFunction

◆ EventHandlerFunction

◆ EventQueue

◆ NonClientHandlerFunction

◆ NonClientKeyboardFunction

◆ NonClientMouseFunction

◆ OnNonClientHandlerEvent

◆ OnNonClientHandlerEventConnection

◆ OnNonClientKeyboardEvent

◆ OnNonClientKeyboardEventConnection

◆ OnNonClientMouseEvent

◆ OnNonClientMouseEventConnection

Documentation des constructeurs et destructeur

◆ NonClientEventHandler()

Documentation des fonctions membres

◆ connectNC() [1/3]

◆ connectNC() [2/3]

◆ connectNC() [3/3]

◆ CU_DeclareSmartPtr()

Documentation des données membres

◆ m_ncHandlerSlots

◆ m_ncHandlerSlotsConnections

◆ m_ncKeyboardSlots

◆ m_ncKeyboardSlotsConnections

◆ m_ncMouseSlots

◆ m_ncMouseSlotsConnections