class GmTextWidget

A GmTextWidget object is used to display text to the screen in some form or another.

Inheritance:

Public Methods
Protected Fields

Inherited from GmInteractiveWidget:

Public Fields
GmFocusEventHandler* focusEventHandler
GmKeyEventHandler* keyEventHandler
GmAnimation* mFocusGainAnim
GmAnimation* mFocusLoseAnim
GmTypes::FocusType mFocusState
unsigned int mFocusTimestamp
GmAnimation* mKeyPressAnim
GmAnimation* mKeyReleaseAnim
GmAnimation* mMouseExitAnim
GmAnimation* mMouseOverAnim
GmAnimation* mMousePressAnim
GmAnimation* mMouseReleaseAnim
WidgetIDType mWidgetId
GmToolTip* mWidgetToolTip
GmMouseEventHandler* mouseEventHandler
GmUserEventHandler* userEventHandler
GmWidgetEventHandler* widgetEventHandler

Public Methods
virtual void focusGainEvent(GmEvent* event)
virtual void focusLoseEvent(GmEvent* event)
virtual WidgetIDType getWidgetId()
virtual void keyPressEvent(GmEvent* event)
virtual void keyReleaseEvent(GmEvent* event)
virtual void mouseDragEvent(GmEvent* event)
virtual void mouseMoveEvent(GmEvent* event)
virtual void mousePressEvent(GmEvent* event)
virtual void mouseReleaseEvent(GmEvent* event)
virtual void setFocusEventHandler(GmFocusEventHandler* focusHandler, WidgetIDType widgetId)
virtual void setKeyEventHandler(GmKeyEventHandler* keyHandler, WidgetIDType widgetId)
virtual void setMouseEventHandler(GmMouseEventHandler* mouseHandler, WidgetIDType widgetId)
virtual void setToolTip(GmToolTip* tooltip)
virtual void setUserEventHandler(GmUserEventHandler* userHandler, WidgetIDType widgetId)
virtual void setWidgetEventHandler(GmWidgetEventHandler* widgetHandler, WidgetIDType widgetId)
virtual void userEvent(GmEvent* event)
virtual void wheelMoveEvent(GmEvent* event)

Protected Methods
virtual void render2dToolTip(GmTypes::RenderOptionType renderOptions)

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 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

A GmTextWidget object is used to display text to the screen in some form or another. TextWidget objects could be buttons, menu items, text fields, text labels, etc.

char* mText

The text string that this widget should display

OGLFT::Face* mFontFace

The font face to use when rendering the text for this button

GlmColor4 mTextColor

The foreground color to use when drawing the text

float mTextPointSize

The point size to use when drawing the text

GmTypes::JustificationType mTextHJustification

The horizontal justification to use when drawing the text

GmTypes::JustificationType mTextVJustification

The vertical justification to use when drawing the text

float mXOffset

Allows a subclass to offset the final drawn x position

float mYOffset

Allows a subclass to offset the final drawn y position

GmTextWidget()

Standard constructor

virtual ~GmTextWidget()

Virtual destructor

virtual void setText(char* text)

Sets the text of this text widget to the given text.


Parameters:: text - the text to set this widget to display

virtual char* getText()

Gets the text that is currently associated with this widget


Returns:: s a pointer to the text that this widget is set to display. THIS IS A BORROWED POINTER, DO NOT DELETE IT!

void setTextColor(GlmColor4* color)

Sets the display color of the text.


Parameters:: color - the color to set the text color to

void setTextColor(float r, float g, float b, float a)

Sets the display color of the text to the given red, green, blue and alpha values.


Parameters:: r - the red component of the color
g - the green component of the color
b - the blue component of the color
a - the alpha component of the color

GlmColor4* getTextColor()

Gets the text color that is currently assigned to the text.


Returns:: the text color as a GlmColor4 object, THIS IS A BORROWED REFERENCE, DO NOT DELETE IT!

void setTextPointSize(float pointSize)

Sets the point size of the text, this will affect the size at which the font is rendered for the text string.


Parameters:: pointSize - the size of the text in points

float getTextPointSize()

Gets the size of the text in points.


Returns:: the point size of the text that is to be rendered by this widget.

void setTextJustification(GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical)

Sets the horizontal and vertical text justification for the widget text.


Parameters:: horizontal - the horizontal justification to use for the text widget.
vertical - the vertical justification to use for the text widget.

void getTextJustification(GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical)

Gets the type of justification for the text in this widget.


Parameters:: horizontal - the horizontal text justification for the widget
vertical - the vertical text justification for the widget

void setOffset(float xOffset, float yOffset)

Sets an X and Y offset for the final drawn text.


Parameters:: xOffset - the new X offset
yOffset - the new Y offset

void getOffset(float& xOffset, float& yOffset)

Gets the X and Y offset for the final drawn text.


Parameters:: xOffset - the X offset
yOffset - the Y offset

void getGlExtents(float& width, float& height)

Gets the ideal extents of the text widget in OpenGL units. This is sometimes used by parent containers to determine the optimal layout strategy by taking each components extents into account.


Parameters:: width - the width of the text widget in OpenGL units
height - the height of the text widget in OpenGL units

Direct child classes:: GmTextField
GmTextArea
GmMenuItem
GmLabel

Alphabetic index HTML hierarchy of classes or Java

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

	GmTextWidget () Standard constructor
void	getGlExtents (float& width, float& height) Gets the ideal extents of the text widget in OpenGL units.
void	getOffset (float& xOffset, float& yOffset) Gets the X and Y offset for the final drawn text.
virtual char*	getText () Gets the text that is currently associated with this widget
GlmColor4*	getTextColor () Gets the text color that is currently assigned to the text.
void	getTextJustification (GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical) Gets the type of justification for the text in this widget.
float	getTextPointSize () Gets the size of the text in points.
void	setOffset (float xOffset, float yOffset) Sets an X and Y offset for the final drawn text.
virtual void	setText (char* text) Sets the text of this text widget to the given text.
void	setTextColor (GlmColor4* color) Sets the display color of the text.
void	setTextColor (float r, float g, float b, float a) Sets the display color of the text to the given red, green, blue and alpha values.
void	setTextJustification (GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical) Sets the horizontal and vertical text justification for the widget text.
void	setTextPointSize (float pointSize) Sets the point size of the text, this will affect the size at which the font is rendered for the text string.
virtual	~GmTextWidget () Virtual destructor

OGLFT::Face*	mFontFace The font face to use when rendering the text for this button
char*	mText The text string that this widget should display
GlmColor4	mTextColor The foreground color to use when drawing the text
GmTypes::JustificationType	mTextHJustification The horizontal justification to use when drawing the text
float	mTextPointSize The point size to use when drawing the text
GmTypes::JustificationType	mTextVJustification The vertical justification to use when drawing the text
float	mXOffset Allows a subclass to offset the final drawn x position
float	mYOffset Allows a subclass to offset the final drawn y position