An event handler for a custom widget which eases interaction with GUIEvents within your module. More...

#include <WUIViewEventHandler.h>

Inheritance diagram for WUIViewEventHandler:

Collaboration diagram for WUIViewEventHandler:

Public Types
typedef boost::signals2::signal< void(WVector2f, int) >	ButtonSignalType
	Short hand type for signal signature of PUSH, RELEASE and DOUBLECLICK event. More...

typedef boost::signals2::signal< void(WVector2f, unsigned int) >	DragSignalType
	Short hand type for signal signature of DRAG event. More...

typedef boost::signals2::signal< void(WVector2f) >	MoveSignalType
	Short hand type for signal signature of MOVE event. More...

typedef boost::signals2::signal< void(GUIEvents::ScrollingMotion, float, float) >	ScrollSignalType
	Short hand type for signal signature of SCROLL event. More...

typedef boost::signals2::signal< void(void) >	TriggerSignalType
	Short hand type for signal signature of FRAME, PEN_PROXIMITY_ENTER, -LEAVE, CLOSE_WINDOW, QUIT_APPLICATION and USER event. More...

typedef boost::signals2::signal< void(int, unsigned int) >	KeySignalType
	Short hand type for signal signature of KEYDOWN and KEYUP event. More...

typedef boost::signals2::signal< void(int, int, int, int) >	ResizeSignalType
	Short hand type for signal signature of RESIZE event. More...

typedef boost::signals2::signal< void(float) >	PenPressureSignalType
	Short hand type for signal signature of PEN_PRESSURE event. More...

typedef boost::signals2::signal< void(const osg::Matrix) >	PenOrientationSignalType
	Short hand type for signal signature of PEN_ORIENTATION event. More...

Public Member Functions
	WUIViewEventHandler (WUIViewWidget::SPtr widget)
	Constructor. More...

bool	handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &)
	The OSG calls this function whenever a new event has occured. More...

virtual void	subscribePush (ButtonSignalType::slot_type slot)
	Registers a function slot to PUSH events. More...

virtual void	subscribeRelease (ButtonSignalType::slot_type slot)
	Registers a function slot to RELEASE events. More...

virtual void	subscribeDoubleclick (ButtonSignalType::slot_type slot)
	Registers a function slot to DOUBLECLICK events. More...

virtual void	subscribeDrag (DragSignalType::slot_type slot)
	Registers a function slot to DRAG events. More...

virtual void	subscribeMove (MoveSignalType::slot_type slot)
	Registers a function slot to MOVE events. More...

virtual void	subscribeKeydown (KeySignalType::slot_type slot)
	Registers a function slot to KEYDOWN events. More...

virtual void	subscribeKeyup (KeySignalType::slot_type slot)
	Registers a function slot to KEYUP events. More...

virtual void	subscribeFrame (TriggerSignalType::slot_type)
	Registers a function slot to FRAME events. More...

virtual void	subscribeResize (ResizeSignalType::slot_type slot)
	Registers a function slot to RESIZE events. More...

virtual void	subscribeScroll (ScrollSignalType::slot_type slot)
	Registers a function slot to SCROLL events. More...

virtual void	subscribePenPressure (PenPressureSignalType::slot_type slot)
	Registers a function slot to PEN_PRESSURE events. More...

virtual void	subscribePenOrientation (PenOrientationSignalType::slot_type slot)
	Registers a function slot to PEN_ORIENTATION events. More...

virtual void	subscribePenProximityEnter (TriggerSignalType::slot_type slot)
	Registers a function slot to PEN_PROXIMITY_ENTER events. More...

virtual void	subscribePenProximityLeave (TriggerSignalType::slot_type slot)
	Registers a function slot to PEN_PROXIMITY_LEAVE events. More...

virtual void	subscribeCloseWindow (TriggerSignalType::slot_type slot)
	Registers a function slot to CLOSE_WINDOW events. More...

virtual void	subscribeQuitApplication (TriggerSignalType::slot_type slot)
	Registers a function slot to QUIT_APPLICATION events. More...

virtual void	subscribeUser (TriggerSignalType::slot_type slot)
	Registers a function slot to USER events. More...

virtual void	handlePush (WVector2f mousePos, int button)
	Called whenever the PUSH event occurs. More...

virtual void	handleRelease (WVector2f mousePos, int button)
	Called whenever the RELEASE event occurs. More...

virtual void	handleDoubleclick (WVector2f mousePos, int button)
	Called whenever the DOUBLECLICK event occurs. More...

virtual void	handleDrag (WVector2f mousePos, int buttonMask)
	Called whenever the DRAG event occurs. More...

virtual void	handleMove (WVector2f mousePos)
	Called whenever the MOVE event occurs. More...

virtual void	handleKeydown (int keyID, unsigned int modKeyMask)
	Called whenever the KEYDOWN event occurs. More...

virtual void	handleKeyup (int keyID, unsigned int modKeyMask)
	Called whenever the KEYUP event occurs. More...

virtual void	handleFrame ()
	Called whenever the FRAME event occurs. More...

virtual void	handleResize (int xPos, int yPos, int width, int height)
	Called whenever the widget has resized. More...

virtual void	handleScroll (GUIEvents::ScrollingMotion motion, float deltaX, float deltaY)
	Called whenever the SCROLL event occurs. More...

virtual void	handlePenPressure (float pressure)
	Called whenever the PEN_PRESSURE event occurs. More...

virtual void	handlePenOrientation (const osg::Matrix orientation)
	Called whenever the PEN_ORIENTATION event occurs. More...

virtual void	handlePenProximityEnter ()
	Called whenever the PEN_PROXIMITY_ENTER event occurs. More...

virtual void	handlePenProximityLeave ()
	Called whenever the PEN_PROXIMITY_LEAVE event occurs. More...

virtual void	handleCloseWindow ()
	Called whenever the CLOSE_WINDOW event occurs. More...

virtual void	handleQuitApplication ()
	Called whenever the QUIT_APPLICATION event occurs. More...

virtual void	handleUser ()
	Called whenever the USER event occurs. More...

Protected Member Functions
wlog::WStreamedLogger	errorLog () const
	Logger instance for comfortable error logging. More...

Protected Attributes
ButtonSignalType	m_sigPush
	Signal used for notification of the PUSH event. More...

ButtonSignalType	m_sigRelease
	Signal used for notification of the RELEASE event. More...

ButtonSignalType	m_sigDoubleclick
	Signal used for notification of the DOUBLECLICK event. More...

DragSignalType	m_sigDrag
	Signal used for notification of the DRAG event. More...

MoveSignalType	m_sigMove
	Signal used for notification of the MOVE event. More...

KeySignalType	m_sigKeydown
	Signal used for notification of the KEYDOWN event. More...

KeySignalType	m_sigKeyup
	Signal used for notification of the KEYUP event. More...

TriggerSignalType	m_sigFrame
	Signal used for notification of the FRAME event. More...

ResizeSignalType	m_sigResize
	Signal used for notification of the RESIZE event. More...

ScrollSignalType	m_sigScroll
	Signal used for notification of the SCROLL event. More...

PenPressureSignalType	m_sigPenPressure
	Signal used for notification of the PEN_PRESSURE event. More...

PenOrientationSignalType	m_sigPenOrientation
	Signal used for notification of the PEN_ORIENTATION event. More...

TriggerSignalType	m_sigPenProximityEnter
	Signal used for notification of the PEN_PROXIMITY_ENTER event. More...

TriggerSignalType	m_sigPenProximityLeave
	Signal used for notification of the PEN_PROXIMITY_LEAVE event. More...

TriggerSignalType	m_sigCloseWindow
	Signal used for notification of the CLOSE_WINDOW event. More...

TriggerSignalType	m_sigQuitApplication
	Signal used for notification of the QUIT_APPLICATION event. More...

TriggerSignalType	m_sigUser
	Signal used for notification of the USER event. More...

WUIViewWidget::SPtr	m_widget
	Reference to the WUIViewWidget for which event handling should performed. More...

unsigned int	m_preselection
	Binary mask describing which events should be used for notification or subscription. More...

Detailed Description

An event handler for a custom widget which eases interaction with GUIEvents within your module.

Without you need to write your own event handler and register it. However if you still need your own event handler you might consider subclassing from this one. Basically there are two ways of getting notified of GUIEvents. First you can connect a member function to events or you can overwrite member functions of this class to handle specific events.

Use boost::bind and the subscribeXY methods to connect a member function of your module to a specific GUIEvent. Please note that this is now called in context of the GUI thread and that you need to take care of threadsafety by yourself.

Use the corresponding handleXY() member functions if you still need a custom event handler. But take care that you may need to set the WUIViewEventHandler::m_preselection event-mask accordingly within the constructor then.

In case you might not know what the specific parameters of the handle function represent you might have luck looking into the OpenSceneGraph documentation http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs within the GUIEventAdapter class.

Definition at line 53 of file WUIViewEventHandler.h.

Member Typedef Documentation

◆ ButtonSignalType

typedef boost::signals2::signal< void ( WVector2f, int ) > WUIViewEventHandler::ButtonSignalType

Short hand type for signal signature of PUSH, RELEASE and DOUBLECLICK event.

Definition at line 75 of file WUIViewEventHandler.h.

◆ DragSignalType

typedef boost::signals2::signal< void ( WVector2f, unsigned int ) > WUIViewEventHandler::DragSignalType

Short hand type for signal signature of DRAG event.

Definition at line 80 of file WUIViewEventHandler.h.

◆ KeySignalType

typedef boost::signals2::signal< void ( int, unsigned int ) > WUIViewEventHandler::KeySignalType

Short hand type for signal signature of KEYDOWN and KEYUP event.

Definition at line 100 of file WUIViewEventHandler.h.

◆ MoveSignalType

typedef boost::signals2::signal< void ( WVector2f ) > WUIViewEventHandler::MoveSignalType

Short hand type for signal signature of MOVE event.

Definition at line 85 of file WUIViewEventHandler.h.

◆ PenOrientationSignalType

typedef boost::signals2::signal< void ( const osg::Matrix ) > WUIViewEventHandler::PenOrientationSignalType

Short hand type for signal signature of PEN_ORIENTATION event.

Definition at line 115 of file WUIViewEventHandler.h.

◆ PenPressureSignalType

typedef boost::signals2::signal< void ( float ) > WUIViewEventHandler::PenPressureSignalType

Short hand type for signal signature of PEN_PRESSURE event.

Definition at line 110 of file WUIViewEventHandler.h.

◆ ResizeSignalType

typedef boost::signals2::signal< void ( int, int, int, int ) > WUIViewEventHandler::ResizeSignalType

Short hand type for signal signature of RESIZE event.

Definition at line 105 of file WUIViewEventHandler.h.

◆ ScrollSignalType

typedef boost::signals2::signal< void ( GUIEvents::ScrollingMotion, float, float ) > WUIViewEventHandler::ScrollSignalType

Short hand type for signal signature of SCROLL event.

Definition at line 90 of file WUIViewEventHandler.h.

◆ TriggerSignalType

typedef boost::signals2::signal< void ( void ) > WUIViewEventHandler::TriggerSignalType

Short hand type for signal signature of FRAME, PEN_PROXIMITY_ENTER, -LEAVE, CLOSE_WINDOW, QUIT_APPLICATION and USER event.

Definition at line 95 of file WUIViewEventHandler.h.

Constructor & Destructor Documentation

◆ WUIViewEventHandler()

WUIViewEventHandler::WUIViewEventHandler ( WUIViewWidget::SPtr widget )

explicit

Constructor.

Parameters

widget The custom widget for which events should be handled.

Definition at line 29 of file WUIViewEventHandler.cpp.

Member Function Documentation

◆ errorLog()

wlog::WStreamedLogger WUIViewEventHandler::errorLog ( ) const

protected

Logger instance for comfortable error logging.

Simply use errorLog() << "my error".

Returns: the logger stream.

Definition at line 159 of file WUIViewEventHandler.cpp.

References wlog::error(), and m_widget.

Referenced by handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handle()

bool WUIViewEventHandler::handle	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &
	)

The OSG calls this function whenever a new event has occured.

Parameters

ea	Event class for storing GUI events such as mouse or keyboard interation etc.

Returns: true if the event was handled.

Definition at line 35 of file WUIViewEventHandler.cpp.

References errorLog(), handleCloseWindow(), handleDoubleclick(), handleDrag(), handleFrame(), handleKeydown(), handleKeyup(), handleMove(), handlePenOrientation(), handlePenPressure(), handlePenProximityEnter(), handlePenProximityLeave(), handlePush(), handleQuitApplication(), handleRelease(), handleResize(), handleScroll(), handleUser(), m_preselection, m_sigCloseWindow, m_sigDoubleclick, m_sigDrag, m_sigFrame, m_sigKeydown, m_sigKeyup, m_sigMove, m_sigPenOrientation, m_sigPenPressure, m_sigPenProximityEnter, m_sigPenProximityLeave, m_sigPush, m_sigQuitApplication, m_sigRelease, m_sigResize, m_sigScroll, and m_sigUser.

Here is the call graph for this function:

◆ handleCloseWindow()

void WUIViewEventHandler::handleCloseWindow ( )

virtual

Called whenever the CLOSE_WINDOW event occurs.

Definition at line 322 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleDoubleclick()

void WUIViewEventHandler::handleDoubleclick	(	WVector2f	mousePos,
		int	button
	)

virtual

Called whenever the DOUBLECLICK event occurs.

Parameters

mousePos	Current mouse position in X and Y.
button	The involved mouse button. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.

Definition at line 274 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleDrag()

void WUIViewEventHandler::handleDrag	(	WVector2f	mousePos,
		int	buttonMask
	)

virtual

Called whenever the DRAG event occurs.

Parameters

mousePos	Current mouse position in X and Y.
buttonMask	The pushed mouse buttons as a mask. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.

Definition at line 278 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleFrame()

void WUIViewEventHandler::handleFrame ( )

virtual

Called whenever the FRAME event occurs.

This is every new frame.

Definition at line 294 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleKeydown()

void WUIViewEventHandler::handleKeydown	(	int	keyID,
		unsigned int	modKeyMask
	)

virtual

Called whenever the KEYDOWN event occurs.

Parameters

keyID	The pressed key. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.
modKeyMask	Additional function keys pressed.

Definition at line 286 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleKeyup()

void WUIViewEventHandler::handleKeyup	(	int	keyID,
		unsigned int	modKeyMask
	)

virtual

Called whenever the KEYUP event occurs.

Parameters

keyID	The released key. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.
modKeyMask	Additional function keys pressed.

Definition at line 290 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleMove()

void WUIViewEventHandler::handleMove ( WVector2f mousePos )

virtual

Called whenever the MOVE event occurs.

Parameters

mousePos Current mouse position in X and Y.

Definition at line 282 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handlePenOrientation()

void WUIViewEventHandler::handlePenOrientation ( const osg::Matrix orientation )

virtual

Called whenever the PEN_ORIENTATION event occurs.

Parameters

orientation the orientation of the pen.

Definition at line 310 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handlePenPressure()

void WUIViewEventHandler::handlePenPressure ( float pressure )

virtual

Called whenever the PEN_PRESSURE event occurs.

Parameters

pressure pressure of the pen.

Definition at line 306 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handlePenProximityEnter()

void WUIViewEventHandler::handlePenProximityEnter ( )

virtual

Called whenever the PEN_PROXIMITY_ENTER event occurs.

Definition at line 314 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handlePenProximityLeave()

void WUIViewEventHandler::handlePenProximityLeave ( )

virtual

Called whenever the PEN_PROXIMITY_LEAVE event occurs.

Definition at line 318 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handlePush()

void WUIViewEventHandler::handlePush	(	WVector2f	mousePos,
		int	button
	)

virtual

Called whenever the PUSH event occurs.

Parameters

mousePos	Current mouse position in X and Y.
button	The involved mouse button. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.

Definition at line 266 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleQuitApplication()

void WUIViewEventHandler::handleQuitApplication ( )

virtual

Called whenever the QUIT_APPLICATION event occurs.

Definition at line 326 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleRelease()

void WUIViewEventHandler::handleRelease	(	WVector2f	mousePos,
		int	button
	)

virtual

Called whenever the RELEASE event occurs.

Parameters

mousePos	Current mouse position in X and Y.
button	The involved mouse button. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.

Definition at line 270 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleResize()

void WUIViewEventHandler::handleResize	(	int	xPos,
		int	yPos,
		int	width,
		int	height
	)

virtual

Called whenever the widget has resized.

Parameters

xPos	Position in X.
yPos	Position in Y.
width	Width of the widget.
height	Height of the widget.

Definition at line 298 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleScroll()

void WUIViewEventHandler::handleScroll	(	GUIEvents::ScrollingMotion	motion,
		float	deltaX,
		float	deltaY
	)

virtual

Called whenever the SCROLL event occurs.

Parameters

motion	Scrolling motion. See http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs GUIEventAdapter class for values.
deltaX	Delta in X.
deltaY	Delta in Y.

Definition at line 302 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ handleUser()

void WUIViewEventHandler::handleUser ( )

virtual

Called whenever the USER event occurs.

Definition at line 330 of file WUIViewEventHandler.cpp.

Referenced by handle().

Here is the caller graph for this function:

◆ subscribeCloseWindow()

void WUIViewEventHandler::subscribeCloseWindow ( TriggerSignalType::slot_type slot )

virtual

Registers a function slot to CLOSE_WINDOW events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 248 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigCloseWindow.

◆ subscribeDoubleclick()

void WUIViewEventHandler::subscribeDoubleclick ( ButtonSignalType::slot_type slot )

virtual

Registers a function slot to DOUBLECLICK events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 176 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigDoubleclick.

◆ subscribeDrag()

void WUIViewEventHandler::subscribeDrag ( DragSignalType::slot_type slot )

virtual

Registers a function slot to DRAG events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 182 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigDrag.

◆ subscribeFrame()

void WUIViewEventHandler::subscribeFrame ( TriggerSignalType::slot_type slot )

virtual

Registers a function slot to FRAME events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 194 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigFrame.

◆ subscribeKeydown()

void WUIViewEventHandler::subscribeKeydown ( KeySignalType::slot_type slot )

virtual

Registers a function slot to KEYDOWN events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 200 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigKeydown.

◆ subscribeKeyup()

void WUIViewEventHandler::subscribeKeyup ( KeySignalType::slot_type slot )

virtual

Registers a function slot to KEYUP events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 206 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigKeyup.

◆ subscribeMove()

void WUIViewEventHandler::subscribeMove ( MoveSignalType::slot_type slot )

virtual

Registers a function slot to MOVE events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 188 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigMove.

◆ subscribePenOrientation()

void WUIViewEventHandler::subscribePenOrientation ( PenOrientationSignalType::slot_type slot )

virtual

Registers a function slot to PEN_ORIENTATION events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 230 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigPenOrientation.

◆ subscribePenPressure()

void WUIViewEventHandler::subscribePenPressure ( PenPressureSignalType::slot_type slot )

virtual

Registers a function slot to PEN_PRESSURE events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 224 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigPenPressure.

◆ subscribePenProximityEnter()

void WUIViewEventHandler::subscribePenProximityEnter ( TriggerSignalType::slot_type slot )

virtual

Registers a function slot to PEN_PROXIMITY_ENTER events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 236 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigPenProximityEnter.

◆ subscribePenProximityLeave()

void WUIViewEventHandler::subscribePenProximityLeave ( TriggerSignalType::slot_type slot )

virtual

Registers a function slot to PEN_PROXIMITY_LEAVE events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 242 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigPenProximityLeave.

◆ subscribePush()

void WUIViewEventHandler::subscribePush ( ButtonSignalType::slot_type slot )

virtual

Registers a function slot to PUSH events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 164 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigPush.

◆ subscribeQuitApplication()

void WUIViewEventHandler::subscribeQuitApplication ( TriggerSignalType::slot_type slot )

virtual

Registers a function slot to QUIT_APPLICATION events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 254 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigQuitApplication.

◆ subscribeRelease()

void WUIViewEventHandler::subscribeRelease ( ButtonSignalType::slot_type slot )

virtual

Registers a function slot to RELEASE events.

Whenever the event occurs, the slot is called with current parameters. Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 170 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigRelease.

◆ subscribeResize()

void WUIViewEventHandler::subscribeResize ( ResizeSignalType::slot_type slot )

virtual

Registers a function slot to RESIZE events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 212 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigResize.

◆ subscribeScroll()

void WUIViewEventHandler::subscribeScroll ( ScrollSignalType::slot_type slot )

virtual

Registers a function slot to SCROLL events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 218 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigScroll.

◆ subscribeUser()

void WUIViewEventHandler::subscribeUser ( TriggerSignalType::slot_type slot )

virtual

Registers a function slot to USER events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 260 of file WUIViewEventHandler.cpp.

References m_preselection, and m_sigUser.

Member Data Documentation

◆ m_preselection

unsigned int WUIViewEventHandler::m_preselection

protected

Binary mask describing which events should be used for notification or subscription.

Definition at line 443 of file WUIViewEventHandler.h.

Referenced by handle(), subscribeCloseWindow(), subscribeDoubleclick(), subscribeDrag(), subscribeFrame(), subscribeKeydown(), subscribeKeyup(), subscribeMove(), subscribePenOrientation(), subscribePenPressure(), subscribePenProximityEnter(), subscribePenProximityLeave(), subscribePush(), subscribeQuitApplication(), subscribeRelease(), subscribeResize(), subscribeScroll(), and subscribeUser().

◆ m_sigCloseWindow

TriggerSignalType WUIViewEventHandler::m_sigCloseWindow

protected

Signal used for notification of the CLOSE_WINDOW event.

Definition at line 423 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeCloseWindow().

◆ m_sigDoubleclick

ButtonSignalType WUIViewEventHandler::m_sigDoubleclick

protected

Signal used for notification of the DOUBLECLICK event.

Definition at line 363 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeDoubleclick().

◆ m_sigDrag

DragSignalType WUIViewEventHandler::m_sigDrag

protected

Signal used for notification of the DRAG event.

Definition at line 368 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeDrag().

◆ m_sigFrame

TriggerSignalType WUIViewEventHandler::m_sigFrame

protected

Signal used for notification of the FRAME event.

Definition at line 388 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeFrame().

◆ m_sigKeydown

KeySignalType WUIViewEventHandler::m_sigKeydown

protected

Signal used for notification of the KEYDOWN event.

Definition at line 378 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeKeydown().

◆ m_sigKeyup

KeySignalType WUIViewEventHandler::m_sigKeyup

protected

Signal used for notification of the KEYUP event.

Definition at line 383 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeKeyup().

◆ m_sigMove

MoveSignalType WUIViewEventHandler::m_sigMove

protected

Signal used for notification of the MOVE event.

Definition at line 373 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeMove().

◆ m_sigPenOrientation

PenOrientationSignalType WUIViewEventHandler::m_sigPenOrientation

protected

Signal used for notification of the PEN_ORIENTATION event.

Definition at line 408 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribePenOrientation().

◆ m_sigPenPressure

PenPressureSignalType WUIViewEventHandler::m_sigPenPressure

protected

Signal used for notification of the PEN_PRESSURE event.

Definition at line 403 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribePenPressure().

◆ m_sigPenProximityEnter

TriggerSignalType WUIViewEventHandler::m_sigPenProximityEnter

protected

Signal used for notification of the PEN_PROXIMITY_ENTER event.

Definition at line 413 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribePenProximityEnter().

◆ m_sigPenProximityLeave

TriggerSignalType WUIViewEventHandler::m_sigPenProximityLeave

protected

Signal used for notification of the PEN_PROXIMITY_LEAVE event.

Definition at line 418 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribePenProximityLeave().

◆ m_sigPush

ButtonSignalType WUIViewEventHandler::m_sigPush

protected

Signal used for notification of the PUSH event.

Definition at line 353 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribePush().

◆ m_sigQuitApplication

TriggerSignalType WUIViewEventHandler::m_sigQuitApplication

protected

Signal used for notification of the QUIT_APPLICATION event.

Definition at line 428 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeQuitApplication().

◆ m_sigRelease

ButtonSignalType WUIViewEventHandler::m_sigRelease

protected

Signal used for notification of the RELEASE event.

Definition at line 358 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeRelease().

◆ m_sigResize

ResizeSignalType WUIViewEventHandler::m_sigResize

protected

Signal used for notification of the RESIZE event.

Definition at line 393 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeResize().

◆ m_sigScroll

ScrollSignalType WUIViewEventHandler::m_sigScroll

protected

Signal used for notification of the SCROLL event.

Definition at line 398 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeScroll().

◆ m_sigUser

TriggerSignalType WUIViewEventHandler::m_sigUser

protected

Signal used for notification of the USER event.

Definition at line 433 of file WUIViewEventHandler.h.

Referenced by handle(), and subscribeUser().

◆ m_widget

WUIViewWidget::SPtr WUIViewEventHandler::m_widget

protected

Reference to the WUIViewWidget for which event handling should performed.

Definition at line 438 of file WUIViewEventHandler.h.

Referenced by errorLog().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ButtonSignalType

◆ DragSignalType

◆ KeySignalType

◆ MoveSignalType

◆ PenOrientationSignalType

◆ PenPressureSignalType

◆ ResizeSignalType

◆ ScrollSignalType

◆ TriggerSignalType

Constructor & Destructor Documentation

◆ WUIViewEventHandler()

Member Function Documentation

◆ errorLog()

◆ handle()

◆ handleCloseWindow()

◆ handleDoubleclick()

◆ handleDrag()

◆ handleFrame()

◆ handleKeydown()

◆ handleKeyup()

◆ handleMove()

◆ handlePenOrientation()

◆ handlePenPressure()

◆ handlePenProximityEnter()

◆ handlePenProximityLeave()

◆ handlePush()

◆ handleQuitApplication()

◆ handleRelease()

◆ handleResize()

◆ handleScroll()

◆ handleUser()

◆ subscribeCloseWindow()

◆ subscribeDoubleclick()

◆ subscribeDrag()

◆ subscribeFrame()

◆ subscribeKeydown()

◆ subscribeKeyup()

◆ subscribeMove()

◆ subscribePenOrientation()

◆ subscribePenPressure()

◆ subscribePenProximityEnter()

◆ subscribePenProximityLeave()

◆ subscribePush()

◆ subscribeQuitApplication()

◆ subscribeRelease()

◆ subscribeResize()

◆ subscribeScroll()

◆ subscribeUser()

Member Data Documentation

◆ m_preselection

◆ m_sigCloseWindow

◆ m_sigDoubleclick

◆ m_sigDrag

◆ m_sigFrame

◆ m_sigKeydown

◆ m_sigKeyup

◆ m_sigMove

◆ m_sigPenOrientation

◆ m_sigPenPressure

◆ m_sigPenProximityEnter

◆ m_sigPenProximityLeave

◆ m_sigPush

◆ m_sigQuitApplication

◆ m_sigRelease

◆ m_sigResize

◆ m_sigScroll

◆ m_sigUser

◆ m_widget