Guiliani  Version 2.6 revision 7293 (documentation build 12)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CGUIKeyboard Class Reference
Controls

A basic on-screen keyboard control. More...

#include <GUIKeyboard.h>

Inheritance diagram for CGUIKeyboard:
Inheritance graph
[legend]

Public Member Functions

 CGUIKeyboard ()
 
 CGUIKeyboard (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t eTargetObjectID, const ObjectHandle_t &eID=NO_HANDLE)
 
void GetColors (eC_UInt &uiColorStandard, eC_UInt &uiColorHighlighted, eC_UInt &uiColorGrayedOut, eC_UInt &uiColorPressed)
 
void GetImages (ImageResource_t &eImageNormal, ImageResource_t &eImageHighlighted, ImageResource_t &eImagePressed, ImageResource_t &eImageGrayedOut, ImageResource_t &eImageFocused)
 
GeneralResource_t GetLayout () const
 
void HandleKey (const eC_UInt uiKeycode)
 
eC_Bool LoadLayout (const eC_String &rkLayoutFile)
 
void LoadLayout (const GeneralResource_t &reResource)
 
eC_Bool LoadLayout (eC_File *pkFile, const eC_String &kFileExtension)
 
virtual void ReadFromStream ()
 
void SetColors (const eC_UInt &uiColorStandard, const eC_UInt &uiColorHighlighted, const eC_UInt &uiColorGrayedOut, const eC_UInt &uiColorPressed)
 
void SetColors (const GlobalProperty_t &eColorStandard, const GlobalProperty_t &eColorHighlighted, const GlobalProperty_t &eColorGrayedOut, const GlobalProperty_t &eColorPressed)
 
void SetFont (const FontResource_t &eFont)
 
void SetImages (const ImageResource_t &eImageNormal, const ImageResource_t &eImageHighlighted, const ImageResource_t &eImagePressed, const ImageResource_t &eImageGrayedOut, const ImageResource_t &eImageFocused)
 
void SetLayout (const GeneralResource_t &eLayout)
 
void SetTargetObject (const ObjectHandle_t eTargetObject)
 
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 (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 (CGUIObject *pkObject)
 
CGUICompositeObject & operator= (const CGUICompositeObject &kSource)
 
eC_Bool RaiseOneLevel (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 (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
 
UUID_t GetUUID () 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)
 
void SetUUID (const UUID_t &kUUID)
 
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 DoScale (const eC_Value &vDelta)
 
virtual eC_Bool DoUserEvent (CGUIEvent *const pEvent)
 
virtual void OnCreate ()
 
virtual void OnDataPool (const DataPoolResource_t &eID)
 
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 DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive)
 
- 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 Member Functions

void Init ()
 Initializes the keyboard.
 
- 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 Member Functions inherited from CGUIObserver
virtual void AddSubject (CGUISubject *pSubjectToAdd)
 
virtual void RemoveSubject (CGUISubject *pSubjectToRemove)
 

Protected Attributes

ObjectHandle_t m_eTargetObject
 ID of CGUIEdit which shall receive the keyboard's output.
 
- Protected Attributes inherited from CGUIObject
UUID_t m_kUUID
 UUID of object.
 

Additional Inherited Members

- Public Types inherited from CGUIObject
enum  FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
 
- Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t GenerateUUID ()
 
- 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_UUID []
 XML tag to be used when writing a UUID 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 const eC_Char XMLTAG_BEHAVIOURCOUNT []
 XML tag for count.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION []
 

Detailed Description

A basic on-screen keyboard control.

The "keyboard" control is a fully customizable. Offering all necessary means for standard QWERTY layout up to phone-style keyboards. Application specific symbols or images can be integrated easily. There are no limitations in the number or sizes of the keyboard buttons, making usage of Guiliani's intelligent layouters for a perfect positioning (Class: CGUIKeyboard).

This implements a basic OnScreen-Keyboard with four different layouts. (ASCII characters, ASCII capital Letters, Numerical, Symbolic) The keyboard's buttons send their corresponding keycodes to a defineable CGUIEdit in the GUI. The CGUIEdit is chosen via the CGUIKeyboard::SetTargetObject() API and will be the target for ALL subsequent key presses within ALL existing keyboard layouts.

The four default layouts can be created via the CreateDefaultLayouts() method. Alternatively you can create custom layouts by attaching a CGUIKeyboardBehaviour to your own custom controls. If you wish to use the existing default layouts, but change their visualization, you may inherit your own keyboard from CGUIKeyboard and override the CreateKeyboardButton() method. This will be called for all the buttons by CreateDefaultLayouts().

Example showing the creation of a keyboard with default layouts:

// Create keyboard
CGUIKeyboard* pkKeyboard = new CGUIKeyboard(pkMainWin, 0,0, eC_FromInt(300), eC_FromInt(100), OBJ_ID_OF_GUIEDIT, OBJ_KEYBOARD);
// Use default keyboard layouts
pkKeyboard->CreateDefaultLayouts();
// Set object which shall receive the keyboard output
CGUIKeyboard::SetTargetObject(OBJ_ID_OF_CGUIEDIT);
CGUIKeyboard
A basic on-screen keyboard control.
Definition: GUIKeyboard.h:99
CGUIKeyboard::SetTargetObject
void SetTargetObject(const ObjectHandle_t eTargetObject)
Definition: GUIKeyboard.h:175

Example of a custom keyboard which uses CGUIBlendButton instead of plain CGUIButton:

class CMyKeyboard : public CGUIKeyboard
{
public:
CMyKeyboard(
CGUICompositeObject* const pkParent,
const eC_Value& vX, const eC_Value& vY,
const eC_Value& vWidth, const eC_Value& vHeight,
const ObjectHandle_t eTargetObjectID,
const ObjectHandle_t &eID = NO_HANDLE)
: CGUIKeyboard(pkParent, vX, vY, vWidth, vHeight, eTargetObjectID, eID)
{};
// Gets called for every button during the creation of the default layouts...
CGUIButton* CreateKeyboardButton(const eC_String& kLabel, const eC_UInt uiKeyCode, CGUICompositeObject* pkParent)
{
// Create a CGUIBlendButton
CGUIBlendButton* pButton = new CGUIBlendButton(pkParent, 0,0,0,0, kLabel, NULL, NO_HANDLE);
if (pButton)
{
// Set button attributes, such as Font, Images, NinePatch...
if (pButton->GetLabel())
{
pButton->GetLabel()->SetFont(FNT_KEYBOARD);
}
pButton->SetImages(IMG_STDCTRL_KEYBOARDBTN_STANDARD, IMG_STDCTRL_KEYBOARDBTN_PRESSED, IMG_STDCTRL_KEYBOARDBTN_HIGHLIGHTED, IMG_STDCTRL_KEYBOARDBTN_GRAYED_OUT, IMG_STDCTRL_KEYBOARDBTN_FOCUSED);
pButton->GetNinePatch().Assign(5,5,5,5);
// Assign a CGUIKeyboardBehaviour which sends the given uiKeyCode when being pressed
pButton->SetBehaviour(new CGUIKeyboardBehaviour(uiKeyCode));
}
return pButton;
}
};
ObjectHandle_t
ObjectHandle_t
List of object resource ids.
Definition: GUIObjectHandleResource.h:55
CGUIBaseButton::GetLabel
CGUIText * GetLabel() const
CGUIBlendButton
Button specialization that softly blends between the button's different states.
Definition: GUIBlendButton.h:64
CGUIButton
Button specialization that uses images for graphical representation.
Definition: GUIButton.h:69
CGUIButton::SetImages
void SetImages(const ImageResource_t &eBtnStandard, const ImageResource_t &eBtnPressed, const ImageResource_t &eBtnHighlighted, const ImageResource_t &eBtnGrayedOut, const ImageResource_t &eBtnFocused)
CGUIButton::GetNinePatch
CGUINinePatch & GetNinePatch()
Definition: GUIButton.h:236
CGUICompositeObject
This is the Guiliani base class for all composite objects.
Definition: GUICompositeObject.h:70
CGUIKeyboardBehaviour
This behaviour sends a UTF16 keycode to the Keyboard in reaction to a ButtonUp-Event.
Definition: GUIKeyboardBehaviour.h:20
CGUINinePatch::Assign
void Assign(const eC_UInt &uiTop, const eC_UInt &uiBottom, const eC_UInt &uiLeft, const eC_UInt &uiRight)
Definition: GUINinePatch.h:60
CGUIObject::SetBehaviour
void SetBehaviour(CGUIBehaviourDecorator *pkBehaviour)
CGUIText::SetFont
virtual void SetFont(const FontResource_t &eFontID)

Constructor & Destructor Documentation

◆ CGUIKeyboard() [1/2]

CGUIKeyboard::CGUIKeyboard ( CGUICompositeObject *const  pkParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const ObjectHandle_t  eTargetObjectID,
const ObjectHandle_t &  eID = NO_HANDLE 
)

CGUIKeyboard constructor.

Parameters
pkParentPointer to the designated parent object
vXX-position relative to its parent object
vYY-position relative to its parent object
vWidthWidth of the object
vHeightHeight of the object
eTargetObjectIDHandle to a CGUIEdit which shall receive the output of the keyboard
eIDof this object

◆ CGUIKeyboard() [2/2]

CGUIKeyboard::CGUIKeyboard ( )

Standard constructor

Member Function Documentation

◆ GetColors()

void CGUIKeyboard::GetColors ( eC_UInt &  uiColorStandard,
eC_UInt &  uiColorHighlighted,
eC_UInt &  uiColorGrayedOut,
eC_UInt &  uiColorPressed 
)

Return the text-colors for the keyboard-buttons

Parameters
uiColorStandardstandard-color
uiColorHighlightedhighlighted-color
uiColorGrayedOutgrayedout-color
uiColorPressedpressed-color

◆ GetImages()

void CGUIKeyboard::GetImages ( ImageResource_t &  eImageNormal,
ImageResource_t &  eImageHighlighted,
ImageResource_t &  eImagePressed,
ImageResource_t &  eImageGrayedOut,
ImageResource_t &  eImageFocused 
)

Return the images for keyboard-buttons

Parameters
eImageNormalnormal-image
eImageHighlightedhighlighted-image
eImagePressedpressed-image
eImageGrayedOutgrayedout-image
eImageFocusedfocused-image

◆ GetLayout()

GeneralResource_t CGUIKeyboard::GetLayout ( ) const

Get the currently used layout

Returns
Resource-ID

◆ HandleKey()

void CGUIKeyboard::HandleKey ( const eC_UInt  uiKeycode)

Forwards the given KeyCode into the corresponding DoKeyDown and DoChar slots of the CGUIEdit identified by SetTargetObject().
Note that the following keycodes will be handled by calling DoKeyDown on the CGUIEdit:

KeyCodeName
0x0008GK_BACKSPACE
0x000DGK_ACTION
0x007FGK_DELETE
0x2190GK_LEFT
0x2192GK_RIGHT
Parameters
uiKeycodeUTF16 KeyCode which shall be handled.

◆ LoadLayout() [1/3]

eC_Bool CGUIKeyboard::LoadLayout ( const eC_String &  rkLayoutFile)

Load a keyboard-layout for the keyboard. This can be used to change the keyboard-layout according to the active language. This will replace all existing keys and load them from the file. The content of the layout-file is structured as follows:

<KeyboardLayout>
<Version>1</Version>
<Group> -> there are four groups in the keyboard representing the different types (uppercase, lowercase, numbers, symbols)
<RowCount>XXX</RowCount> -> this is the number of rows for the current group
<Row> -> definition for the current row
<CharCount>XXX</CharCount> -> number of characters in the current row
<Char>XXX</Char> -> the character representing the key (either single character, also UTF-16 or a special keyword -> below)
</Row>
</Group>
...
</KeyboardLayout>

Special Keywords: BACK -> is the backspace-key SPACE -> spacebar ENTER -> enter-key ABC -> switch to uppercase-group abc -> switch to lowercase-group 123 -> switch to number-group SYM -> switch to symbol-group

Parameters
rkLayoutFilethe file containing the description of the layout
Returns
true on success, otherwise false

◆ LoadLayout() [2/3]

void CGUIKeyboard::LoadLayout ( const GeneralResource_t &  reResource)

Load a keyboard-layout using general resources

Parameters
reResourcethe ID of the resource to use

◆ LoadLayout() [3/3]

eC_Bool CGUIKeyboard::LoadLayout ( eC_File *  pkFile,
const eC_String &  kFileExtension 
)

Load a keyboard-layout from a file

Parameters
pkFilefile to load from
kFileExtensionextension of file to choose correct loader
Returns
true on success, otherwise false

◆ ReadFromStream()

virtual void CGUIKeyboard::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 CGUICompositeObject.

◆ SetColors() [1/2]

void CGUIKeyboard::SetColors ( const eC_UInt &  uiColorStandard,
const eC_UInt &  uiColorHighlighted,
const eC_UInt &  uiColorGrayedOut,
const eC_UInt &  uiColorPressed 
)

Sets the text-colors for the keyboard-buttons

Parameters
uiColorStandardstandard-color
uiColorHighlightedhighlighted-color
uiColorGrayedOutgrayedout-color
uiColorPressedpressed-color

◆ SetColors() [2/2]

void CGUIKeyboard::SetColors ( const GlobalProperty_t &  eColorStandard,
const GlobalProperty_t &  eColorHighlighted,
const GlobalProperty_t &  eColorGrayedOut,
const GlobalProperty_t &  eColorPressed 
)

Sets the text-colors for the keyboard-buttons

Parameters
eColorStandardstandard-color
eColorHighlightedhighlighted-color
eColorGrayedOutgrayedout-color
eColorPressedpressed-color

◆ SetFont()

void CGUIKeyboard::SetFont ( const FontResource_t &  eFont)

Set font which is used by keyboard-buttons

Parameters
eFontfont-id

◆ SetImages()

void CGUIKeyboard::SetImages ( const ImageResource_t &  eImageNormal,
const ImageResource_t &  eImageHighlighted,
const ImageResource_t &  eImagePressed,
const ImageResource_t &  eImageGrayedOut,
const ImageResource_t &  eImageFocused 
)

Sets the images for keyboard-buttons

Parameters
eImageNormalnormal-image
eImageHighlightedhighlighted-image
eImagePressedpressed-image
eImageGrayedOutgrayedout-image
eImageFocusedfocused-image

◆ SetLayout()

void CGUIKeyboard::SetLayout ( const GeneralResource_t &  eLayout)

Set the current layout

Parameters
eLayoutResource-ID

◆ SetTargetObject()

void CGUIKeyboard::SetTargetObject ( const ObjectHandle_t  eTargetObject)
inline

Sets the CGUIEdit which will receive the output from all existing keyboards (or to be precise, from all CGUIKeyboardBehaviour instances). If no ID was explicitly given, the output will instead be sent to the currently focused object.

Note
If you choose to send the output to the currently focused object, you should make sure that they keyboard and its buttons are NOT focusable!
Parameters
eTargetObjectID of an instance of CGUIEdit

◆ WriteToStream()

virtual void CGUIKeyboard::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 CGUICompositeObject.

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