Motoko::TextBox Class Reference

Class that represents a generic text box. More...

#include <TextBox.h>

Inheritance diagram for Motoko::TextBox:

Motoko::Box Motoko::ITextControl Motoko::Control List of all members.

Public Member Functions

 TextBox ()
 TextBox (const char *name, SDL_Rect rect, ControlBackStyle backstyle, Uint32 backcolor, const char *text, CRM32Pro_CFont *font, ControlSkin *appearance=NULL, SDL_Surface *picture=NULL, SDL_Surface *mousepointer=NULL, AlignmentStyle alignment=Left, bool locked=false, bool multiline=false, int maxlen=NO_LIMIT, ControlScrollBars scrollbars=NoneScrollBars, KeyboardLanguage language=SpanishLanguage, bool transparency=false, bool enable=true, bool visible=true)
 TextBox (const TextBox &obj)
virtual TextBoxoperator= (const TextBox &obj)
 ~TextBox ()
virtual void Draw (void)
 This function draw the control.
virtual bool Update (SDL_Event &event)
 This function update the control.
virtual TextBoxCopyFrom (const TextBox &obj)
 This function copies obj in the actual object.
virtual void UpdateRects (void)
 This function update the rects in the actual object.
bool GetLocked (void)
 Get if the control is locked.
bool GetMultiLine (void)
 Get if the control is multiline.
int GetMaxLength (void)
 Get the max length of the text.
ControlScrollBars GetScrollBars (void)
 Get the visible scrollbars of the control.
KeyboardLanguage GetLanguage (void)
 Get the type of keyboard of the control.
HScrollBarGetHBar (void)
 Get the HBar of the control.
VScrollBarGetVBar (void)
 Get the VBar of the control.
virtual void SetLocked (bool val)
 Set if the control is locked.
virtual void SetMultiLine (bool val)
 Set if the control is multiline.
virtual void SetMaxLength (int val=NO_LIMIT)
 Set the max length of the text.
virtual void SetScrollBars (ControlScrollBars val)
 Set the visible scrollbars of the control.
virtual void SetLanguage (KeyboardLanguage val)
 Set the type of keyboard of the control.
virtual void SetText (const char *val)
 Set the text of the control.
virtual void AddText (const char *val)
 Add text to the control.
virtual void SetText (char val)
 Set the text of the control.
virtual void AddText (char val)
 Add text to the control.
virtual void SetName (const char *val)
 Set the name of the control.
virtual void SetBackStyle (ControlBackStyle val)
 Set the back style of the control.
virtual void SetBackColor (Uint32 box, Uint32 scrolls)
 Set the back color of the control.
void SetAppearance (ControlSkin *box, ControlSkin *vscroll, ControlSkin *hscroll, ControlSkin *button)
 Set the appearance of the control.
virtual void SetBackColor (Uint32 val)
 Set the back color of the control.
virtual void SetAppearance (ControlSkin *val)
 Set the appearance of the control.

Protected Member Functions

void UpdateValues (void)
 This function update the values of the scrollbars.

Detailed Description

Class that represents a generic text box.


Constructor & Destructor Documentation

Motoko::TextBox::TextBox (  ) 

TextBox constructor.

Motoko::TextBox::TextBox ( const char *  name,
SDL_Rect  rect,
ControlBackStyle  backstyle,
Uint32  backcolor,
const char *  text,
CRM32Pro_CFont *  font,
ControlSkin appearance = NULL,
SDL_Surface *  picture = NULL,
SDL_Surface *  mousepointer = NULL,
AlignmentStyle  alignment = Left,
bool  locked = false,
bool  multiline = false,
int  maxlen = NO_LIMIT,
ControlScrollBars  scrollbars = NoneScrollBars,
KeyboardLanguage  language = SpanishLanguage,
bool  transparency = false,
bool  enable = true,
bool  visible = true 
)

TextBox constructor.

Motoko::TextBox::TextBox ( const TextBox obj  ) 

TextBox copy constructor.

Motoko::TextBox::~TextBox (  ) 

TextBox destructor.


Member Function Documentation

TextBox & Motoko::TextBox::CopyFrom ( const TextBox obj  )  [virtual]

This function copies obj in the actual object.

Parameters:
obj Object to copy.
Returns:
A reference to the actual object.

TextBox & Motoko::TextBox::operator= ( const TextBox obj  )  [virtual]

TextBox operator =.


The documentation for this class was generated from the following files:
Generated on Mon Jul 17 18:33:50 2006 for Motoko by  doxygen 1.4.7