A class that represents a high-level GUI event that has occurred. More...

#include <omGUIInputGUIEvent.h>

Public Types
enum	Type { UNDEFINED = 0, UNDO, REDO, CLOSE, DUPLICATE, DELETE, PRINT, SELECT_ALL, SELECT_NONE }
	An enum that specifies the different kinds of borders. More...

Public Member Functions
	GUIEvent (Type newType)
	Create a GUI text event for the specified event type. More...

	GUIEvent (Type newType, const Time &newTime)
	Create a new GUI event for the specified type and event time. More...

Type	getType () const
	Return the type of this GUI event. More...

void	setType (Type newType)
	Set the type of this GUI event. More...

const Time &	getTime () const
	Return the absolute time since the epoch when the GUI event occurred. More...

void	setTime (const Time &newTime)
	Set the absolute time since the epoch when the GUI event occurred. More...

const Modifiers &	getModifiers () const
	Return the modifier flags that were set when the event occurred. More...

void	setModifiers (const Modifiers &newModifiers)
	Set the modifier flags that were set when the event occurred. More...

	operator const Type & () const
	Return the string contained in this GUI event. More...

Detailed Description

A class that represents a high-level GUI event that has occurred.

Member Enumeration Documentation

An enum that specifies the different kinds of borders.

Enumerator
UNDEFINED
UNDO	An event type indicating that the last user operation should be undone.
REDO	An event type indicating that the last undone user operation should be redone.
CLOSE	An event type indicating that the object that contains the current focus should be closed.
DUPLICATE	An event type indicating that the current selection should be duplicated.
DELETE	An event type indicating that the current selection should be deleted.
PRINT	An event type indicating that the current selection should be printed.
SELECT_ALL	An event type indicating that everything in the current focus should be selected.
SELECT_NONE	An event type indicating that everything in the current focus should be deselected.

om::gui::input::GUIEvent::GUIEvent ( Type newType )

inline

Create a GUI text event for the specified event type.

om::gui::input::GUIEvent::GUIEvent	(	Type	newType,
		const Time &	newTime
	)

inline

Create a new GUI event for the specified type and event time.

Type om::gui::input::GUIEvent::getType ( ) const

inline

Return the type of this GUI event.

void om::gui::input::GUIEvent::setType ( Type newType )

inline

Set the type of this GUI event.

const Time& om::gui::input::GUIEvent::getTime ( ) const

inline

Return the absolute time since the epoch when the GUI event occurred.

void om::gui::input::GUIEvent::setTime ( const Time & newTime )

inline

Set the absolute time since the epoch when the GUI event occurred.

const Modifiers& om::gui::input::GUIEvent::getModifiers ( ) const

inline

Return the modifier flags that were set when the event occurred.

void om::gui::input::GUIEvent::setModifiers ( const Modifiers & newModifiers )

inline

Set the modifier flags that were set when the event occurred.

om::gui::input::GUIEvent::operator const Type & ( ) const

inline

Return the string contained in this GUI event.

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