GUITextEntry Class Reference

Text entry gui element. More...

#include <GUI/GUITextEntry.h>

Inherits GUIPanel.

Inherited by GUINameTextEntry.

List of all members.

Public Member Functions

 GUITextEntry ()
 Constructor.
 GUITextEntry (GUIPanel *p)
 Constructor.
 GUITextEntry (uint len)
 Constructor.
 GUITextEntry (uint len, const Key *keys, uint n)
 Constructor.
virtual ~GUITextEntry ()
 Deconstructor.
virtual void SetFont (FontRef f)
 Sets the font to use when drawing text.
FontRef GetFont () const
 Returns the font used for drawing text.
void SetColor (const Color4f &c)
 Sets the color to use when drawing text.
const std::string & GetText () const
 Returns the input text.
void ClearText ()
 Clears the input text.
uint GetCursorPosition () const
 Returns the cursor position for the input text.
uint GetMaxInputLength () const
 Returns the max length for the input text.
virtual void OnMouseClick (const IMouse &m)
 Method called when a mouse clicks a button on the panel.
virtual void KeyboardUpdate (const IKeyboard &kb)
 Called each frame when the panel has focus.
virtual const char * GetPanelTypeName () const
 Gets the string type identifier for the GUI element.

Protected Member Functions

virtual void Paint ()
 Does the actual rendering of the GUI element.
virtual void RecomputeLayout ()
 Recomputes the bounds and layout for the panel. Called by the Refit() method.

Detailed Description

Text entry gui element.


Constructor & Destructor Documentation

GUITextEntry::GUITextEntry ( GUIPanel p  ) 

Constructor.

Parameters:
[in] p the panels parent.
GUITextEntry::GUITextEntry ( uint  len  ) 

Constructor.

Parameters:
[in] len the max length of the input.
GUITextEntry::GUITextEntry ( uint  len,
const Key keys,
uint  n 
)

Constructor.

Parameters:
[in] len the max length of the input.
[in] keys an array of keys to filter.
[in] n the length of the keys array.

Member Function Documentation

virtual const char* GUITextEntry::GetPanelTypeName (  )  const [inline, virtual]

Gets the string type identifier for the GUI element.

Returns:
The string type identifier.

Reimplemented from GUIPanel.

Reimplemented in GUINameTextEntry.

void GUITextEntry::Paint (  )  [protected, virtual]

Does the actual rendering of the GUI element.

NOTE: Defaults to a no-op. Override in child class were applicable.

Reimplemented from GUIPanel.

Reimplemented in GUINameTextEntry.

void GUITextEntry::SetColor ( const Color4f c  )  [inline]

Sets the color to use when drawing text.

Parameters:
[in] c the color.
virtual void GUITextEntry::SetFont ( FontRef  f  )  [inline, virtual]

Sets the font to use when drawing text.

Parameters:
[in] f the referance to the font.

Reimplemented in GUINameTextEntry.


The documentation for this class was generated from the following files:
Generated on Mon Apr 5 19:08:06 2010 for BrickOut |ReDuX| by  doxygen 1.6.3