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

Input field specialization that uses images for graphical representation. More...

#include <GUIInputField.h>

Inheritance diagram for CGUIInputField:
Inheritance graph
[legend]

Public Member Functions

 CGUIInputField ()
 
 CGUIInputField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &rkText, CGUIEdit::AcceptedChars_t eAcceptedChars=CGUIEdit::AC_ALL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIInputField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &rkText, CGUIEdit::AcceptedChars_t eAcceptedChars=CGUIEdit::AC_ALL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIInputField (const CGUIInputField &kSource)
 
virtual ~CGUIInputField ()
 
CGUINinePatch & GetNinePatch ()
 
CGUIInputField & operator= (const CGUIInputField &kSource)
 
virtual void ReadFromStream ()
 
void SetImages (const ImageResource_t &eStandard, const ImageResource_t &eHighlighted, const ImageResource_t &eFocussed, const ImageResource_t &eGrayedOut)
 
void SetStandardImages ()
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBaseInputField
 CGUIBaseInputField ()
 
 CGUIBaseInputField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &rkText, CGUIEdit::AcceptedChars_t eAcceptedChars=CGUIEdit::AC_ALL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseInputField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &rkText, CGUIEdit::AcceptedChars_t eAcceptedChars=CGUIEdit::AC_ALL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseInputField (const CGUIBaseInputField &kSource)
 
 ~CGUIBaseInputField ()
 
void AddInputFinishedObserver (CGUIObserver *pkObserver)
 
void AddInputStartedObserver (CGUIObserver *pkObserver)
 
void AddTextChangedObserver (CGUIObserver *pkObserver)
 
eC_Bool DoButtonDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoDraw ()
 
virtual eC_Bool DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
CGUIEdit::AcceptedChars_t GetAcceptedChars () const
 
eC_Value GetBorderWidthBottom () const
 
eC_Value GetBorderWidthLeft () const
 
eC_Value GetBorderWidthRight () const
 
void GetBorderWidths (eC_Value &vLeft, eC_Value &vRight, eC_Value &vTop, eC_Value &vBottom) const
 
eC_Value GetBorderWidthTop () const
 
CGUIEdit * GetEdit () const
 
void GetFocus ()
 
CGUIEditableText * GetLabel ()
 
eC_Int GetMaxLength () const
 
eC_String GetPassword () const
 
eC_UInt GetSelectedTextColor () const
 
eC_String GetText () const
 
CGUIValidator * GetValidator ()
 
void LoseFocus ()
 
CGUIBaseInputField & operator= (const CGUIBaseInputField &kSource)
 
virtual void ReadFromStream ()
 
void RemoveInputFinishedObserver (CGUIObserver *pkObserver)
 
void RemoveInputStartedObserver (CGUIObserver *pkObserver)
 
virtual void RemoveObject (CGUIObject *pkObject)
 
void RemoveTextChangedObserver (CGUIObserver *pkObserver)
 
void SetAcceptedChars (CGUIEdit::AcceptedChars_t eAcceptedChars)
 
void SetActionCommand (CGUICommandPtr pkCommand)
 
void SetBorderWidth (eC_Value vBorderWidth)
 
void SetBorderWidths (eC_Value vLeftBorder, eC_Value vRightBorder, eC_Value vTopBorder, eC_Value vBottomBorder)
 
void SetHeight (const eC_Value &vHeight)
 
void SetLabel (CGUIEditableText *pkText)
 
void SetMaxLength (eC_Int iMaxLength)
 
void SetPasswordMode (eC_String &kPwdStr)
 
void SetSelectedTextColor (eC_UInt uiCol) const
 
virtual void SetText (const eC_String &rkTextString)
 
void SetValidator (CGUIValidator *pValidator)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
void SetWidth (const eC_Value &vWidth)
 
virtual void StartEditing ()
 
void Validate ()
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUICompositeObject
 CGUICompositeObject ()
 
 CGUICompositeObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUICompositeObject (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)
 
 CGUICompositeObject (const CGUICompositeObject &kSource)
 
virtual ~CGUICompositeObject ()
 This destructor is automatically virtual, as the base class destructor is virtual.
 
virtual eC_Bool AddObject (CGUIObject *pkObject)
 
eC_Bool BringToFront (const CGUIObject *pkObject)
 
eC_Bool CanBeCyclicFocussed () const
 
virtual eC_Bool DoPostDraw ()
 
void DrawOnTop (CGUIObject *pkObject)
 
void DrawOnTopOf (CGUIObject *const pkObject, CGUIObject *const pDrawOnTopOf)
 
virtual CGUIObject * FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
void Flip (const eC_Bool &rbVertical)
 
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)
 
CGUIObject * GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)
 
const CGUIObject * GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const
 
CGUIObject * GetChild (const eC_UInt uIndex)
 
CGUIObject * GetChild (const eC_UInt uIndex) const
 
const ObjectPtrList & GetChildObjectsList () const
 
const ObjectPtrList & GetDrawOrderList () const
 
eC_Int GetIndexOfChild (const CGUIObject *pkObject) const
 
eC_UInt GetNumberOfChildren () 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
 
eC_Bool InsertChildAt (const eC_UInt cuiIndex, CGUIObject *pkChild)
 
void InvalidateChildren ()
 Invalidates all chidren, but not this parent.
 
eC_Bool IsAncestorOf (const CGUIObject *pkObject) const
 
virtual eC_Bool IsCompositeObject () const
 
eC_Bool LowerOneLevel (const CGUIObject *pkObject)
 
CGUICompositeObject & operator= (const CGUICompositeObject &kSource)
 
eC_Bool RaiseOneLevel (const CGUIObject *pkObject)
 
virtual void ReadFromStream ()
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveAllChildren ()
 
virtual void RemoveObject (CGUIObject *pkObject)
 
void Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)
 
eC_Bool SendToBack (const CGUIObject *pkObject)
 
virtual void SetClickThrough (const eC_Bool &bClickThrough)
 
virtual void SetClickThrough (const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough)
 
void SetCyclicFocus (const eC_Bool &bCyclicFocus)
 
virtual void SetDisabled (const eC_Bool &bDisabled)
 
virtual void SetDisabled (const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled)
 
virtual void SetFocussable (const eC_Bool &bFocussable)
 
virtual void SetFocussable (const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable)
 
virtual void SetGrayedOut (const eC_Bool &bGrayedOut)
 
virtual void SetGrayedOut (const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut)
 
virtual void SetHeight (const eC_Value &vY)
 
virtual void SetInvisible (const eC_Bool &bInvisible)
 
virtual void SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)
 
virtual void SetWidth (const eC_Value &vX)
 
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 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 eC_Bool Decrease ()
 
virtual eC_Bool Increase ()
 
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 ()
 

Protected Member Functions

virtual eC_Bool DoDraw ()
 
- Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
ObjectPtrList & GetChildObjectsList ()
 
virtual void HandleDraw (const CGUIRect &ClipRect)
 
- 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 Attributes

ImageResource_t m_eFocussed
 The focused image.
 
ImageResource_t m_eGrayedOut
 The grayed out image.
 
ImageResource_t m_eHighlighted
 The highlighted image.
 
ImageResource_t m_eNormal
 The standard image.
 
CGUINinePatch m_kNinePatch
 The nine patch.
 
- Protected Attributes inherited from CGUIBaseInputField
CGUISubject m_kInputFinishedSubject
 Subject informing observers whenever the input is finished.
 
CGUISubject m_kInputStartedSubject
 Subject informing observers whenever the input has started.
 
CGUICommandPtr m_pkActionCmd
 
CGUIEdit * m_pkEdit
 The internal edit 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 CGUICompositeObject
static const eC_Char XMLTAG_CHILDREN []
 XML comment tag to be used before writing children to a stream.
 
static const eC_Char XMLTAG_ENDCHILDREN []
 XML comment tag to be used after writing children to a stream.
 
- 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 []
 

Detailed Description

Input field specialization that uses images for graphical representation.

The "input field" control is used for single line text input. To easily scale the dimension of the input field, it is composed out of three different images. One for the left side, one for the right side and one for the center (Class: CGUIInputField). The "input field" supports nine patch images (CGUINinePatch).
The input field can also be used for inserting passwords. Then you will see an asterisk for each character you typed in (Class CGUIInputField).

The input field consists of three different images. One for the left side, one for the right side and one for the center. The side images are optional. The center image is mandatory and will be automatically stretched to the correct size. If Guiliani standard images are enabled, a default background image is set automatically.

These images can be set in four different states (highlighted, focused, grayed out and standard).

Example:

// Create an input field.
CGUIInputField *pkInputField = new CGUIInputField(this,
eC_FromInt(0), eC_FromInt(0),
eC_FromInt(110), eC_FromInt(30),
"Hello", CGUIEdit::AC_ALL,
OBJ_INPUTFIELD);
// Set the images
// Before calling this method, please add image IDs to UserImageResource.h.
// After that call GETRESMANAGER.RegisterImageResource() to register images for image IDs.
pkInputField->SetImages(IMG_STANDARD, IMG_HIGHLIGHTED, IMG_FOCUSSED, IMG_GRAYED_OUT);
CGUIEdit::AC_ALL
@ AC_ALL
All characters.
Definition: GUIEdit.h:72
CGUIInputField
Input field specialization that uses images for graphical representation.
Definition: GUIInputField.h:69
CGUIInputField::SetImages
void SetImages(const ImageResource_t &eStandard, const ImageResource_t &eHighlighted, const ImageResource_t &eFocussed, const ImageResource_t &eGrayedOut)

Constructor & Destructor Documentation

◆ CGUIInputField() [1/4]

CGUIInputField::CGUIInputField ( CGUICompositeObject *const  pkParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const eC_String &  rkText,
CGUIEdit::AcceptedChars_t  eAcceptedChars = CGUIEdit::AC_ALL,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructor.

Parameters
pkParentPointer to the designated parent object
vXX-position relative to its parent object
vYX-position relative to its parent object
vWidthWidth of the input field
vHeightHeight of the input field
rkTextInitial text to be shown in the input field
eAcceptedCharsThe character set accepted as input.
eIDObject Identifier of this input field (use NO_HANDLE if none is required)

◆ CGUIInputField() [2/4]

CGUIInputField::CGUIInputField ( CGUICompositeObject *const  pkParent,
const CGUIRect &  kRect,
const eC_String &  rkText,
CGUIEdit::AcceptedChars_t  eAcceptedChars = CGUIEdit::AC_ALL,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructor.

Parameters
pkParentPointer to the designated parent object
kRectThe client rectangle (control position and size).
rkTextInitial text to be shown in the input field
eAcceptedCharsThe character set accepted as input.
eIDObject Identifier of this input field (use NO_HANDLE if none is required)

◆ ~CGUIInputField()

virtual CGUIInputField::~CGUIInputField ( )
virtual

Destructor

◆ CGUIInputField() [3/4]

CGUIInputField::CGUIInputField ( const CGUIInputField &  kSource)

Copy constructor.

Parameters
kSourceSource object to be copied.

◆ CGUIInputField() [4/4]

CGUIInputField::CGUIInputField ( )

Standard constructor.

See also
CGUIObject().

Member Function Documentation

◆ DoDraw()

virtual eC_Bool CGUIInputField::DoDraw ( )
protectedvirtual

Draws the images if set, otherwise calls the base class implementation.

Returns
True if something was painted, otherwise False.

Reimplemented from CGUIBaseInputField.

◆ GetNinePatch()

CGUINinePatch & CGUIInputField::GetNinePatch ( )
inline

Grants access to the object's nine patch.

Returns
Nine patch used to display the object

◆ operator=()

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

Assignment operator method of the CGUIBaseInputField class.

Parameters
kSourceSource object to be copied.
Returns
Copied object.

◆ ReadFromStream()

virtual void CGUIInputField::ReadFromStream ( )
virtual

Reads composite object attributes and children from stream.

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also
CGUIObject::ReadFromStream()
Exceptions
CGUIStreamingControlExceptionWhen catching a CGUIStreamingControlException from a child, this method adds the object from the exception, resets the object pointer to 'this', then re-throws.

Reimplemented from CGUIBaseInputField.

◆ SetImages()

void CGUIInputField::SetImages ( const ImageResource_t &  eStandard,
const ImageResource_t &  eHighlighted,
const ImageResource_t &  eFocussed,
const ImageResource_t &  eGrayedOut 
)

This functions sets the images to use if the control is in the respective state.

Parameters
eStandardstandard-image
eHighlightedhighlighted image
eFocussedfocussed image
eGrayedOutgrayedout image

◆ SetStandardImages()

void CGUIInputField::SetStandardImages ( )

Use this function to set standard images for all states.

◆ WriteToStream()

virtual void CGUIInputField::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 CGUIBaseInputField.

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