Guiliani  Version 2.5 revision 7293 (documentation build 13)
Public Member Functions | Protected Attributes | List of all members
CGUITextField Class Reference
Controls | Text

Represents a simple GUI object containing a text. More...

#include <GUITextField.h>

Inheritance diagram for CGUITextField:
Inheritance graph
[legend]

Public Member Functions

 CGUITextField ()
 
 CGUITextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUITextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUITextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUITextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUITextField (const CGUITextField &kSource)
 
 ~CGUITextField ()
 
eC_Bool DoDraw ()
 
CGUITextField & operator= (const CGUITextField &kSource)
 
virtual void ReadFromStream ()
 
void SetBackgroundImage (const ImageResource_t &eBackgroundImg)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBaseTextField
 CGUIBaseTextField ()
 
 CGUIBaseTextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseTextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseTextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseTextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseTextField (const CGUIBaseTextField &kSource)
 
 ~CGUIBaseTextField ()
 
virtual eC_Bool DoDraw ()
 
eC_UInt GetBackgroundColor () const
 
CGUIText * GetLabel ()
 
const CGUIText * GetLabel () const
 
CGUIBaseTextField & operator= (const CGUIBaseTextField &kSource)
 
virtual void ReadFromStream ()
 
void SetBackgroundColor (const eC_UInt &uiBackgroundColor)
 
void SetBackgroundColor (const GlobalProperty_t &eBackgroundColor)
 
virtual void SetHeight (const eC_Value &vNewHeight)
 
void SetLabel (const eC_String &rkText)
 
void SetLabel (const TextResource_t &eTextID)
 
void SetText (CGUIText *pkText)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
virtual void SetWidth (const eC_Value &vNewWidth)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIObject
 CGUIObject ()
 
 CGUIObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pkObserver)
 
eC_Bool CalculateInvalidatedRect (CGUIRect &rRect) const
 
virtual eC_Bool ClaimFocus ()
 
virtual void CreateSnapshot (eC_UInt uiBackColor=0x00)
 
eC_Bool DataPoolConnectorExists () const
 
void DeleteSnapshot ()
 
virtual void DisableSnapshotDrawing (eC_Bool bDeleteSnapshot=true)
 
virtual eC_Bool DoDraw ()
 
virtual eC_Bool DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
virtual CGUIObject * FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool FocusAny ()
 
virtual eC_Bool FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
virtual eC_Bool FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
CGUIRect GetAbsRect () const
 
eC_Value GetAbsXPos () const
 
eC_Value GetAbsXPosCenter () const
 
eC_Value GetAbsXPosREdge () const
 
eC_Value GetAbsYPos () const
 
eC_Value GetAbsYPosBEdge () const
 
eC_Value GetAbsYPosCenter () const
 
eC_UByte GetAlpha () const
 
CGUIBehaviourDecorator * GetBehaviour ()
 
const CGUIBehaviourDecorator * GetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlane & GetBitmapPlane () const
 
CGUIRect GetCurrentAbsRect () const
 
eC_Value GetCurrentAbsXPos () const
 
eC_Value GetCurrentAbsXPosCenter () const
 
eC_Value GetCurrentAbsXPosREdge () const
 
eC_Value GetCurrentAbsYPos () const
 
eC_Value GetCurrentAbsYPosBEdge () const
 
eC_Value GetCurrentAbsYPosCenter () const
 
CDataPoolConnector & GetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouter * GetLayouter ()
 
const CGUILayouter * GetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObject * GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObject * GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObject * GetParent ()
 
const CGUICompositeObject * GetParent () const
 
CGUIRect GetRelRect () const
 
eC_Value GetRelXPos () const
 
eC_Value GetRelXPosCenter () const
 
eC_Value GetRelXPosREdge () const
 
eC_Value GetRelYPos () const
 
eC_Value GetRelYPosBEdge () const
 
eC_Value GetRelYPosCenter () const
 
eC_Value GetWidth () const
 
void InvalidateArea ()
 
eC_Bool IsClickable () const
 
eC_Bool IsClickThrough () const
 
virtual eC_Bool IsCompositeObject () const
 
eC_Bool IsDescendantOf (const CGUIObject *const pAncestor) const
 
eC_Bool IsDisabled () const
 
eC_Bool IsDragable () const
 
eC_Bool IsDragged () const
 
eC_Bool IsDrawingSnapshot () const
 
eC_Bool IsFocussable () const
 
eC_Bool IsFocussed () const
 
eC_Bool IsGrayedOut () const
 
virtual eC_Bool IsHighlightable () const
 
eC_Bool IsHighlighted () const
 
eC_Bool IsInvisible () const
 
eC_Bool IsPressed () const
 
eC_Bool IsStopFocus () const
 
void NotifyValueObservers (const CGUIValue &kValue, const eC_UInt uiX=0, const eC_UInt uiY=0)
 
CGUIObject & operator= (const CGUIObject &kSource)
 
virtual void ReadFromStream ()
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveValueObserver (CGUIObserver *pkObserver)
 
void RenderToBitmap (eC_UInt uiBitmapID, eC_Value vXOffset=eC_FromInt(0), eC_Value vYOffset=eC_FromInt(0))
 
eC_Bool RequestFocus ()
 
void SetAlpha (eC_UByte ubAlpha)
 
void SetBehaviour (CGUIBehaviourDecorator *pkBehaviour)
 
void SetClickThrough (const eC_Bool &bClickThrough)
 
virtual void SetDisabled (const eC_Bool &bDisabled)
 
virtual void SetFocussable (const eC_Bool &bFocussable)
 
virtual void SetGrayedOut (const eC_Bool &bGrayOut)
 
virtual void SetHeight (const eC_Value &vY)
 
void SetID (const ObjectHandle_t &eID)
 
virtual void SetInvisible (const eC_Bool &bInvisible)
 
void SetLayouter (CGUILayouter *pLayouter)
 
void SetNeighborBottomID (const ObjectHandle_t eNewNeighborBottomID)
 
void SetNeighborIDs (const ObjectHandle_t eNewNeighborLeftID, const ObjectHandle_t eNewNeighborRightID, const ObjectHandle_t eNewNeighborTopID, const ObjectHandle_t eNewNeighborBottomID)
 
void SetNeighborLeftID (const ObjectHandle_t eNewNeighborLeftID)
 
void SetNeighborRightID (const ObjectHandle_t eNewNeighborRightID)
 
void SetNeighborTopID (const ObjectHandle_t eNewNeighborTopID)
 
virtual void SetParent (CGUICompositeObject *const pkParent)
 
void SetRelRect (const CGUIRect &kNewRect)
 
virtual void SetRelXPos (const eC_Value &vX)
 
void SetRelXPosCenter (const eC_Value &vXCenter)
 
void SetRelXPosREdge (const eC_Value &vX)
 
virtual void SetRelYPos (const eC_Value &vY)
 
void SetRelYPosBEdge (const eC_Value &vY)
 
void SetRelYPosCenter (const eC_Value &vYCenter)
 
void SetStopFocus (const eC_Bool &bDontFocusToParent)
 
virtual eC_Bool SetValue (CDataPoolEntry &rkValue)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
virtual void SetWidth (const eC_Value &vX)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool DoUserEvent (CGUIEvent *const pEvent)
 
virtual void OnCreate ()
 
virtual void OnDelete ()
 
virtual void OnHide ()
 
virtual void OnShow ()
 
virtual eC_Bool DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual eC_Bool Decrease ()
 
virtual eC_Bool Increase ()
 
virtual eC_Bool DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoScrollUp (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoScrollDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoScrollLeft (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoScrollRight (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
virtual void ReadFromStream ()
 
void SetXMLTag (const eC_String &kXMLTag)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIAnimatable
virtual ~CGUIAnimatable ()
 Destructor. Removes all existing animation callbacks.
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
virtual eC_Bool IsAnimating () const
 
virtual void StartAnimation ()
 
virtual void StopAnimation ()
 
- Public Member Functions inherited from CGUIColorPropertyObserver
 CGUIColorPropertyObserver ()
 default-constructor
 
 ~CGUIColorPropertyObserver ()
 destructor
 
eC_UInt AddColorProperty (const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)
 
void AddColorProperty (const eC_UInt &uiIndex, const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)
 
ColorValue_t GetColorProperty (const eC_UInt &uiIndex) const
 
eC_UInt GetColorValue (const eC_UInt &uiIndex) const
 
virtual void OnColorPropertyChange ()
 
virtual void OnNotification ()
 Called by CGUISubject whenever an observed object triggers an update. More...
 
void RemoveColorProperty (const eC_UInt &uiIndex)
 
void SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)
 
void SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)
 
void SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)
 
- Public Member Functions inherited from CGUIObserver
 CGUIObserver ()
 Default constructor.
 
virtual ~CGUIObserver ()
 Default destructor. Notifies all subjects of destruction.
 
const eC_TListDoubleLinked< CGUISubject * > & GetSubjectList () const
 
virtual void OnNotification ()
 Called by CGUISubject whenever an observed object triggers an update. More...
 
virtual void OnNotification (const CGUIObject *const pkUpdatedObject)
 
virtual void OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)
 
virtual void OnNotification (const eC_String &kMessage)
 
void SetAutoDelete (const eC_Bool bAutoDelete)
 

Protected Attributes

ImageResource_t m_eBackgroundImg
 ID of the background image.
 
CGUINinePatch m_kNinePatch
 the nine patch
 
- Protected Attributes inherited from CGUIBaseTextField
CGUIText * m_pkText
 The text displayed by this text field.
 

Additional Inherited Members

- Public Types inherited from CGUIObject
enum  FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
 
- Static Public Attributes inherited from CGUIBaseTextField
static const eC_Char XMLTAG_BASETEXTFIELD []
 xml-tag for the class itself
 
static const eC_Char XMLTAG_BASETEXTFIELD_BACKGROUNDCOLOR []
 xml-tag for background-color
 
- Static Public Attributes inherited from CGUIObject
static const eC_Char XMLTAG_ALPHA []
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH []
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID []
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED []
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE []
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT []
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT []
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE []
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID []
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS []
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_WIDTH []
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS []
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS []
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID []
 XML tag to be used when writing a behaviour class ID into a stream.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION []
 
- Protected Member Functions inherited from CGUIObject
virtual eC_Bool CreateBitmapPlane ()
 
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
- Protected Member Functions inherited from CGUIStreamableObject
eC_UInt ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const
 
void WriteStreamingFooter (const eC_Bool &bWriteClassID) const
 
void WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const
 
- Protected Member Functions inherited from CGUIObserver
virtual void AddSubject (CGUISubject *pSubjectToAdd)
 
virtual void RemoveSubject (CGUISubject *pSubjectToRemove)
 

Detailed Description

Represents a simple GUI object containing a text.

The "text field" control is used to display a single text. It supports an optional image that can be drawn as background of the text (Class: CGUITextField).

Objects of this class can be used as a single text somewhere in the GUI, when there is no other control around it. For instance, you might want to print a text directly on a window, not inside a button (which can have its own text) or another control.

In addition to its base class CGUIBaseTextField, this control manages an image that is drawn as the background of the actual text. If no image is set, the draw method of the base class is called (CGUIBaseTextField::DoDraw()).

CGUITextField should *not* be used to represent texts inside custom controls. To do that, have a look at CGUIText.

For details on the methods of this class also see the description of its base class CGUIBaseTextField.

Example:

// Create text field.
CGUITextField* pkTextField = new CGUITextField(this,
eC_FromInt(0), eC_FromInt(0),
eC_FromInt(500), eC_FromInt(30),
"Hello World!",
false,
DUMMY_IMAGE,
NO_HANDLE);
// Set the background image of the TextField.
// Before calling this method, please add image ID to UserImageResource.h and
// call GETRESMANAGER.RegisterImageResource() to register an image for this image ID.
pkTextField->SetBackgroundImage(IMG_BG_TEXTFIELD);
// Change the displayed text string
CGUIText* pkLabel = pkTextField->GetLabel();
if (pkLabel) pkLabel->SetTextString("New Text");
// Change the internal text object.
CGUIText* pkText = new CGUIText(this,"Good!",eC_FromInt(0), eC_FromInt(0),true);
pkTextField->SetText(pkText);
CGUIBaseTextField::GetLabel
const CGUIText * GetLabel() const
Definition: GUIBaseTextField.h:164
CGUIBaseTextField::SetText
void SetText(CGUIText *pkText)
CGUITextField
Represents a simple GUI object containing a text.
Definition: GUITextField.h:83
CGUITextField::SetBackgroundImage
void SetBackgroundImage(const ImageResource_t &eBackgroundImg)
CGUITextField::CGUITextField
CGUITextField()
CGUIText
Class for handling a text.
Definition: GUIText.h:103
CGUIText::SetTextString
void SetTextString(const eC_String *pkTextString)

Constructor & Destructor Documentation

◆ CGUITextField() [1/6]

CGUITextField::CGUITextField ( CGUICompositeObject *const  pkParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const eC_String &  kText,
const eC_Bool &  bMultiLine = false,
const ImageResource_t &  eBackgroundImg = DUMMY_IMAGE,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructs a text field from a string and area values.

Parameters
pkParentPointer to the designated parent object
vXX-position relative to its parent object
vYY-position relative to its parent object
vWidthWidth of the textfield
vHeightHeight of the textfield
kTexttext string to be displayed on the textfield
bMultiLineWhether the internal CGUIText is multi-line
eBackgroundImgimage-id of the background image
eIDObject Identifier of this textfield (choose NO_HANDLE if none is required)

◆ CGUITextField() [2/6]

CGUITextField::CGUITextField ( CGUICompositeObject *const  pkParent,
const CGUIRect &  kRect,
const eC_String &  kText,
const eC_Bool &  bMultiLine = false,
const ImageResource_t &  eBackgroundImg = DUMMY_IMAGE,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructs a text field from a string and a rectangle area.

Parameters
pkParentPointer to the designated parent object
kRectPosition and size of the text field
kTexttext string to be displayed on the textfield
bMultiLineWhether the internal CGUIText is multi-line
eBackgroundImgimage-id of the background image
eIDObject Identifier of this textfield (choose NO_HANDLE if none is required)

◆ CGUITextField() [3/6]

CGUITextField::CGUITextField ( CGUICompositeObject *const  pkParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const TextResource_t &  eTextID,
const eC_Bool &  bMultiLine = false,
const ImageResource_t &  eBackgroundImg = DUMMY_IMAGE,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructs a text field from a text ID and area values.

Parameters
pkParentPointer to the designated parent object
vXX-position relative to its parent object
vYY-position relative to its parent object
vWidthWidth of the textfield
vHeightHeight of the textfield
eTextIDID of text string to be displayed on the text field
bMultiLineWhether the internal CGUIText is multi-line
eBackgroundImgimage-id of the background image
eIDObject Identifier of this textfield (choose NO_HANDLE if none is required)

◆ CGUITextField() [4/6]

CGUITextField::CGUITextField ( CGUICompositeObject *const  pkParent,
const CGUIRect &  kRect,
const TextResource_t &  eTextID,
const eC_Bool &  bMultiLine = false,
const ImageResource_t &  eBackgroundImg = DUMMY_IMAGE,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructs a text field from a text ID and a rectangle area.

Parameters
pkParentPointer to the designated parent object
kRectPosition and size of the text field
eTextIDID of text string to be displayed on the text field
bMultiLineWhether the internal CGUIText is multi-line
eBackgroundImgimage-id of the background image
eIDObject Identifier of this textfield (choose NO_HANDLE if none is required)

◆ ~CGUITextField()

CGUITextField::~CGUITextField ( )

Destructor.

◆ CGUITextField() [5/6]

CGUITextField::CGUITextField ( const CGUITextField &  kSource)

CGUITextField copy-constructor.

Parameters
kSourceSource object to be copied

◆ CGUITextField() [6/6]

CGUITextField::CGUITextField ( )

Standard constructor. Only to be used by factories.

Member Function Documentation

◆ DoDraw()

eC_Bool CGUITextField::DoDraw ( )
virtual

Visualizes the object. It is forbidden to call SetRelXPos, SetRelYPos, SetWidth or SetHeight in DoDraw, i.e., it is not allowed to change the layout.

Returns
True if anything was drawn, False otherwise

Reimplemented from CGUIBaseTextField.

◆ operator=()

CGUITextField & CGUITextField::operator= ( const CGUITextField &  kSource)

CGUITextField operator= to copy the whole CGUITextField.

Parameters
kSourceSource object to be copied
Returns
Copied object

◆ ReadFromStream()

virtual void CGUITextField::ReadFromStream ( )
virtual

Reads all object attributes from streaming file. Only for use with GUIFactory. GUIStreamingFileReader has to be set in CGUI::Init().

See also
CGUIFactory

Reimplemented from CGUIBaseTextField.

Reimplemented in CGUIListItem, and CGUIScrollingTextField.

◆ SetBackgroundImage()

void CGUITextField::SetBackgroundImage ( const ImageResource_t &  eBackgroundImg)

Set the background image of the TextField.

Parameters
eBackgroundImgID of the background image to be set.

◆ WriteToStream()

virtual void CGUITextField::WriteToStream ( const eC_Bool  bWriteClassID = false)
virtual

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters
bWriteClassIDThis flag is used to select if writing of ControlID, leading and trailing tags is performed. Only GUIStreamWriter and GUICompositeObject have to set this flag true.
See also
CGUIStreamWriter

Reimplemented from CGUIBaseTextField.

Reimplemented in CGUIListItem, and CGUIScrollingTextField.

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