MyGUI  3.2.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
MyGUI::TextBox Class Reference

TextBox properties. Skin childs. TextBox widget description should be here. More...

#include <MyGUI_TextBox.h>

+ Inheritance diagram for MyGUI::TextBox:

Public Types

typedef RTTIBase Base
typedef TextBox RTTIBase

Public Member Functions

virtual const std::string & getTypeName () const
virtual bool isType (const std::type_info &_type) const
template<typename Type >
bool isType () const
 TextBox ()
virtual IntCoord getTextRegion ()
virtual IntSize getTextSize ()
virtual void setCaption (const UString &_value)
virtual const UStringgetCaption ()
virtual void setFontName (const std::string &_value)
const std::string & getFontName ()
virtual void setFontHeight (int _value)
int getFontHeight ()
virtual void setTextAlign (Align _value)
Align getTextAlign ()
virtual void setTextColour (const Colour &_value)
const ColourgetTextColour ()
void setCaptionWithReplacing (const std::string &_value)
virtual void setTextShadowColour (const Colour &_value)
const ColourgetTextShadowColour ()
virtual void setTextShadow (bool _value)
bool getTextShadow ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Protected Member Functions

virtual void setPropertyOverride (const std::string &_key, const std::string &_value)

Detailed Description

TextBox properties. Skin childs. TextBox widget description should be here.

Definition at line 19 of file MyGUI_TextBox.h.


Member Typedef Documentation


Constructor & Destructor Documentation

Definition at line 15 of file MyGUI_TextBox.cpp.


Member Function Documentation

const UString & MyGUI::TextBox::getCaption ( ) [virtual]

Get widget caption

Reimplemented in MyGUI::EditBox, MyGUI::Window, MyGUI::MultiListItem, and MyGUI::TabItem.

Definition at line 83 of file MyGUI_TextBox.cpp.

static const std::string& MyGUI::TextBox::getClassTypeName ( ) [inline, static]

Get widget text font height

Definition at line 72 of file MyGUI_TextBox.cpp.

const std::string & MyGUI::TextBox::getFontName ( )

Get widget text font name

Definition at line 59 of file MyGUI_TextBox.cpp.

Get widget text align

Definition at line 35 of file MyGUI_TextBox.cpp.

Get widget text colour

Definition at line 48 of file MyGUI_TextBox.cpp.

Get text region coordinate

Reimplemented in MyGUI::EditBox.

Definition at line 19 of file MyGUI_TextBox.cpp.

Get widget text shadow

Definition at line 128 of file MyGUI_TextBox.cpp.

Get widget text shadow colour

Definition at line 117 of file MyGUI_TextBox.cpp.

Get text region size

Reimplemented in MyGUI::EditBox.

Definition at line 24 of file MyGUI_TextBox.cpp.

virtual const std::string& MyGUI::TextBox::getTypeName ( ) const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::ComboBox, MyGUI::Window, MyGUI::EditBox, MyGUI::MenuItem, MyGUI::MultiListItem, MyGUI::Button, and MyGUI::TabItem.

Definition at line 22 of file MyGUI_TextBox.h.

template<typename Type >
bool MyGUI::TextBox::isType ( ) const [inline]

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::ComboBox, MyGUI::Window, MyGUI::EditBox, MyGUI::MenuItem, MyGUI::MultiListItem, MyGUI::Button, and MyGUI::TabItem.

Definition at line 22 of file MyGUI_TextBox.h.

virtual bool MyGUI::TextBox::isType ( const std::type_info &  _type) const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::ComboBox, MyGUI::Window, MyGUI::EditBox, MyGUI::MenuItem, MyGUI::MultiListItem, MyGUI::Button, and MyGUI::TabItem.

Definition at line 22 of file MyGUI_TextBox.h.

void MyGUI::TextBox::setCaption ( const UString _value) [virtual]

Set widget caption

Reimplemented in MyGUI::EditBox, MyGUI::Window, MyGUI::MenuItem, MyGUI::MultiListItem, and MyGUI::TabItem.

Definition at line 77 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setCaptionWithReplacing ( const std::string &  _value)

Set TextBox caption and replace special sequences.
"\\n" will be replaced with new line character;
"#{Keyword}" replaced with string from LanguageManager or left as it is if kayword wasn't found.

Definition at line 90 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setFontHeight ( int  _value) [virtual]

Set widget text font height

Reimplemented in MyGUI::EditBox, and MyGUI::MenuItem.

Definition at line 66 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setFontName ( const std::string &  _value) [virtual]

Set widget text font

Reimplemented in MyGUI::EditBox, and MyGUI::MenuItem.

Definition at line 53 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]
Properties:
TextColour is TextBox property with type Colour. Цвет текста.
Properties:
TextAlign is TextBox property with type Align. Выравнивание текста.
Properties:
FontName is TextBox property with type string. Имя шрифта.
Properties:
FontHeight is TextBox property with type int. Высота шрифта.
Properties:
Caption is TextBox property with type string. Содержимое поля редактирования.
Properties:
TextShadowColour is TextBox property with type Colour. Цвет тени текста.
Properties:
TextShadow is TextBox property with type bool. Режим показа тени текста.

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::EditBox, MyGUI::ComboBox, MyGUI::Window, MyGUI::MenuItem, MyGUI::Button, MyGUI::MultiListItem, and MyGUI::TabItem.

Definition at line 133 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setTextAlign ( Align  _value) [virtual]

Set widget text align

Reimplemented in MyGUI::EditBox.

Definition at line 29 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setTextColour ( const Colour _value) [virtual]

Set widget text colour

Reimplemented in MyGUI::EditBox.

Definition at line 42 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setTextShadow ( bool  _value) [virtual]

Set widget text shadow

Reimplemented in MyGUI::EditBox.

Definition at line 122 of file MyGUI_TextBox.cpp.

void MyGUI::TextBox::setTextShadowColour ( const Colour _value) [virtual]

Set widget text shadow colour

Reimplemented in MyGUI::EditBox.

Definition at line 111 of file MyGUI_TextBox.cpp.


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