MyGUI 3.4.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
MyGUI::EditText Class Reference

#include <MyGUI_EditText.h>

Inheritance diagram for MyGUI::EditText:
Inheritance graph
[legend]

Public Types

typedef RTTIBase Base
 
typedef EditText RTTIBase
 
- Public Types inherited from MyGUI::ISubWidgetText
typedef RTTIBase Base
 
typedef ISubWidgetText RTTIBase
 
- Public Types inherited from MyGUI::ISubWidget
typedef RTTIBase Base
 
typedef ISubWidget RTTIBase
 
- Public Types inherited from MyGUI::IObject
typedef IObject RTTIBase
 

Public Member Functions

virtual const std::string & getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
 EditText ()
 
void setVisible (bool _value) override
 
void updateRawData () const
 
void doRender () override
 
void setCaption (const UString &_value) override
 
const UStringgetCaption () const override
 
void setTextColour (const Colour &_value) override
 
const ColourgetTextColour () const override
 
void setAlpha (float _value) override
 
void setFontName (const std::string &_value) override
 
const std::string & getFontName () const override
 
void setFontHeight (int _value) override
 
int getFontHeight () const override
 
void createDrawItem (ITexture *_texture, ILayerNode *_node) override
 
void destroyDrawItem () override
 
void setTextAlign (Align _value) override
 
Align getTextAlign () const override
 
size_t getTextSelectionStart () const override
 
size_t getTextSelectionEnd () const override
 
void setTextSelection (size_t _start, size_t _end) override
 
bool getSelectBackground () const override
 
void setSelectBackground (bool _normal) override
 
bool isVisibleCursor () const override
 
void setVisibleCursor (bool _value) override
 
bool getInvertSelected () const override
 
void setInvertSelected (bool _value) override
 
size_t getCursorPosition () const override
 
void setCursorPosition (size_t _index) override
 
IntSize getTextSize () const override
 
void setViewOffset (const IntPoint &_point) override
 
IntPoint getViewOffset () const override
 
size_t getCursorPosition (const IntPoint &_point) const override
 
IntCoord getCursorCoord (size_t _position) const override
 
bool getShadow () const override
 
void setShadow (bool _value) override
 
void setShiftText (bool _shift) override
 
void setWordWrap (bool _value) override
 
void setStateData (IStateInfo *_data) override
 
void setShadowColour (const Colour &_value) override
 
const ColourgetShadowColour () const override
 
void _updateView () override
 
void _correctView () override
 
void _setAlign (const IntSize &_oldsize) override
 
virtual const VectorLineInfogetLineInfo () const
 
- Public Member Functions inherited from MyGUI::ISubWidgetText
virtual const std::string & getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
virtual size_t getTextSelectionStart () const
 
virtual size_t getTextSelectionEnd () const
 
virtual void setTextSelection (size_t _start, size_t _end)
 
virtual bool getSelectBackground () const
 
virtual void setSelectBackground (bool _normal)
 
virtual bool getInvertSelected () const
 
virtual void setInvertSelected (bool _value)
 
virtual bool getShadow () const
 
virtual void setShadow (bool _value)
 
virtual bool isVisibleCursor () const
 
virtual void setVisibleCursor (bool _value)
 
virtual size_t getCursorPosition () const
 
virtual void setCursorPosition (size_t _index)
 
virtual void setWordWrap (bool _value)
 
virtual size_t getCursorPosition (const IntPoint &_point) const
 
virtual IntCoord getCursorCoord (size_t _position) const
 
IntPoint getCursorPoint (size_t _position) const
 
IntRect getCursorRect (size_t _position) const
 
virtual IntSize getTextSize () const
 
virtual void setViewOffset (const IntPoint &_point)
 
virtual IntPoint getViewOffset () const
 
virtual void setCaption (const UString &_value)
 
virtual const UStringgetCaption () const
 
virtual void setTextColour (const Colour &_value)
 
virtual const ColourgetTextColour () const
 
virtual void setFontName (const std::string &_value)
 
virtual const std::string & getFontName () const
 
virtual void setFontHeight (int _value)
 
virtual int getFontHeight () const
 
virtual void setTextAlign (Align _value)
 
virtual Align getTextAlign () const
 
virtual void setShiftText (bool _value)
 
virtual void setShadowColour (const Colour &_value)
 
virtual const ColourgetShadowColour () const
 
- Public Member Functions inherited from MyGUI::ISubWidget
virtual const std::string & getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
 ISubWidget ()
 
virtual void createDrawItem (ITexture *_texture, ILayerNode *_node)=0
 
virtual void destroyDrawItem ()=0
 
virtual void setAlpha (float _alpha)
 
virtual void setStateData (IStateInfo *_data)
 
virtual void doRender ()=0
 
virtual void setAlign (Align _value)
 
virtual void setVisible (bool _value)
 
virtual void _updateView ()
 
virtual void _correctView ()
 
virtual void _setAlign (const IntSize &_oldsize)
 
virtual void doManualRender (IVertexBuffer *_buffer, ITexture *_texture, size_t _count)
 
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
 
virtual ~ICroppedRectangle ()
 
ICroppedRectanglegetCroppedParent ()
 
virtual void setPosition (const IntPoint &_value)
 
virtual void setSize (const IntSize &_value)
 
virtual void setCoord (const IntCoord &_value)
 
IntPoint getPosition () const
 
IntSize getSize () const
 
const IntCoordgetCoord () const
 
const IntPointgetAbsolutePosition () 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::IObject
virtual const std::string & getTypeName () const
 
virtual bool isType (const std::type_info &_type) const
 
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 ()=default
 
virtual ~IObject ()=default
 

Static Public Member Functions

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

Protected Attributes

bool mEmptyView
 
uint32 mCurrentColourNative
 
uint32 mInverseColourNative
 
uint32 mShadowColourNative
 
IntCoord mCurrentCoord
 
UString mCaption
 
UString::utf32string mUtf32Caption
 
bool mTextOutDate
 
Align mTextAlign
 
Colour mColour
 
Colour mShadowColour
 
float mAlpha
 
VertexColourType mVertexFormat
 
IFontmFont
 
ITexturemTexture
 
int mFontHeight
 
bool mBackgroundNormal
 
size_t mStartSelect
 
size_t mEndSelect
 
size_t mCursorPosition
 
bool mVisibleCursor
 
bool mInvertSelect
 
bool mShadow
 
IntPoint mViewOffset
 
ILayerNodemNode
 
RenderItemmRenderItem
 
size_t mCountVertex
 
bool mIsAddCursorWidth
 
bool mShiftText
 
bool mWordWrap
 
bool mManualColour
 
int mOldWidth
 
TextView mTextView
 
- Protected Attributes inherited from MyGUI::ISubWidget
Align mAlign
 
bool mVisible
 
- Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect mMargin
 
IntCoord mCoord
 
IntPoint mAbsolutePosition
 
bool mIsMargin
 
ICroppedRectanglemCroppedParent
 

Additional Inherited Members

- Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool _checkMargin ()
 
bool _checkOutside () const
 

Detailed Description

Definition at line 25 of file MyGUI_EditText.h.

Member Typedef Documentation

◆ Base

Definition at line 28 of file MyGUI_EditText.h.

◆ RTTIBase

Definition at line 28 of file MyGUI_EditText.h.

Constructor & Destructor Documentation

◆ EditText()

MyGUI::EditText::EditText ( )

Definition at line 23 of file MyGUI_EditText.cpp.

Member Function Documentation

◆ _correctView()

void MyGUI::EditText::_correctView ( )
overridevirtual

Reimplemented from MyGUI::ISubWidget.

Definition at line 66 of file MyGUI_EditText.cpp.

◆ _setAlign()

void MyGUI::EditText::_setAlign ( const IntSize _oldsize)
overridevirtual

Reimplemented from MyGUI::ISubWidget.

Definition at line 72 of file MyGUI_EditText.cpp.

◆ _updateView()

void MyGUI::EditText::_updateView ( )
overridevirtual

Reimplemented from MyGUI::ISubWidget.

Definition at line 124 of file MyGUI_EditText.cpp.

◆ createDrawItem()

void MyGUI::EditText::createDrawItem ( ITexture _texture,
ILayerNode _node 
)
overridevirtual

Implements MyGUI::ISubWidget.

Definition at line 293 of file MyGUI_EditText.cpp.

◆ destroyDrawItem()

void MyGUI::EditText::destroyDrawItem ( )
overridevirtual

Implements MyGUI::ISubWidget.

Definition at line 306 of file MyGUI_EditText.cpp.

◆ doRender()

void MyGUI::EditText::doRender ( )
overridevirtual

Implements MyGUI::ISubWidget.

Reimplemented in MyGUI::SimpleText.

Definition at line 510 of file MyGUI_EditText.cpp.

◆ getCaption()

const UString & MyGUI::EditText::getCaption ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 192 of file MyGUI_EditText.cpp.

◆ getClassTypeName()

static const std::string & MyGUI::EditText::getClassTypeName ( )
inlinestatic

Definition at line 28 of file MyGUI_EditText.h.

◆ getCursorCoord()

IntCoord MyGUI::EditText::getCursorCoord ( size_t  _position) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 448 of file MyGUI_EditText.cpp.

◆ getCursorPosition() [1/2]

size_t MyGUI::EditText::getCursorPosition ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 365 of file MyGUI_EditText.cpp.

◆ getCursorPosition() [2/2]

size_t MyGUI::EditText::getCursorPosition ( const IntPoint _point) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 432 of file MyGUI_EditText.cpp.

◆ getFontHeight()

int MyGUI::EditText::getFontHeight ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 288 of file MyGUI_EditText.cpp.

◆ getFontName()

const std::string & MyGUI::EditText::getFontName ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 274 of file MyGUI_EditText.cpp.

◆ getInvertSelected()

bool MyGUI::EditText::getInvertSelected ( ) const
overridevirtual

Get invert selected text color property.

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 618 of file MyGUI_EditText.cpp.

◆ getLineInfo()

const VectorLineInfo & MyGUI::EditText::getLineInfo ( ) const
virtual

Definition at line 414 of file MyGUI_EditText.cpp.

◆ getSelectBackground()

bool MyGUI::EditText::getSelectBackground ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 335 of file MyGUI_EditText.cpp.

◆ getShadow()

bool MyGUI::EditText::getShadow ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 623 of file MyGUI_EditText.cpp.

◆ getShadowColour()

const Colour & MyGUI::EditText::getShadowColour ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 652 of file MyGUI_EditText.cpp.

◆ getTextAlign()

Align MyGUI::EditText::getTextAlign ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 388 of file MyGUI_EditText.cpp.

◆ getTextColour()

const Colour & MyGUI::EditText::getTextColour ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 220 of file MyGUI_EditText.cpp.

◆ getTextSelectionEnd()

size_t MyGUI::EditText::getTextSelectionEnd ( ) const
overridevirtual

Get index of end of selection

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 321 of file MyGUI_EditText.cpp.

◆ getTextSelectionStart()

size_t MyGUI::EditText::getTextSelectionStart ( ) const
overridevirtual

Get index of start of selection

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 316 of file MyGUI_EditText.cpp.

◆ getTextSize()

IntSize MyGUI::EditText::getTextSize ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 393 of file MyGUI_EditText.cpp.

◆ getTypeName()

virtual const std::string & MyGUI::EditText::getTypeName ( ) const
inlineoverridevirtual

Get type name as string

Reimplemented from MyGUI::ISubWidgetText.

Reimplemented in MyGUI::SimpleText.

Definition at line 28 of file MyGUI_EditText.h.

◆ getViewOffset()

IntPoint MyGUI::EditText::getViewOffset ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 427 of file MyGUI_EditText.cpp.

◆ isType() [1/2]

template<typename Type >
bool MyGUI::EditText::isType ( ) const
inline

Compare with selected type

Definition at line 28 of file MyGUI_EditText.h.

◆ isType() [2/2]

virtual bool MyGUI::EditText::isType ( const std::type_info &  _type) const
inlineoverridevirtual

Compare with selected type

Reimplemented from MyGUI::ISubWidgetText.

Reimplemented in MyGUI::SimpleText.

Definition at line 28 of file MyGUI_EditText.h.

◆ isVisibleCursor()

bool MyGUI::EditText::isVisibleCursor ( ) const
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 350 of file MyGUI_EditText.cpp.

◆ setAlpha()

void MyGUI::EditText::setAlpha ( float  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidget.

Definition at line 225 of file MyGUI_EditText.cpp.

◆ setCaption()

void MyGUI::EditText::setCaption ( const UString _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 163 of file MyGUI_EditText.cpp.

◆ setCursorPosition()

void MyGUI::EditText::setCursorPosition ( size_t  _index)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 370 of file MyGUI_EditText.cpp.

◆ setFontHeight()

void MyGUI::EditText::setFontHeight ( int  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 279 of file MyGUI_EditText.cpp.

◆ setFontName()

void MyGUI::EditText::setFontName ( const std::string &  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 239 of file MyGUI_EditText.cpp.

◆ setInvertSelected()

void MyGUI::EditText::setInvertSelected ( bool  _value)
overridevirtual

Enable or disable inverting color of selected text.
Enabled (true) by default.

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 608 of file MyGUI_EditText.cpp.

◆ setSelectBackground()

void MyGUI::EditText::setSelectBackground ( bool  _normal)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 340 of file MyGUI_EditText.cpp.

◆ setShadow()

void MyGUI::EditText::setShadow ( bool  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 628 of file MyGUI_EditText.cpp.

◆ setShadowColour()

void MyGUI::EditText::setShadowColour ( const Colour _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 639 of file MyGUI_EditText.cpp.

◆ setShiftText()

void MyGUI::EditText::setShiftText ( bool  _shift)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 464 of file MyGUI_EditText.cpp.

◆ setStateData()

void MyGUI::EditText::setStateData ( IStateInfo _data)
overridevirtual

Reimplemented from MyGUI::ISubWidget.

Definition at line 502 of file MyGUI_EditText.cpp.

◆ setTextAlign()

void MyGUI::EditText::setTextAlign ( Align  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 380 of file MyGUI_EditText.cpp.

◆ setTextColour()

void MyGUI::EditText::setTextColour ( const Colour _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 197 of file MyGUI_EditText.cpp.

◆ setTextSelection()

void MyGUI::EditText::setTextSelection ( size_t  _start,
size_t  _end 
)
overridevirtual

Set text selection

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 326 of file MyGUI_EditText.cpp.

◆ setViewOffset()

void MyGUI::EditText::setViewOffset ( const IntPoint _point)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Reimplemented in MyGUI::SimpleText.

Definition at line 419 of file MyGUI_EditText.cpp.

◆ setVisible()

void MyGUI::EditText::setVisible ( bool  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidget.

Definition at line 56 of file MyGUI_EditText.cpp.

◆ setVisibleCursor()

void MyGUI::EditText::setVisibleCursor ( bool  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 355 of file MyGUI_EditText.cpp.

◆ setWordWrap()

void MyGUI::EditText::setWordWrap ( bool  _value)
overridevirtual

Reimplemented from MyGUI::ISubWidgetText.

Definition at line 474 of file MyGUI_EditText.cpp.

◆ updateRawData()

void MyGUI::EditText::updateRawData ( ) const

Definition at line 483 of file MyGUI_EditText.cpp.

Field Documentation

◆ mAlpha

float MyGUI::EditText::mAlpha
protected

Definition at line 148 of file MyGUI_EditText.h.

◆ mBackgroundNormal

bool MyGUI::EditText::mBackgroundNormal
protected

Definition at line 155 of file MyGUI_EditText.h.

◆ mCaption

UString MyGUI::EditText::mCaption
protected

Definition at line 141 of file MyGUI_EditText.h.

◆ mColour

Colour MyGUI::EditText::mColour
protected

Definition at line 146 of file MyGUI_EditText.h.

◆ mCountVertex

size_t MyGUI::EditText::mCountVertex
protected

Definition at line 167 of file MyGUI_EditText.h.

◆ mCurrentColourNative

uint32 MyGUI::EditText::mCurrentColourNative
protected

Definition at line 136 of file MyGUI_EditText.h.

◆ mCurrentCoord

IntCoord MyGUI::EditText::mCurrentCoord
protected

Definition at line 139 of file MyGUI_EditText.h.

◆ mCursorPosition

size_t MyGUI::EditText::mCursorPosition
protected

Definition at line 158 of file MyGUI_EditText.h.

◆ mEmptyView

bool MyGUI::EditText::mEmptyView
protected

Definition at line 135 of file MyGUI_EditText.h.

◆ mEndSelect

size_t MyGUI::EditText::mEndSelect
protected

Definition at line 157 of file MyGUI_EditText.h.

◆ mFont

IFont* MyGUI::EditText::mFont
protected

Definition at line 151 of file MyGUI_EditText.h.

◆ mFontHeight

int MyGUI::EditText::mFontHeight
protected

Definition at line 153 of file MyGUI_EditText.h.

◆ mInverseColourNative

uint32 MyGUI::EditText::mInverseColourNative
protected

Definition at line 137 of file MyGUI_EditText.h.

◆ mInvertSelect

bool MyGUI::EditText::mInvertSelect
protected

Definition at line 160 of file MyGUI_EditText.h.

◆ mIsAddCursorWidth

bool MyGUI::EditText::mIsAddCursorWidth
protected

Definition at line 168 of file MyGUI_EditText.h.

◆ mManualColour

bool MyGUI::EditText::mManualColour
protected

Definition at line 172 of file MyGUI_EditText.h.

◆ mNode

ILayerNode* MyGUI::EditText::mNode
protected

Definition at line 165 of file MyGUI_EditText.h.

◆ mOldWidth

int MyGUI::EditText::mOldWidth
protected

Definition at line 173 of file MyGUI_EditText.h.

◆ mRenderItem

RenderItem* MyGUI::EditText::mRenderItem
protected

Definition at line 166 of file MyGUI_EditText.h.

◆ mShadow

bool MyGUI::EditText::mShadow
protected

Definition at line 161 of file MyGUI_EditText.h.

◆ mShadowColour

Colour MyGUI::EditText::mShadowColour
protected

Definition at line 147 of file MyGUI_EditText.h.

◆ mShadowColourNative

uint32 MyGUI::EditText::mShadowColourNative
protected

Definition at line 138 of file MyGUI_EditText.h.

◆ mShiftText

bool MyGUI::EditText::mShiftText
protected

Definition at line 170 of file MyGUI_EditText.h.

◆ mStartSelect

size_t MyGUI::EditText::mStartSelect
protected

Definition at line 156 of file MyGUI_EditText.h.

◆ mTextAlign

Align MyGUI::EditText::mTextAlign
protected

Definition at line 144 of file MyGUI_EditText.h.

◆ mTextOutDate

bool MyGUI::EditText::mTextOutDate
mutableprotected

Definition at line 143 of file MyGUI_EditText.h.

◆ mTexture

ITexture* MyGUI::EditText::mTexture
protected

Definition at line 152 of file MyGUI_EditText.h.

◆ mTextView

TextView MyGUI::EditText::mTextView
mutableprotected

Definition at line 175 of file MyGUI_EditText.h.

◆ mUtf32Caption

UString::utf32string MyGUI::EditText::mUtf32Caption
protected

Definition at line 142 of file MyGUI_EditText.h.

◆ mVertexFormat

VertexColourType MyGUI::EditText::mVertexFormat
protected

Definition at line 149 of file MyGUI_EditText.h.

◆ mViewOffset

IntPoint MyGUI::EditText::mViewOffset
protected

Definition at line 163 of file MyGUI_EditText.h.

◆ mVisibleCursor

bool MyGUI::EditText::mVisibleCursor
protected

Definition at line 159 of file MyGUI_EditText.h.

◆ mWordWrap

bool MyGUI::EditText::mWordWrap
protected

Definition at line 171 of file MyGUI_EditText.h.


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