A class that implements a text search field with a button to clear its contents. More...

#include <omGraphicsGUISearchField.h>

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

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

Public Member Functions
	SearchField ()
	Create a new search field with value 0 and positioned at the origin of its coordinate system. More...

	SearchField (const Rectangle &newRectangle)
	Create a new search field which occupies the specified rectangular region with value 0. More...

	SearchField (const Rectangle &newRectangle, Double newValue)
	Create a new search field which places the specified number value within the given rectangle. More...

virtual Bool	setSize (const Vector3f &newSize)
	Set the 3D size of this search field along each of its local axes. More...

const UTF8String &	getText () const
	Return a reference to a string containing the text contents of this search field. More...

void	setText (const UTF8String &newText)
	Set the text contents of this search field as a string. More...

const fonts::TextStyle &	getTextStyle () const
	Return a reference to the text style that is used to render the text for a search field. More...

void	setTextStyle (const fonts::TextStyle &newTextStyle)
	Set the text style that is used to render the text for a search field. More...

Float	getTextSize () const
	Return the nominal font size of the text in this search field. More...

void	setTextSize (Float newFontSize)
	Set the nominal font size of the text in this search field. More...

Font *	getFont () const
	Return a pointer to the font to use in this search field. More...

Bool	setFont (Font *newFont)
	Set the font to use in this search field. More...

const TextLayout &	getTextLayout () const
	Return the font layout used for this search field. More...

void	setTextLayout (const TextLayout &newTextLayout)
	Set the font layout used for this search field. More...

const Origin &	getTextAlignment () const
	Return an object that describes how this search field's text is aligned. More...

void	setTextAlignment (const Origin &newTextAlignment)
	Set an object that describes how this search field's text is aligned. More...

void	setTextAlignment (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
	Set an object that describes how this search field's text is aligned. More...

const TextFlags &	getTextFlags () const
	Return boolean flags used to configure this search field's text style. More...

void	setTextFlags (const TextFlags &newTextFlags)
	set boolean flags used to configure this search 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 search field. More...

Bool	textFlagIsSet (TextFlags::Flag flag) const
	Return whether or not the specified boolan text flag is set for this search field. More...

const Color4f &	getTextColor () const
	Return the text color for a search field. More...

void	setTextColor (const Color4f &newTextColor)
	Set the text color for a search field. More...

const TextField &	getTextField () const
	Return a reference to the underlying search field for this search field that handles text display. More...

const Button &	getClearButton () const
	Return a reference to the button that allows the user to quickly clear the search contents. More...

virtual Bool	setBorder (const Border &newBorder)
	Set an object that describes this search field's border. More...

virtual Bool	setBorderColor (const Color4f &newBorderColor)
	Set the border color for a search field. More...

virtual Bool	setBackgroundColor (const Color4f &newBackgroundColor)
	Set the background color for this search field's text area. More...

const Color4f &	getSelectionColor () const
	Return the selection color for a search field. More...

void	setSelectionColor (const Color4f &newSelectionColor)
	Set the selection color for a search field. More...

const Color4f &	getFocusColor () const
	Return the focus color for a search field. More...

void	setFocusColor (const Color4f &newFocusColor)
	Set the focus color for a search field. More...

virtual Bool	setFocus (Bool newHasFocus)
	Set whether or not this search field currently has keyboard focus at its level in the GUI hierarchy. More...

Bool	getIsEnabled () const
	Return whether or not this search field is currently active. More...

void	setIsEnabled (Bool newIsEnabled)
	Set whether or not this search field is currently active. More...

virtual Bool	guiEvent (const GUIEvent &event)
	Handle the specified GUI event that occured when this search 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...

Delegate &	getDelegate ()
	Return a reference to the delegate which responds to events for this search field. More...

const Delegate &	getDelegate () const
	Return a reference to the delegate which responds to events for this search field. More...

void	setDelegate (const Delegate &newDelegate)
	Return a reference to the delegate which responds to events for this search field. More...

virtual void	update (Float dt)
	Update the current internal state of this object for the specified time interval in seconds. 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...

virtual Bool	resizeForContent ()
	Resize this object to fit tightly around its contents, if possible. 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...

const Color4f &	getBorderColor () const
	Return 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...

Public Member Functions inherited from om::gui::input::InputHandler
virtual	~InputHandler ()
	Destroy an input handler. More...

Detailed Description

A class that implements a text search field with a button to clear its contents.

Constructor & Destructor Documentation

om::graphics::gui::objects::SearchField::SearchField ( )

Create a new search field with value 0 and positioned at the origin of its coordinate system.

om::graphics::gui::objects::SearchField::SearchField ( const Rectangle & newRectangle )

Create a new search field which occupies the specified rectangular region with value 0.

om::graphics::gui::objects::SearchField::SearchField	(	const Rectangle &	newRectangle,
		Double	newValue
	)

Create a new search field which places the specified number value within the given rectangle.

Member Function Documentation

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

virtual

Set the 3D size of this search field along each of its local axes.

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

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

inline

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

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

inline

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

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

inline

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

void om::graphics::gui::objects::SearchField::setTextStyle ( const fonts::TextStyle & newTextStyle )

inline

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

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

inline

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

void om::graphics::gui::objects::SearchField::setTextSize ( Float newFontSize )

inline

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

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

inline

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

Bool om::graphics::gui::objects::SearchField::setFont ( Font * newFont )

inline

Set the font to use in this search field.

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

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

inline

Return the font layout used for this search field.

void om::graphics::gui::objects::SearchField::setTextLayout ( const TextLayout & newTextLayout )

inline

Set the font layout used for this search field.

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

inline

Return an object that describes how this search field's text is aligned.

void om::graphics::gui::objects::SearchField::setTextAlignment ( const Origin & newTextAlignment )

inline

Set an object that describes how this search field's text is aligned.

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

inline

Set an object that describes how this search field's text is aligned.

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

inline

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

void om::graphics::gui::objects::SearchField::setTextFlags ( const TextFlags & newTextFlags )

inline

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

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

inline

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

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

inline

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

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

inline

Return the text color for a search field.

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

inline

Set the text color for a search field.

const TextField& om::graphics::gui::objects::SearchField::getTextField ( ) const

inline

Return a reference to the underlying search field for this search field that handles text display.

const Button& om::graphics::gui::objects::SearchField::getClearButton ( ) const

inline

Return a reference to the button that allows the user to quickly clear the search contents.

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

virtual

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

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

virtual Bool om::graphics::gui::objects::SearchField::setBorderColor ( const Color4f & newBorderColor )

virtual

Set the border color for a search field.

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

virtual Bool om::graphics::gui::objects::SearchField::setBackgroundColor ( const Color4f & newBackgroundColor )

virtual

Set the background color for this search field's text area.

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

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

inline

Return the selection color for a search field.

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

inline

Set the selection color for a search field.

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

inline

Return the focus color for a search field.

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

inline

Set the focus color for a search field.

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

virtual

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

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

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

inline

Return whether or not this search field is currently active.

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

inline

Set whether or not this search field is currently active.

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

virtual

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

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

virtual Bool om::graphics::gui::objects::SearchField::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::SearchField::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::SearchField::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::SearchField::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::SearchField::mouseWheelEvent ( const MouseWheelEvent & event )

virtual

Handle the specified mouse wheel event that occurred.

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

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

inline

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

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

inline

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

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

inline

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

virtual void om::graphics::gui::objects::SearchField::update ( Float dt )

virtual

Update the current internal state of this object for the specified time interval in seconds.

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

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

virtual

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

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

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

omGraphicsGUISearchField.h

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation