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

TextBox properties. TextBox_skin_childs 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 Types inherited from MyGUI::Widget
typedef RTTIBase Base
 
typedef Widget RTTIBase
 
- Public Types inherited from MyGUI::IObject
typedef IObject 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 UString & getCaption ()
 
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 Colour & getTextColour ()
 
void setCaptionWithReplacing (const std::string &_value)
 
virtual void setTextShadowColour (const Colour &_value)
 
const Colour & getTextShadowColour ()
 
virtual void setTextShadow (bool _value)
 
bool getTextShadow ()
 
- Public Member Functions inherited from MyGUI::Widget
template<typename Type >
bool isType () const
 
 Widget ()
 
Widget * createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
 
Widget * createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
 
Widget * createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
 
Widget * createWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
 
template<typename T >
T * createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
 
template<typename T >
T * createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
 
template<typename T >
T * createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
 
template<typename T >
T * createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
 
Widget * createWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
 
template<typename T >
T * createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
 
virtual void setPosition (const IntPoint &_value)
 
virtual void setSize (const IntSize &_value)
 
virtual void setCoord (const IntCoord &_value)
 
void setPosition (int _left, int _top)
 
void setSize (int _width, int _height)
 
void setCoord (int _left, int _top, int _width, int _height)
 
void setRealPosition (const FloatPoint &_value)
 
void setRealSize (const FloatSize &_value)
 
void setRealCoord (const FloatCoord &_value)
 
void setRealPosition (float _left, float _top)
 
void setRealSize (float _width, float _height)
 
void setRealCoord (float _left, float _top, float _width, float _height)
 
const std::string & getName () const
 Get name of widget. More...
 
virtual void setVisible (bool _value)
 
bool getVisible () const
 
void setDepth (int _value)
 
int getDepth () const
 
bool getInheritedVisible () const
 
virtual void setAlign (Align _value)
 
Align getAlign () const
 
void setAlpha (float _value)
 
float getAlpha () const
 
void setInheritsAlpha (bool _value)
 
bool getInheritsAlpha () const
 
void setColour (const Colour &_value)
 
bool isRootWidget () const
 
Widget * getParent () const
 
IntSize getParentSize () const
 
EnumeratorWidgetPtr getEnumerator () const
 
size_t getChildCount ()
 
Widget * getChildAt (size_t _index)
 
Widget * findWidget (const std::string &_name)
 
void findWidgets (const std::string &_name, VectorWidgetPtr &_result)
 
virtual void setEnabled (bool _value)
 
void setEnabledSilent (bool _value)
 
bool getEnabled () const
 
bool getInheritedEnabled () const
 
IntCoord getClientCoord ()
 
Widget * getClientWidget ()
 
void detachFromWidget (const std::string &_layer="")
 
void attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")
 
void changeWidgetSkin (const std::string &_skinName)
 
void setWidgetStyle (WidgetStyle _style, const std::string &_layer="")
 
WidgetStyle getWidgetStyle () const
 
void setProperty (const std::string &_key, const std::string &_value)
 
virtual size_t _getItemIndex (Widget *_item)
 
void _forcePick (Widget *_widget)
 
void _initialise (WidgetStyle _style, const IntCoord &_coord, const std::string &_skinName, Widget *_parent, ICroppedRectangle *_croppedParent, const std::string &_name)
 
void _shutdown ()
 
void _destroyChildWidget (Widget *_widget)
 
void _setContainer (Widget *_value)
 
Widget * _getContainer ()
 
void _setAlign (const IntSize &_oldsize, const IntSize &_newSize)
 
bool _checkPoint (int _left, int _top) const
 
Widget * _createSkinWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
 
virtual void _resetContainer (bool _update)
 
bool _setWidgetState (const std::string &_value)
 
void _updateChilds ()
 
- Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool isType () const
 
template<typename Type >
Type * castType (bool _throw=true)
 
template<typename Type >
const Type * castType (bool _throw=true) const
 
 IObject ()
 
virtual ~IObject ()
 
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
 
virtual ~ICroppedRectangle ()
 
ICroppedRectangle * getCroppedParent ()
 
IntPoint getPosition () const
 
IntSize getSize () const
 
const IntCoord & getCoord () const
 
const IntPoint & getAbsolutePosition () const
 
IntRect getAbsoluteRect () const
 
IntCoord getAbsoluteCoord () const
 
int getAbsoluteLeft () const
 
int getAbsoluteTop () const
 
int getLeft () const
 
int getRight () const
 
int getTop () const
 
int getBottom () const
 
int getWidth () const
 
int getHeight () const
 
bool _isMargin () const
 
int _getViewLeft () const
 
int _getViewRight () const
 
int _getViewTop () const
 
int _getViewBottom () const
 
int _getViewWidth () const
 
int _getViewHeight () const
 
void _setCroppedParent (ICroppedRectangle *_parent)
 
const IntRect & _getMargin () const
 
int _getMarginLeft () const
 
int _getMarginRight () const
 
int _getMarginTop () const
 
int _getMarginBottom () const
 
- Public Member Functions inherited from MyGUI::UserData
 UserData ()
 
virtual ~UserData ()
 
void setUserString (const std::string &_key, const std::string &_value)
 
const std::string & getUserString (const std::string &_key) const
 
const MapString & getUserStrings () const
 
bool clearUserString (const std::string &_key)
 
bool isUserString (const std::string &_key) const
 
void clearUserStrings ()
 
void setUserData (Any _data)
 
template<typename ValueType >
ValueType * getUserData (bool _throw=true) const
 
void _setInternalData (Any _data)
 
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true) const
 
- Public Member Functions inherited from MyGUI::WidgetInput
 WidgetInput ()
 
virtual ~WidgetInput ()
 
void setNeedToolTip (bool _value)
 
bool getNeedToolTip () const
 
void setPointer (const std::string &_value)
 
const std::string & getPointer () const
 
void setNeedKeyFocus (bool _value)
 
bool getNeedKeyFocus () const
 
void setNeedMouseFocus (bool _value)
 
bool getNeedMouseFocus () const
 
void setInheritsPick (bool _value)
 
bool getInheritsPick () const
 
void setMaskPick (const std::string &_filename)
 
void setMaskPick (const MaskPickInfo &_info)
 
bool isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const
 
bool getRootMouseFocus () const
 
bool getRootKeyFocus () const
 
void _riseMouseLostFocus (Widget *_new)
 
void _riseMouseSetFocus (Widget *_old)
 
void _riseMouseDrag (int _left, int _top, MouseButton _id)
 
void _riseMouseMove (int _left, int _top)
 
void _riseMouseWheel (int _rel)
 
void _riseMouseButtonPressed (int _left, int _top, MouseButton _id)
 
void _riseMouseButtonReleased (int _left, int _top, MouseButton _id)
 
void _riseMouseButtonClick ()
 
void _riseMouseButtonDoubleClick ()
 
void _riseKeyLostFocus (Widget *_new)
 
void _riseKeySetFocus (Widget *_old)
 
void _riseKeyButtonPressed (KeyCode _key, Char _char)
 
void _riseKeyButtonReleased (KeyCode _key)
 
void _riseMouseChangeRootFocus (bool _focus)
 
void _riseKeyChangeRootFocus (bool _focus)
 
void _setRootMouseFocus (bool _value)
 
void _setRootKeyFocus (bool _value)
 
- Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual ~IDelegateUnlink ()
 
 IDelegateUnlink ()
 
bool compare (IDelegateUnlink *_unlink) const
 
- Public Member Functions inherited from MyGUI::SkinItem
 SkinItem ()
 
ISubWidgetText * getSubWidgetText ()
 
ISubWidgetRect * getSubWidgetMain ()
 
void _setTextureName (const std::string &_texture)
 
const std::string & _getTextureName () const
 
- Public Member Functions inherited from MyGUI::LayerItem
 LayerItem ()
 
virtual ~LayerItem ()
 
ILayer * getLayer () const
 
ILayerNode * getLayerNode () const
 
virtual void attachItemToNode (ILayer *_layer, ILayerNode *_node)
 
virtual void detachFromLayer ()
 
virtual void upLayerItem ()
 
void setRenderItemTexture (ITexture *_texture)
 
void addChildItem (LayerItem *_item)
 
void removeChildItem (LayerItem *_item)
 
void addChildNode (LayerItem *_item)
 
void removeChildNode (LayerItem *_item)
 
void addRenderItem (ISubWidget *_item)
 
void removeAllRenderItems ()
 
void saveLayerItem ()
 
void restoreLayerItem ()
 
- Public Member Functions inherited from MyGUI::ILayerItem
virtual ~ILayerItem ()
 
- Public Member Functions inherited from MyGUI::MemberObsolete< Widget >
bool isEnabled ()
 
bool isInheritsAlpha ()
 
bool isNeedKeyFocus ()
 
bool isNeedMouseFocus ()
 
bool isInheritsPick ()
 
bool isVisible ()
 

Static Public Member Functions

static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::Widget
static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::IObject
static const std::string & getClassTypeName ()
 

Protected Member Functions

virtual void setPropertyOverride (const std::string &_key, const std::string &_value)
 
- Protected Member Functions inherited from MyGUI::Widget
virtual ~Widget ()
 
virtual void shutdownOverride ()
 
virtual void initialiseOverride ()
 
void _updateView ()
 
Widget * baseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name, bool _template)
 
void _destroyAllChildWidget ()
 
virtual size_t _getContainerIndex (const IntPoint &_point)
 
virtual void baseUpdateEnable ()
 
virtual ILayerItem * getLayerItemByPoint (int _left, int _top) const
 
virtual const IntCoord & getLayerItemCoord () const
 
template<typename T >
void assignWidget (T *&_widget, const std::string &_name)
 
VectorWidgetPtr getSkinWidgetsByName (const std::string &_name)
 
void destroySkinWidget (Widget *_widget)
 
virtual void onWidgetCreated (Widget *_widget)
 
virtual void onWidgetDestroy (Widget *_widget)
 
void setWidgetClient (Widget *_widget)
 
- Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool _checkMargin ()
 
bool _checkOutside () const
 
- Protected Member Functions inherited from MyGUI::WidgetInput
virtual void onMouseLostFocus (Widget *_new)
 
virtual void onMouseSetFocus (Widget *_old)
 
virtual void onMouseDrag (int _left, int _top, MouseButton _id)
 
virtual void onMouseMove (int _left, int _top)
 
virtual void onMouseWheel (int _rel)
 
virtual void onMouseButtonPressed (int _left, int _top, MouseButton _id)
 
virtual void onMouseButtonReleased (int _left, int _top, MouseButton _id)
 
virtual void onMouseButtonClick ()
 
virtual void onMouseButtonDoubleClick ()
 
virtual void onKeyLostFocus (Widget *_new)
 
virtual void onKeySetFocus (Widget *_old)
 
virtual void onKeyButtonPressed (KeyCode _key, Char _char)
 
virtual void onKeyButtonReleased (KeyCode _key)
 
virtual void onMouseChangeRootFocus (bool _focus)
 
virtual void onKeyChangeRootFocus (bool _focus)
 
- Protected Member Functions inherited from MyGUI::SkinItem
void _createSkinItem (ResourceSkin *_info)
 
void _deleteSkinItem ()
 
void _setSkinItemAlign (const IntSize &_size)
 
void _setSkinItemVisible (bool _value)
 
void _setSkinItemColour (const Colour &_value)
 
void _setSkinItemAlpha (float _value)
 
void _correctSkinItemView ()
 
void _updateSkinItemView ()
 
bool _setSkinItemState (const std::string &_state)
 
void _setSubSkinVisible (bool _visible)
 
- Protected Member Functions inherited from MyGUI::LayerItem
void attachToLayerItemNode (ILayerNode *_node, bool _deep)
 
void detachFromLayerItemNode (bool _deep)
 

Additional Inherited Members

- Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString eventChangeProperty
 
EventHandle_WidgetVoid eventChangeCoord
 
- Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect mMargin
 
IntCoord mCoord
 
IntPoint mAbsolutePosition
 
bool mIsMargin
 
ICroppedRectangle * mCroppedParent
 

Detailed Description

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

Definition at line 19 of file MyGUI_TextBox.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::TextBox::Base

Definition at line 22 of file MyGUI_TextBox.h.

typedef TextBox MyGUI::TextBox::RTTIBase

Definition at line 22 of file MyGUI_TextBox.h.

Constructor & Destructor Documentation

MyGUI::TextBox::TextBox ( )

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 ( )
inlinestatic

Definition at line 22 of file MyGUI_TextBox.h.

int MyGUI::TextBox::getFontHeight ( )

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.

Align MyGUI::TextBox::getTextAlign ( )

Get widget text align

Definition at line 35 of file MyGUI_TextBox.cpp.

const Colour & MyGUI::TextBox::getTextColour ( )

Get widget text colour

Definition at line 48 of file MyGUI_TextBox.cpp.

IntCoord MyGUI::TextBox::getTextRegion ( )
virtual

Get text region coordinate

Reimplemented in MyGUI::EditBox.

Definition at line 19 of file MyGUI_TextBox.cpp.

bool MyGUI::TextBox::getTextShadow ( )

Get widget text shadow

Definition at line 128 of file MyGUI_TextBox.cpp.

const Colour & MyGUI::TextBox::getTextShadowColour ( )

Get widget text shadow colour

Definition at line 117 of file MyGUI_TextBox.cpp.

IntSize MyGUI::TextBox::getTextSize ( )
virtual

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
inlinevirtual

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

Definition at line 22 of file MyGUI_TextBox.h.

virtual bool MyGUI::TextBox::isType ( const std::type_info &  _type) const
inlinevirtual

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 
)
protectedvirtual
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:
Generated on Wed Aug 20 2014 00:03:37 for MyGUI by   doxygen 1.8.3.1