class GmInteractiveWidget

The interactive widget class is the base class for all widgets that will interact with the user

Inheritance:

Public Fields
Public Methods
Protected Methods

Inherited from GmAnimatedWidget:

Public Methods
virtual void animationFinished(GmTypes::AnimationType animationType)
virtual void applyAnimationTransforms()
virtual void setEventAnimation(GmTypes::AnimationType animType, GmAnimation* animation)

Protected Fields
GmAnimation* mAppearAnimation
GmTypes::AnimationType mCurrentAnimation
GmAnimation* mIdleAnimation
GmAnimation* mVanishAnimation

Inherited from GmDrawable:

Public Methods
virtual void applyLayout(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)
virtual GlmColor4* getBaseColor()
virtual GmTypes::CoordinateType getCoordType()
virtual float getDepth()
virtual float getGlDepth()
virtual void getGlExtents(float& width, float& height)
virtual float getGlHeight()
virtual GlmPoint3* getGlPosition()
virtual float getGlWidth()
virtual float getHeight()
virtual void getMinimumGeometry(float& width, float& height, float& depth)
virtual GlmPoint3* getPosition()
virtual bool getVisible()
virtual float getWidth()
virtual void render(GmTypes::RenderOptionType renderOptions)
virtual void setAbsoluteGeometry(float x, float y, float z, float width, float height, float depth)
virtual void setBaseColor(GlmColor4* color)
virtual void setBaseColor(float r, float g, float b, float a)
virtual void setCoordType(GmTypes::CoordinateType coordType)
virtual void setDepth(float depth)
virtual void setHeight(float height)
virtual void setPosition(GlmPoint3* point)
virtual void setPosition(float x, float y, float z)
virtual void setRelativeGeometry(float x, float y, float width, float height)
virtual void setRelativeGeometry(float x, float y, float z, float width, float height, float depth)
virtual void setVisible(bool visible)
virtual void setWidth(float width)

Protected Fields
GlmColor4 mBaseColor
GmTypes::CoordinateType mCoordType
float mDepth
bool mDisplayListGenerate
int mDisplayListId
float mGlDepth
float mGlHeight
GlmPoint3 mGlPosition
float mGlWidth
float mHeight
GlmPoint3 mPosition
bool mVisible
float mWidth

Protected Methods
virtual bool getDisplayListGenerate()
virtual int getDisplayListId()
virtual void render2d(GmTypes::RenderOptionType renderOptions)
virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)
virtual void setDisplayListGenerate(bool generate)
virtual void setDisplayListId(int id)

Inherited from GmObject:

Public Methods
unsigned short getObjectId()

Protected Fields
The object ID is used to uniquely identify each GmObject unsigned short mObjectId

Inherited from GmAnimationEventHandler:

Documentation

The interactive widget class is the base class for all widgets that will interact with the user

GmAnimation* mMouseOverAnim

Description

GmAnimation* mMouseExitAnim

Description

GmAnimation* mMousePressAnim

The animation that is played whenever the mouse is pressed on this interactive widget

GmAnimation* mMouseReleaseAnim

Description

GmAnimation* mKeyPressAnim

Description

GmAnimation* mKeyReleaseAnim

Description

GmAnimation* mFocusGainAnim

Description

GmAnimation* mFocusLoseAnim

Description

GmMouseEventHandler* mouseEventHandler

The mouse event handler processes all mouse events

GmKeyEventHandler* keyEventHandler

The key event handler processes all keyboard events

GmFocusEventHandler* focusEventHandler

The focus event handler processes all focus events

GmWidgetEventHandler* widgetEventHandler

The widget event handler processes all widget events

GmUserEventHandler* userEventHandler

The user event handler processes all user-defined events

WidgetIDType mWidgetId

The widget ID to use as this widget's unique identifier. This widget ID is used by the various event handlers for the widget to figure out which action to execute.

GmTypes::FocusType mFocusState

The focus state of this interactive widget

unsigned int mFocusTimestamp

The time at which the last focus occurred. This value is used to determine if a tooltip should be shown.

GmToolTip* mWidgetToolTip

The tooltip that is associated with this interactive widget

GmInteractiveWidget()

Standard constructor

virtual ~GmInteractiveWidget()

Virtual destructor

virtual void setToolTip(GmToolTip* tooltip)

Sets the widget tool tip for this interactive widget. If a user input device hovers over the interactive widget for more than a specified amount of time, a textual help message appears above the interactive widget.


Parameters:: tooltip - the tooltip widget to use as this items tooltip

virtual void setMouseEventHandler(GmMouseEventHandler* mouseHandler, WidgetIDType widgetId)

Sets the mouse event handler for this widget.


Parameters:: mouseHandler - the mouse handler that will be responsible for processing all mouse events sent to this widget.
widgetId - the widget ID uniquely identifies the widget so that the handler can perform the proper action for the widget.

virtual void setKeyEventHandler(GmKeyEventHandler* keyHandler, WidgetIDType widgetId)

Sets the key event handler for this widget.


Parameters:: keyHandler - the key handler that will be responsible for processing all key events sent to this widget.
widgetId - the widget ID uniquely identifies the widget so that the handler can perform the proper action for the widget.

virtual void setFocusEventHandler(GmFocusEventHandler* focusHandler, WidgetIDType widgetId)

Sets the focus event handler for this widget.


Parameters:: focusHandler - the focus handler that will be responsible for processing all focus events sent to this widget.
widgetId - the widget ID uniquely identifies the widget so that the handler can perform the proper action for the widget.

virtual void setWidgetEventHandler(GmWidgetEventHandler* widgetHandler, WidgetIDType widgetId)

Sets the widget event handler for this widget.


Parameters:: widgetHandler - the widget handler that will be responsible for processing all widget events sent to this widget.
widgetId - the widget ID uniquely identifies the widget so that the handler can perform the proper action for the widget.

virtual void setUserEventHandler(GmUserEventHandler* userHandler, WidgetIDType widgetId)

Sets the user event handler for this widget.


Parameters:: userHandler - the user handler that will be responsible for processing all user events sent to this widget.
widgetId - the widget ID uniquely identifies the widget so that the handler can perform the proper action for the widget.

virtual WidgetIDType getWidgetId()

Gets the widget ID associated with this interactive widget.


Returns:: the widget ID that is associated with this widget

virtual void mousePressEvent(GmEvent* event)

Description

virtual void mouseReleaseEvent(GmEvent* event)

Description

virtual void mouseMoveEvent(GmEvent* event)

Description

virtual void mouseDragEvent(GmEvent* event)

Event processing function to process a mouse drag event.


Parameters:: event - the mouse drag event for this object to process

virtual void wheelMoveEvent(GmEvent* event)

Description

virtual void keyPressEvent(GmEvent* event)

Description

virtual void keyReleaseEvent(GmEvent* event)

Description

virtual void focusGainEvent(GmEvent* event)

Description

virtual void focusLoseEvent(GmEvent* event)

Description

virtual void userEvent(GmEvent* event)

Description

virtual void render2dToolTip(GmTypes::RenderOptionType renderOptions)

This is a convenience method to render a tooltip if the given tooltip pop-up time has occurred

Direct child classes:: GmTextWidget
GmSpinBox
GmRangeWidget
GmHyperlink
GmExpandableListItem
GmContainer
GmButton

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.

	GmInteractiveWidget () Standard constructor
virtual void	focusGainEvent (GmEvent* event) Description
virtual void	focusLoseEvent (GmEvent* event) Description
virtual WidgetIDType	getWidgetId () Gets the widget ID associated with this interactive widget.
virtual void	keyPressEvent (GmEvent* event) Description
virtual void	keyReleaseEvent (GmEvent* event) Description
virtual void	mouseDragEvent (GmEvent* event) Event processing function to process a mouse drag event.
virtual void	mouseMoveEvent (GmEvent* event) Description
virtual void	mousePressEvent (GmEvent* event) Description
virtual void	mouseReleaseEvent (GmEvent* event) Description
virtual void	setFocusEventHandler (GmFocusEventHandler* focusHandler, WidgetIDType widgetId) Sets the focus event handler for this widget.
virtual void	setKeyEventHandler (GmKeyEventHandler* keyHandler, WidgetIDType widgetId) Sets the key event handler for this widget.
virtual void	setMouseEventHandler (GmMouseEventHandler* mouseHandler, WidgetIDType widgetId) Sets the mouse event handler for this widget.
virtual void	setToolTip (GmToolTip* tooltip) Sets the widget tool tip for this interactive widget.
virtual void	setUserEventHandler (GmUserEventHandler* userHandler, WidgetIDType widgetId) Sets the user event handler for this widget.
virtual void	setWidgetEventHandler (GmWidgetEventHandler* widgetHandler, WidgetIDType widgetId) Sets the widget event handler for this widget.
virtual void	userEvent (GmEvent* event) Description
virtual void	wheelMoveEvent (GmEvent* event) Description
virtual	~GmInteractiveWidget () Virtual destructor

GmFocusEventHandler*	focusEventHandler The focus event handler processes all focus events
GmKeyEventHandler*	keyEventHandler The key event handler processes all keyboard events
GmAnimation*	mFocusGainAnim Description
GmAnimation*	mFocusLoseAnim Description
GmTypes::FocusType	mFocusState The focus state of this interactive widget
unsigned int	mFocusTimestamp The time at which the last focus occurred.
GmAnimation*	mKeyPressAnim Description
GmAnimation*	mKeyReleaseAnim Description
GmAnimation*	mMouseExitAnim Description
GmAnimation*	mMouseOverAnim Description
GmAnimation*	mMousePressAnim The animation that is played whenever the mouse is pressed on this interactive widget
GmAnimation*	mMouseReleaseAnim Description
WidgetIDType	mWidgetId The widget ID to use as this widget's unique identifier.
GmToolTip*	mWidgetToolTip The tooltip that is associated with this interactive widget
GmMouseEventHandler*	mouseEventHandler The mouse event handler processes all mouse events
GmUserEventHandler*	userEventHandler The user event handler processes all user-defined events
GmWidgetEventHandler*	widgetEventHandler The widget event handler processes all widget events