class GmTextWidget

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

Inheritance:


Public Methods

[more] GmTextWidget ()
Standard constructor
[more]void getGlExtents (float& width, float& height)
Gets the ideal extents of the text widget in OpenGL units.
[more]void getOffset (float& xOffset, float& yOffset)
Gets the X and Y offset for the final drawn text.
[more]virtual char* getText ()
Gets the text that is currently associated with this widget
[more]GlmColor4* getTextColor ()
Gets the text color that is currently assigned to the text.
[more]void getTextJustification (GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical)
Gets the type of justification for the text in this widget.
[more]float getTextPointSize ()
Gets the size of the text in points.
[more]void setOffset (float xOffset, float yOffset)
Sets an X and Y offset for the final drawn text.
[more]virtual void setText (char* text)
Sets the text of this text widget to the given text.
[more]void setTextColor (GlmColor4* color)
Sets the display color of the text.
[more]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.
[more]void setTextJustification (GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical)
Sets the horizontal and vertical text justification for the widget text.
[more]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.
[more]virtual ~GmTextWidget ()
Virtual destructor

Protected Fields

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


Inherited from GmInteractiveWidget:

Public Fields

oGmFocusEventHandler* focusEventHandler
oGmKeyEventHandler* keyEventHandler
oGmAnimation* mFocusGainAnim
oGmAnimation* mFocusLoseAnim
oGmTypes::FocusType mFocusState
ounsigned int mFocusTimestamp
oGmAnimation* mKeyPressAnim
oGmAnimation* mKeyReleaseAnim
oGmAnimation* mMouseExitAnim
oGmAnimation* mMouseOverAnim
oGmAnimation* mMousePressAnim
oGmAnimation* mMouseReleaseAnim
oWidgetIDType mWidgetId
oGmToolTip* mWidgetToolTip
oGmMouseEventHandler* mouseEventHandler
oGmUserEventHandler* userEventHandler
oGmWidgetEventHandler* widgetEventHandler

Public Methods

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

Protected Methods

ovirtual void render2dToolTip(GmTypes::RenderOptionType renderOptions)


Inherited from GmAnimatedWidget:

Public Methods

ovirtual void animationFinished(GmTypes::AnimationType animationType)
ovirtual void applyAnimationTransforms()
ovirtual void setEventAnimation(GmTypes::AnimationType animType, GmAnimation* animation)

Protected Fields

oGmAnimation* mAppearAnimation
oGmTypes::AnimationType mCurrentAnimation
oGmAnimation* mIdleAnimation
oGmAnimation* mVanishAnimation


Inherited from GmDrawable:

Public Methods

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

Protected Fields

oGlmColor4 mBaseColor
oGmTypes::CoordinateType mCoordType
ofloat mDepth
obool mDisplayListGenerate
oint mDisplayListId
ofloat mGlDepth
ofloat mGlHeight
oGlmPoint3 mGlPosition
ofloat mGlWidth
ofloat mHeight
oGlmPoint3 mPosition
obool mVisible
ofloat mWidth

Protected Methods

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


Inherited from GmObject:

Public Methods

ounsigned short getObjectId()

Protected Fields

oThe 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.
ochar* mText
The text string that this widget should display

oOGLFT::Face* mFontFace
The font face to use when rendering the text for this button

oGlmColor4 mTextColor
The foreground color to use when drawing the text

ofloat mTextPointSize
The point size to use when drawing the text

oGmTypes::JustificationType mTextHJustification
The horizontal justification to use when drawing the text

oGmTypes::JustificationType mTextVJustification
The vertical justification to use when drawing the text

ofloat mXOffset
Allows a subclass to offset the final drawn x position

ofloat mYOffset
Allows a subclass to offset the final drawn y position

o GmTextWidget()
Standard constructor

ovirtual ~GmTextWidget()
Virtual destructor

ovirtual 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

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

ovoid setTextColor(GlmColor4* color)
Sets the display color of the text.

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

ovoid 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

oGlmColor4* 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!

ovoid 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

ofloat getTextPointSize()
Gets the size of the text in points.

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

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

ovoid 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

ovoid 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

ovoid 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

ovoid 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++.