om::graphics::gui::objects::TextField Class Reference

A class that represents a simple editable text area with a single text style. More...

#include <omGraphicsGUITextField.h>

Inheritance diagram for om::graphics::gui::objects::TextField:

Classes
class	Delegate
	A class that contains function objects that recieve text field events. More...

Public Member Functions
	TextField ()
	Create a new text field with no text content and positioned at the origin of its coordinate system. More...
	TextField (const Rectangle &newRectangle)
	Create a new text field which occupies the specified rectangular region with no text contents. More...
	TextField (const Rectangle &newRectangle, const UTF8String &newText)
	Create a new text field which places the specified text content within the given rectangle. More...
virtual Bool	setSize (const Vector3f &newSize)
	Set the 3D size of the text view along each of its local axes. More...
virtual Bool	resizeForContent ()
	Resize this text field to fit tightly around its contents. More...
const UTF8String &	getText () const
	Return a reference to a string containing the text contents of this text field. More...
virtual void	setText (const UTF8String &newText)
	Set the text contents of this text field as a string. More...
Bool	getIsEnabled () const
	Return whether or not this text field is currently enabled. More...
void	setIsEnabled (Bool newIsEnabled)
	Set whether or not this number field is currently enabled. More...
Bool	getIsEditable () const
	Return whether or not the text in this text field is selectable by the user. More...
void	setIsEditable (Bool newIsEditable)
	Set whether or not the text in this text field is editable by the user. More...
Bool	getIsEditSafe () const
	Return whether or not this text field's text requires a double click to be edited. More...
void	setIsEditSafe (Bool newIsEditSafe)
	Set whether or not this text field's text requires a double click to be edited. More...
Bool	getIsEditing () const
	Return whether or not the text in this text field is currently being edited by the user. More...
void	startEditing ()
	Start editing the contents of this text field. More...
void	endEditing ()
	Finish editing the contents of this text field and attempt to save the edit. More...
void	abortEditing ()
	Abort editing the contents of this text field and restore the previous text. More...
Bool	getIsSelectable () const
	Return whether or not the text in this text field is selectable by the user. More...
void	setIsSelectable (Bool newIsSelectable)
	Set whether or not the text in this text field is selectable by the user. More...
const AABB1D< Index > &	getSelection () const
	Return the range of selected character indices in the text field. More...
void	setSelection (const AABB1D< Index > &newSelection)
	Set the range of selected character indices in the text field. More...
void	setSelection (Index selectionMin, Index selectionMax)
	Set the range of selected character indices in the text field. More...
void	selectAll ()
	Select the entire contents of this text field. More...
void	selectNone ()
	Deselect the current text field selection. More...
const fonts::TextStyle &	getTextStyle () const
	Return a reference to the text style that is used to render the text for a text field. More...
void	setTextStyle (const fonts::TextStyle &newTextStyle)
	Set the text style that is used to render the text for a text field. More...
Float	getTextSize () const
	Return the nominal font size of the text in this text field. More...
void	setTextSize (Float newFontSize)
	Set the nominal font size of the text in this text field. More...
Font *	getFont () const
	Return a pointer to the font to use in this text field. More...
Bool	setFont (Font *newFont)
	Set the font to use in this text field. More...
const Origin &	getTextAlignment () const
	Return an object that describes how this text field's text is aligned within its content area. More...
void	setTextAlignment (const Origin &newTextAlignment)
	Set an object that describes how this text field's text is aligned within its content area. More...
void	setTextAlignment (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
	Set an object that describes how this text field's text is aligned within its content area. More...
const TextLayout &	getTextLayout () const
	Return the font layout used for this text field. More...
void	setTextLayout (const TextLayout &newTextLayout)
	Set the font layout used for this text field. More...
const TextFlags &	getTextFlags () const
	Return boolean flags used to configure this text field's text style. More...
void	setTextFlags (const TextFlags &newTextFlags)
	set boolean flags used to configure this text field's text style. More...
void	setTextFlag (TextFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan text flag is set for this text field. More...
Bool	textFlagIsSet (TextFlags::Flag flag) const
	Return whether or not the specified boolan text flag is set for this text field. More...
const GlyphLayout &	getGlyphLayout () const
	Return an object indicating the arrangement of character glyphs within the text field. More...
const Color4f &	getTextColor () const
	Return the text color for a text field. More...
void	setTextColor (const Color4f &newTextColor)
	Set the text color for a text field. More...
virtual Bool	setBorder (const Border &newBorder)
	Set an object that describes this text field's border. More...
const Color4f &	getSelectionColor () const
	Return the selection color for a text field. More...
void	setSelectionColor (const Color4f &newSelectionColor)
	Set the selection color for a text field. More...
const Color4f &	getFocusColor () const
	Return the focus color for a text field. More...
void	setFocusColor (const Color4f &newFocusColor)
	Set the focus color for a text field. More...
virtual Bool	setFocus (Bool newHasFocus)
	Set whether or not this text field currently has keyboard focus at its level in the GUI hierarchy. More...
Delegate &	getDelegate ()
	Return a reference to the delegate which responds to events for this text field. More...
const Delegate &	getDelegate () const
	Return a reference to the delegate which responds to events for this text field. More...
void	setDelegate (const Delegate &newDelegate)
	Return a reference to the delegate which responds to events for this text field. More...
virtual Bool	guiEvent (const GUIEvent &event)
	Handle the specified GUI event that occured when this text field had focus. More...
virtual Bool	textEvent (const TextEvent &text)
	Handle the specified text input event that occured when this object had focus. More...
virtual Bool	keyEvent (const KeyEvent &event)
	Handle the specified keyboard event that occured when this object had focus. More...
virtual Bool	mouseMotionEvent (const MouseMotionEvent &event)
	Handle the specified mouse motion event that occurred. More...
virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Handle the specified mouse button event that occurred. More...
virtual Bool	mouseWheelEvent (const MouseWheelEvent &event)
	Handle the specified mouse wheel event that occurred. More...
virtual Bool	drawSelf (GUIRenderer &renderer, const AABB3f &parentBounds) const
	Draw this object using the specified GUI renderer to the given parent coordinate system bounds. More...
Public Member Functions inherited from om::graphics::gui::objects::GUIObject
	GUIObject ()
	Create a default visible GUI object positioned at the origin (0,0) with 0 width and 0 height. More...
	GUIObject (const RectangleStyle &newRectangleStyle)
	Create a visible GUI object positioned at the origin (0,0) with 0 width and 0 height and the given rectangle style. More...
	GUIObject (const Rectangle &newRectangle)
	Create a visible GUI object that occupies the specified rectangle. More...
	GUIObject (const Rectangle &newRectangle, const RectangleStyle &newRectangleStyle)
	Create a visible GUI object that occupies the specified rectangle and rectangle style. More...
virtual	~GUIObject ()
	Destory the GUI object, releasing all internal resources. More...
const Rectangle &	getRectangle () const
	Return a reference to this GUI object's rectangle. More...
const Vector3f &	getSize () const
	Return a reference to the 3D size of this object along each of its local axes. More...
const Vector2f &	getSizeXY () const
	Return a reference to the 2D scaling factor of this object along each of its local axes. More...
Bool	setSize (const Vector2f &newSizeXY)
	Set the 2D size of this object along the X and Y local axes. More...
Bool	setSize (Float newWidth, Float newHeight)
	Set the 2D size of this object along the X and Y local axes. More...
Bool	setSizeX (Float newWidth)
	Set the size of this object along the X axis. More...
Bool	setSizeY (Float newHeight)
	Set the size of this object along the Y axis. More...
Bool	setSizeZ (Float newDepth)
	Set the size of this object along the Z axis. More...
void	fillParent (const Vector3f &parentSize)
	Resize and resposition this object so that it fills the specified parent bounding box size. More...
const Vector3f &	getScale () const
	Return a reference to the 3D scaling factor of this object along each of its local axes. More...
const Vector2f &	getScaleXY () const
	Return a reference to the 2D scaling factor of this object along each of its local axes. More...
virtual Bool	setScale (const Vector3f &newScale)
	Set the 3D scaling factor of this object along each of its local axes. More...
Bool	setScale (const Vector2f &newScaleXY)
	Set the 2D scaling factor of this object along the X and Y local axes. More...
Bool	setScale (Float newScaleX, Float newScaleY)
	Set the 2D scaling factor of this object along the X and Y local axes. More...
Bool	setScale (Float newScale)
	Set the scaling factor of this object along all 3 axes. More...
const Vector3f &	getPosition () const
	Return the position of this GUI object's origin relative to its parent's coordinate origin. More...
const Vector2f &	getPositionXY () const
	Return the 2D position of this GUI object's origin relative to its parent's coordinate origin. More...
Bool	setPosition (const Vector2f &newPosition)
	Set the position of this GUI object's origin relative to its parent's coordinate origin. More...
virtual Bool	setPosition (const Vector3f &newPosition)
	Set the position of this GUI object's origin relative to its parent's coordinate origin. More...
const Matrix3f &	getRotation () const
	Return a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame. More...
virtual Bool	setRotation (const Matrix3f &newRotation)
	Set a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame. More...
Bool	setRotation (Float radians)
	Set the rotation of this GUI object to be along the Z-axis with a rotation specified in radians. More...
Bool	setRotationDegrees (Float degrees)
	Set the rotation of this GUI object to be along the Z-axis with a rotation specified in degrees. More...
Origin &	getOrigin ()
	Return the alignment of the coordinate origin for this object. More...
const Origin &	getOrigin () const
	Return the alignment of the coordinate origin for this object. More...
virtual Bool	setOrigin (const Origin &newPositionOrigin)
	Set the alignment of the coordinate origin for this object. More...
void	setOrigin (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
	Set the XY alignment of the coordinate origin for this object. More...
void	setOrigin (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin, Origin::ZOrigin newZOrigin)
	Set the XYZ alignment of the coordinate origin for this object. More...
AABB2f	getBoundsInParent (const AABB2f &parentBounds) const
	Return the 2D bounding box of this object in the coordinate frame of the specified parent bounding box. More...
AABB3f	getBoundsInParent (const AABB3f &parentBounds) const
	Return the 3D bounding box of this object in the coordinate frame of the specified parent bounding box. More...
AABB2f	getLocalBoundsXY () const
	Return the 2D bounding box of this object in its local coordinate frame. More...
AABB3f	getLocalBounds () const
	Return the 3D bounding box of this object in its local coordinate frame. More...
Vector2f	getLocalCenterXY () const
	Return the 2D center of this object's rectangle in its local coordinate frame. More...
Vector3f	getLocalCenter () const
	Return the 3D center of this object's rectangle in its local coordinate frame. More...
Matrix4f	getTransformMatrix (const AABB3f &parentBounds) const
	Return the object-space-to-parent-space homogeneous transformation matrix for the given parent bounding box. More...
Vector2f	transformToLocal (const Vector2f &pointInParent, const AABB2f &parentBounds) const
	Transform a 3D point in the parent coordinate system into this object's coordinate system. More...
Vector3f	transformToLocal (const Vector3f &pointInParent, const AABB3f &parentBounds) const
	Transform a 3D point in the parent coordinate system into this object's coordinate system. More...
Vector2f	transformFromLocal (const Vector2f &localPoint, const AABB2f &parentBounds) const
	Transform a 2D point in this object's local coordinate system into its parent's coordinate system. More...
Vector3f	transformFromLocal (const Vector3f &localPoint, const AABB3f &parentBounds) const
	Transform a 3D point in this object's local coordinate system into its parent's coordinate system. More...
Vector2f	transformVectorToLocal (const Vector2f &vectorInParent) const
	Transform a 3D vector in the parent coordinate system into this object's coordinate system. More...
Vector3f	transformVectorToLocal (const Vector3f &vectorInParent) const
	Transform a 3D vector in the parent coordinate system into this object's coordinate system. More...
Vector2f	transformVectorFromLocal (const Vector2f &localVector) const
	Transform a 2D vector in this object's local coordinate system into its parent's coordinate system. More...
Vector3f	transformVectorFromLocal (const Vector3f &localVector) const
	Transform a 3D vector in this object's local coordinate system into its parent's coordinate system. More...
MouseButtonEvent	transformEventToLocal (const MouseButtonEvent &event, const AABB2f &parentBounds) const
	Transform a mouse button event in the parent coordinate system into this object's coordinate system. More...
MouseButtonEvent	transformEventFromLocal (const MouseButtonEvent &event, const AABB2f &parentBounds) const
	Transform a mouse button event in this object's local coordinate system into its parent's coordinate system. More...
MouseMotionEvent	transformEventToLocal (const MouseMotionEvent &event, const AABB2f &parentBounds) const
	Transform a mouse motion event in the parent coordinate system into this object's coordinate system. More...
MouseMotionEvent	transformEventFromLocal (const MouseMotionEvent &event, const AABB2f &parentBounds) const
	Transform a mouse motion event in this object's local coordinate system into its parent's coordinate system. More...
MouseWheelEvent	transformEventToLocal (const MouseWheelEvent &event, const AABB2f &parentBounds) const
	Transform a mouse wheel event in the parent coordinate system into this object's coordinate system. More...
MouseWheelEvent	transformEventFromLocal (const MouseWheelEvent &event, const AABB2f &parentBounds) const
	Transform a mouse wheel event in this object's local coordinate system into its parent's coordinate system. More...
virtual Bool	containsLocalPoint (const Vector2f &localPoint) const
	Return whether or not this GUI object contains the specified local 2D point within its local bounds. More...
virtual Bool	containsLocalPoint (const Vector3f &localPoint) const
	Return whether or not this GUI object contains the specified local 3D point within its local bounds. More...
AABB2f	getLocalContentBoundsXY () const
	Return the 2D bounding box for the object's rectangle inside area in its local coordinate frame. More...
virtual AABB3f	getLocalContentBounds () const
	Return the 3D bounding box for the object's rectangle inside area in its local coordinate frame. More...
GUIStyle *	getStyle () const
	Return a pointer to the style object to use when drawing this GUI object. More...
void	setStyle (GUIStyle *newStyle)
	Set a pointer to the style object to use when drawing this GUI object. More...
const RectangleStyle &	getRectangleStyle () const
	Return an object that describes the style of the main outside rectangle of this object. More...
virtual Bool	setRectangleStyle (const RectangleStyle &newRectangleStyle)
	Set an object that describes the style of the main outside rectangle of this object. More...
const Border &	getBorder () const
	Return an object that describes the border for this object's main rectangle. More...
Float	getBorderWidth () const
	Return the width of this object's main rectangle border. More...
Bool	setBorderWidth (Float newWidth)
	Set the width of this object's main rectangle border. More...
Float	getBorderRadius () const
	Return the corner radius of this object's main rectangle border. More...
Bool	setBorderRadius (Float newRadius)
	Set the corner radius of this object's main rectangle border. More...
const Margin &	getBorderMargin () const
	Return an object that describes the padding between the exterior and interior of the object's main rectangle. More...
Bool	setBorderMargin (const Margin &newMargin)
	Set an object that describes the padding between the exterior and interior of the object's main rectangle. More...
const Color4f &	getBackgroundColor () const
	Return the background color for this object's main rectangle. More...
virtual Bool	setBackgroundColor (const Color4f &newBackgroundColor)
	Set the background color for this object's main rectangle. More...
const Color4f &	getBorderColor () const
	Return the border color used when rendering the object's main rectangle. More...
virtual Bool	setBorderColor (const Color4f &newBorderColor)
	Set the border color used when rendering the object's main rectangle. More...
const GUIObjectFlags &	getFlags () const
	Return a const reference to the flags for this GUI object. More...
Bool	flagIsSet (GUIObjectFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this GUI object. More...
virtual Bool	setFlags (const GUIObjectFlags &newFlags)
	Set the flags for this GUI object. More...
Bool	setFlag (GUIObjectFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this GUI object. More...
Bool	getIsVisible () const
	Return whether or not this GUI object should be drawn to the screen. More...
void	setIsVisible (Bool newIsVisible)
	Set whether or not this GUI object should be drawn to the screen. More...
Bool	hasFocus () const
	Return whether or not this GUI object currently has keyboard focus at its level in the GUI hierarchy. More...
virtual void	update (Float dt)
	Update the current internal state of this object for the specified time interval in seconds. More...
Public Member Functions inherited from om::gui::input::InputHandler
virtual	~InputHandler ()
	Destroy an input handler. More...

Static Public Attributes
static const Float	DEFAULT_TEXT_SIZE
	The default font size that is used for a text view's text. More...
static const Origin	DEFAULT_TEXT_ALIGNMENT
	The default alignment that is used for a text view's text within the content area. More...
static const Color4f	DEFAULT_TEXT_COLOR
	The default color that is used for a text field's text. More...
static const Border	DEFAULT_BORDER
	The default border that is used for a text field. More...
static const Color4f	DEFAULT_BORDER_COLOR
	The default border color that is used for a text field's area. More...
static const Color4f	DEFAULT_BACKGROUND_COLOR
	The default background color that is used for a text field's area. More...
static const Color4f	DEFAULT_SELECTION_COLOR
	The default color that is used to highlight a text field's selected text. More...
static const Color4f	DEFAULT_FOCUS_COLOR
	The default color that is used to highlight a text field's selected text. More...

Detailed Description

A class that represents a simple editable text area with a single text style.

Constructor & Destructor Documentation

om::graphics::gui::objects::TextField::TextField

(

)

Create a new text field with no text content and positioned at the origin of its coordinate system.

om::graphics::gui::objects::TextField::TextField

(

const Rectangle &

newRectangle

)

Create a new text field which occupies the specified rectangular region with no text contents.

om::graphics::gui::objects::TextField::TextField	(	const Rectangle &	newRectangle,
		const UTF8String &	newText
	)

Create a new text field which places the specified text content within the given rectangle.

Member Function Documentation

virtual Bool om::graphics::gui::objects::TextField::setSize ( const Vector3f &  newSize )

virtual

Set the 3D size of the text view along each of its local axes.

Reimplemented from om::graphics::gui::objects::GUIObject.

virtual Bool om::graphics::gui::objects::TextField::resizeForContent ( )

virtual

Resize this text field to fit tightly around its contents.

Reimplemented from om::graphics::gui::objects::GUIObject.

const UTF8String& om::graphics::gui::objects::TextField::getText ( ) const

inline

Return a reference to a string containing the text contents of this text field.

virtual void om::graphics::gui::objects::TextField::setText ( const UTF8String &  newText )

virtual

Set the text contents of this text field as a string.

This method is called whenever the text content of the text field is edited by the user. A subclass may override this method to validate or change the text that is accepted by the text field.

Bool om::graphics::gui::objects::TextField::getIsEnabled ( ) const

inline

Return whether or not this text field is currently enabled.

void om::graphics::gui::objects::TextField::setIsEnabled ( Bool  newIsEnabled )

inline

Set whether or not this number field is currently enabled.

Bool om::graphics::gui::objects::TextField::getIsEditable ( ) const

inline

Return whether or not the text in this text field is selectable by the user.

void om::graphics::gui::objects::TextField::setIsEditable ( Bool  newIsEditable )

inline

Set whether or not the text in this text field is editable by the user.

Bool om::graphics::gui::objects::TextField::getIsEditSafe ( ) const

inline

Return whether or not this text field's text requires a double click to be edited.

void om::graphics::gui::objects::TextField::setIsEditSafe ( Bool  newIsEditSafe )

inline

Set whether or not this text field's text requires a double click to be edited.

Bool om::graphics::gui::objects::TextField::getIsEditing ( ) const

inline

Return whether or not the text in this text field is currently being edited by the user.

void om::graphics::gui::objects::TextField::startEditing

(

)

Start editing the contents of this text field.

void om::graphics::gui::objects::TextField::endEditing

(

)

Finish editing the contents of this text field and attempt to save the edit.

void om::graphics::gui::objects::TextField::abortEditing

(

)

Abort editing the contents of this text field and restore the previous text.

Bool om::graphics::gui::objects::TextField::getIsSelectable ( ) const

inline

Return whether or not the text in this text field is selectable by the user.

void om::graphics::gui::objects::TextField::setIsSelectable ( Bool  newIsSelectable )

inline

Set whether or not the text in this text field is selectable by the user.

const AABB1D<Index>& om::graphics::gui::objects::TextField::getSelection ( ) const

inline

Return the range of selected character indices in the text field.

If the min and max are the same, then they indicate the current cursor position.

void om::graphics::gui::objects::TextField::setSelection ( const AABB1D< Index > &  newSelection )

inline

Set the range of selected character indices in the text field.

The new selection range is clamped to be within the valid range of character indices from the text field's text layout.

void om::graphics::gui::objects::TextField::setSelection ( Index  selectionMin, Index  selectionMax  )

inline

Set the range of selected character indices in the text field.

The new selection range is clamped to be within the valid range of character indices from the text field's text layout.

void om::graphics::gui::objects::TextField::selectAll ( )

inline

Select the entire contents of this text field.

void om::graphics::gui::objects::TextField::selectNone ( )

inline

Deselect the current text field selection.

const fonts::TextStyle& om::graphics::gui::objects::TextField::getTextStyle ( ) const

inline

Return a reference to the text style that is used to render the text for a text field.

void om::graphics::gui::objects::TextField::setTextStyle

(

const fonts::TextStyle &

newTextStyle

)

Set the text style that is used to render the text for a text field.

Float om::graphics::gui::objects::TextField::getTextSize ( ) const

inline

Return the nominal font size of the text in this text field.

void om::graphics::gui::objects::TextField::setTextSize

(

Float

newFontSize

)

Set the nominal font size of the text in this text field.

Font* om::graphics::gui::objects::TextField::getFont ( ) const

inline

Return a pointer to the font to use in this text field.

Bool om::graphics::gui::objects::TextField::setFont

(

Font *

newFont

)

Set the font to use in this text field.

The method returns whether or not the new font was able to be used.

const Origin& om::graphics::gui::objects::TextField::getTextAlignment ( ) const

inline

Return an object that describes how this text field's text is aligned within its content area.

void om::graphics::gui::objects::TextField::setTextAlignment

(

const Origin &

newTextAlignment

)

Set an object that describes how this text field's text is aligned within its content area.

void om::graphics::gui::objects::TextField::setTextAlignment ( Origin::XOrigin  newXOrigin, Origin::YOrigin  newYOrigin  )

inline

Set an object that describes how this text field's text is aligned within its content area.

const TextLayout& om::graphics::gui::objects::TextField::getTextLayout ( ) const

inline

Return the font layout used for this text field.

void om::graphics::gui::objects::TextField::setTextLayout

(

const TextLayout &

newTextLayout

)

Set the font layout used for this text field.

const TextFlags& om::graphics::gui::objects::TextField::getTextFlags ( ) const

inline

Return boolean flags used to configure this text field's text style.

void om::graphics::gui::objects::TextField::setTextFlags

(

const TextFlags &

newTextFlags

)

set boolean flags used to configure this text field's text style.

void om::graphics::gui::objects::TextField::setTextFlag	(	TextFlags::Flag	flag,
		Bool	newIsSet = true
	)

Set whether or not the specified boolan text flag is set for this text field.

Bool om::graphics::gui::objects::TextField::textFlagIsSet ( TextFlags::Flag  flag ) const

inline

Return whether or not the specified boolan text flag is set for this text field.

const GlyphLayout& om::graphics::gui::objects::TextField::getGlyphLayout ( ) const

inline

Return an object indicating the arrangement of character glyphs within the text field.

const Color4f& om::graphics::gui::objects::TextField::getTextColor ( ) const

inline

Return the text color for a text field.

void om::graphics::gui::objects::TextField::setTextColor ( const Color4f &  newTextColor )

inline

Set the text color for a text field.

virtual Bool om::graphics::gui::objects::TextField::setBorder ( const Border &  newBorder )

virtual

Set an object that describes this text field's border.

Reimplemented from om::graphics::gui::objects::GUIObject.

const Color4f& om::graphics::gui::objects::TextField::getSelectionColor ( ) const

inline

Return the selection color for a text field.

void om::graphics::gui::objects::TextField::setSelectionColor ( const Color4f &  newSelectionColor )

inline

Set the selection color for a text field.

const Color4f& om::graphics::gui::objects::TextField::getFocusColor ( ) const

inline

Return the focus color for a text field.

void om::graphics::gui::objects::TextField::setFocusColor ( const Color4f &  newFocusColor )

inline

Set the focus color for a text field.

virtual Bool om::graphics::gui::objects::TextField::setFocus ( Bool  newHasFocus )

virtual

Set whether or not this text field currently has keyboard focus at its level in the GUI hierarchy.

Reimplemented from om::graphics::gui::objects::GUIObject.

Delegate& om::graphics::gui::objects::TextField::getDelegate ( )

inline

Return a reference to the delegate which responds to events for this text field.

const Delegate& om::graphics::gui::objects::TextField::getDelegate ( ) const

inline

Return a reference to the delegate which responds to events for this text field.

void om::graphics::gui::objects::TextField::setDelegate ( const Delegate &  newDelegate )

inline

Return a reference to the delegate which responds to events for this text field.

virtual Bool om::graphics::gui::objects::TextField::guiEvent ( const GUIEvent &  event )

virtual

Handle the specified GUI event that occured when this text field had focus.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::TextField::textEvent ( const TextEvent &  text )

virtual

Handle the specified text input event that occured when this object had focus.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::TextField::keyEvent ( const KeyEvent &  event )

virtual

Handle the specified keyboard event that occured when this object had focus.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::TextField::mouseMotionEvent ( const MouseMotionEvent &  event )

virtual

Handle the specified mouse motion event that occurred.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::TextField::mouseButtonEvent ( const MouseButtonEvent &  event )

virtual

Handle the specified mouse button event that occurred.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::TextField::mouseWheelEvent ( const MouseWheelEvent &  event )

virtual

Handle the specified mouse wheel event that occurred.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::TextField::drawSelf ( GUIRenderer &  renderer, const AABB3f &  parentBounds  ) const

virtual

Draw this object using the specified GUI renderer to the given parent coordinate system bounds.

The method returns whether or not the object was successfully drawn.

The default implementation draws nothing and returns TRUE.

Reimplemented from om::graphics::gui::objects::GUIObject.

Member Data Documentation

const Float om::graphics::gui::objects::TextField::DEFAULT_TEXT_SIZE

static

The default font size that is used for a text view's text.

const Origin om::graphics::gui::objects::TextField::DEFAULT_TEXT_ALIGNMENT

static

The default alignment that is used for a text view's text within the content area.

const Color4f om::graphics::gui::objects::TextField::DEFAULT_TEXT_COLOR

static

The default color that is used for a text field's text.

const Border om::graphics::gui::objects::TextField::DEFAULT_BORDER

static

The default border that is used for a text field.

const Color4f om::graphics::gui::objects::TextField::DEFAULT_BORDER_COLOR

static

The default border color that is used for a text field's area.

const Color4f om::graphics::gui::objects::TextField::DEFAULT_BACKGROUND_COLOR

static

The default background color that is used for a text field's area.

const Color4f om::graphics::gui::objects::TextField::DEFAULT_SELECTION_COLOR

static

The default color that is used to highlight a text field's selected text.

const Color4f om::graphics::gui::objects::TextField::DEFAULT_FOCUS_COLOR

static

The default color that is used to highlight a text field's selected text.

---

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

• omGraphicsGUITextField.h