This class represents an onscreenkeyboard. More...

#include <GUIOnscreenKeyboard.h>

Inheritance diagram for CGUIOnscreenKeyboard:

[legend]

Classes
struct	SelectedButton_t
	selected button More...

Public Member Functions
	CGUIOnscreenKeyboard ()

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

	~CGUIOnscreenKeyboard ()

virtual void	DoAnimate (const eC_Value &vTimes=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	DoDraw ()

eC_Bool	GetAllowSubChars () const

eC_UInt	GetBackgroundColor () const

eC_UInt	GetBackgroundColorSelected () const

ImageResource_t	GetBackgroundImage () const

ImageResource_t	GetBackgroundImageSelected () const

FontResource_t	GetFont () const

eC_UInt	GetFontColor () const

eC_UInt	GetFontColorSelected () const

CGUIOnscreenKeyboardLayout *	GetLayout () const

CGUINinePatch &	GetNinePatch ()

eC_UInt	GetOverlayColor () const

ImageResource_t	GetOverlayImage () const

eC_UInt	GetPageIndex () const

ObjectHandle_t	GetTargetObject () const

eC_Bool	GetUseOverlay () const

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	SetAllowSubChars (const eC_Bool &bAllowSubChars)

void	SetBackgroundColor (const eC_UInt &uiColor)

void	SetBackgroundColor (const GlobalProperty_t &eProperty)

void	SetBackgroundColorSelected (const eC_UInt &uiColor)

void	SetBackgroundColorSelected (const GlobalProperty_t &eProperty)

void	SetBackgroundImage (const ImageResource_t &eImage)

void	SetBackgroundImageSelected (const ImageResource_t &eImage)

void	SetFont (const FontResource_t &eFont)

void	SetFontColor (const eC_UInt &uiColor)

void	SetFontColor (const GlobalProperty_t &eProperty)

void	SetFontColorSelected (const eC_UInt &uiColor)

void	SetFontColorSelected (const GlobalProperty_t &eProperty)

virtual void	SetHeight (const eC_Value &vHeight)

void	SetLayout (CGUIOnscreenKeyboardLayout *pkLayout)

void	SetOverlayColor (const eC_UInt &uiColor)

void	SetOverlayColor (const GlobalProperty_t &eProperty)

void	SetOverlayImage (const ImageResource_t &eImage)

void	SetPageIndex (const eC_UByte &ubPageIndex)

void	SetTargetObject (const ObjectHandle_t &eObjectID)

void	SetUseOverlay (const eC_Bool &bUseOverlay)

virtual void	SetWidth (const eC_Value &vWidth)

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

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 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 []

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 inherited from CGUIObject
UUID_t	m_kUUID
	UUID of object.

Detailed Description

This class represents an onscreenkeyboard.

Constructor & Destructor Documentation

◆ CGUIOnscreenKeyboard() [1/2]

CGUIOnscreenKeyboard::CGUIOnscreenKeyboard	(	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`
	)

constructor.

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the object
vHeight	Height of the object
eID	of this object

◆ CGUIOnscreenKeyboard() [2/2]

CGUIOnscreenKeyboard::CGUIOnscreenKeyboard ( )

default constructor

◆ ~CGUIOnscreenKeyboard()

CGUIOnscreenKeyboard::~CGUIOnscreenKeyboard ( )

destructor

Member Function Documentation

◆ DoAnimate()

virtual void CGUIOnscreenKeyboard::DoAnimate ( const eC_Value & vTimes = eC_FromInt(1) )

virtual

Called when the timer of an animation callback belonging to this animatable has expired.

Parameters

vTimes The factor of the registered callback time in relation to the actually elapsed time. For example, the elapsed time is 80ms, and the standard time is 50ms, then vTimes is 1.6. If the given time in GETTIMER.AddAnimationCallback is 0, It will be set to -1.

Reimplemented from CGUIAnimatable.

◆ DoButtonDown()

virtual eC_Bool CGUIOnscreenKeyboard::DoButtonDown	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse button or finger is pressed down over an object.

Note: DoButtonDown() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the object was pressed relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns: True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

◆ DoButtonUp()

virtual eC_Bool CGUIOnscreenKeyboard::DoButtonUp	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse button or finger is released. The object under the mouse at the time of releasing will receive this event.

Note: DoButtonUp() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on an object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the button was released relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the mouse was released.
vAbsY	Y-position in screen coordinates where the mouse was released.

Returns: True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

◆ DoDrag()

virtual eC_Bool CGUIOnscreenKeyboard::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

Called when the object receives a Drag event. Drags are typically created if the mouse is being used while a mouse-button is being pressed, or if the user moves his finger over a touchscreen.

Parameters

vDeltaX	relative movement in x-direction since the last call of DoDrag/ButtonDown
vDeltaY	relative movement in y-direction since the last call of DoDrag/ButtonDown
vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDraw()

virtual eC_Bool CGUIOnscreenKeyboard::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 CGUIObject.

◆ GetAllowSubChars()

eC_Bool CGUIOnscreenKeyboard::GetAllowSubChars ( ) const

get allow subchars

Returns: true if allowed

◆ GetBackgroundColor()

eC_UInt CGUIOnscreenKeyboard::GetBackgroundColor ( ) const

Get background-color

Returns: background-color

◆ GetBackgroundColorSelected()

eC_UInt CGUIOnscreenKeyboard::GetBackgroundColorSelected ( ) const

Get selected background-color

Returns: color

◆ GetBackgroundImage()

ImageResource_t CGUIOnscreenKeyboard::GetBackgroundImage ( ) const

Get background-image

Returns: background-image

◆ GetBackgroundImageSelected()

ImageResource_t CGUIOnscreenKeyboard::GetBackgroundImageSelected ( ) const

Get selected background-image

Returns: image

◆ GetFont()

FontResource_t CGUIOnscreenKeyboard::GetFont ( ) const

Get font

Returns: font

◆ GetFontColor()

eC_UInt CGUIOnscreenKeyboard::GetFontColor ( ) const

Get font-color

Returns: font-color

◆ GetFontColorSelected()

eC_UInt CGUIOnscreenKeyboard::GetFontColorSelected ( ) const

Get selected font-color

Returns: color

◆ GetLayout()

CGUIOnscreenKeyboardLayout * CGUIOnscreenKeyboard::GetLayout ( ) const

get the currently set layout

Returns: layout

◆ GetNinePatch()

CGUINinePatch & CGUIOnscreenKeyboard::GetNinePatch ( )

Get ninepatch for images

Returns: nine-patch

◆ GetOverlayColor()

eC_UInt CGUIOnscreenKeyboard::GetOverlayColor ( ) const

Get overlay-color

Returns: color

◆ GetOverlayImage()

ImageResource_t CGUIOnscreenKeyboard::GetOverlayImage ( ) const

Get overlay-image

Returns: image

◆ GetPageIndex()

eC_UInt CGUIOnscreenKeyboard::GetPageIndex ( ) const

Get index of currently activee page

Returns: index

◆ GetTargetObject()

ObjectHandle_t CGUIOnscreenKeyboard::GetTargetObject ( ) const

Get ObjectID of editfield

Returns: objectID

◆ GetUseOverlay()

eC_Bool CGUIOnscreenKeyboard::GetUseOverlay ( ) const

get use overlay

Returns: true if active

◆ LoadLayout() [1/3]

eC_Bool CGUIOnscreenKeyboard::LoadLayout ( const eC_String & rkLayoutFile )

Load a keyboard-layout from a file

Parameters

rkLayoutFile

Returns: true on success, otherwise false

◆ LoadLayout() [2/3]

void CGUIOnscreenKeyboard::LoadLayout ( const GeneralResource_t & reResource )

Load a keyboard-layout using general resources

Parameters

reResource the ID of the resource to use

◆ LoadLayout() [3/3]

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

Load a keyboard-layout from a file

Parameters

pkFile	file to load from
kFileExtension	extension of file to choose correct loader

Returns: true on success, otherwise false

◆ ReadFromStream()

virtual void CGUIOnscreenKeyboard::ReadFromStream ( )

virtual

Reads all attributes from streaming file. This method is called by CGUIFactoryManager after one of the registered factories has created an instance of this class.

Reimplemented from CGUIObject.

◆ SetAllowSubChars()

void CGUIOnscreenKeyboard::SetAllowSubChars ( const eC_Bool & bAllowSubChars )

set to allow subchars

Parameters

bAllowSubChars

◆ SetBackgroundColor() [1/2]

void CGUIOnscreenKeyboard::SetBackgroundColor ( const eC_UInt & uiColor )

Set background-color as color

Parameters

uiColor

◆ SetBackgroundColor() [2/2]

void CGUIOnscreenKeyboard::SetBackgroundColor ( const GlobalProperty_t & eProperty )

Set background-color as property

Parameters

eProperty

◆ SetBackgroundColorSelected() [1/2]

void CGUIOnscreenKeyboard::SetBackgroundColorSelected ( const eC_UInt & uiColor )

Set selected background-color as color

Parameters

uiColor

◆ SetBackgroundColorSelected() [2/2]

void CGUIOnscreenKeyboard::SetBackgroundColorSelected ( const GlobalProperty_t & eProperty )

Set selected background-color as property

Parameters

eProperty

◆ SetBackgroundImage()

void CGUIOnscreenKeyboard::SetBackgroundImage ( const ImageResource_t & eImage )

Set background-image

Parameters

eImage

◆ SetBackgroundImageSelected()

void CGUIOnscreenKeyboard::SetBackgroundImageSelected ( const ImageResource_t & eImage )

Set selected background image

Parameters

eImage

◆ SetFont()

void CGUIOnscreenKeyboard::SetFont ( const FontResource_t & eFont )

Set font

Parameters

eFont

◆ SetFontColor() [1/2]

void CGUIOnscreenKeyboard::SetFontColor ( const eC_UInt & uiColor )

Set font-color as color

Parameters

uiColor

◆ SetFontColor() [2/2]

void CGUIOnscreenKeyboard::SetFontColor ( const GlobalProperty_t & eProperty )

Set font color as property

Parameters

eProperty

◆ SetFontColorSelected() [1/2]

void CGUIOnscreenKeyboard::SetFontColorSelected ( const eC_UInt & uiColor )

Set selected font-color as color

Parameters

uiColor

◆ SetFontColorSelected() [2/2]

void CGUIOnscreenKeyboard::SetFontColorSelected ( const GlobalProperty_t & eProperty )

Set selected font-color as property

Parameters

eProperty

◆ SetHeight()

virtual void CGUIOnscreenKeyboard::SetHeight ( const eC_Value & vY )

virtual

Sets this object's height to a new value.

Parameters

vY	the new height

Reimplemented from CGUIObject.

◆ SetLayout()

void CGUIOnscreenKeyboard::SetLayout ( CGUIOnscreenKeyboardLayout * pkLayout )

set the keyboard-layout

Parameters

pkLayout

◆ SetOverlayColor() [1/2]

void CGUIOnscreenKeyboard::SetOverlayColor ( const eC_UInt & uiColor )

Set overlay-color as color

Parameters

uiColor

◆ SetOverlayColor() [2/2]

void CGUIOnscreenKeyboard::SetOverlayColor ( const GlobalProperty_t & eProperty )

Set overlay-color as property

Parameters

eProperty

◆ SetOverlayImage()

void CGUIOnscreenKeyboard::SetOverlayImage ( const ImageResource_t & eImage )

Set overlay image

Parameters

eImage

◆ SetPageIndex()

void CGUIOnscreenKeyboard::SetPageIndex ( const eC_UByte & ubPageIndex )

Set index of currently active page

Parameters

ubPageIndex

◆ SetTargetObject()

void CGUIOnscreenKeyboard::SetTargetObject ( const ObjectHandle_t & eObjectID )

Set objectID of target editfield

Parameters

eObjectID of editfield

◆ SetUseOverlay()

void CGUIOnscreenKeyboard::SetUseOverlay ( const eC_Bool & bUseOverlay )

set to use overlay

Parameters

bUseOverlay

◆ SetWidth()

virtual void CGUIOnscreenKeyboard::SetWidth ( const eC_Value & vX )

virtual

Sets this object's width to a new value.

Parameters

vX	the new width

Reimplemented from CGUIObject.

◆ WriteToStream()

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

virtual

Writes all attributes to the streaming file. A CGUIStreamWriter has to be initialized first.

Parameters

bWriteClassID This flag is used to select if writing of control class ID, leading and trailing tags is performed.

Reimplemented from CGUIObject.

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

GUIOnscreenKeyboard.h

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUIOnscreenKeyboard() [1/2]

◆ CGUIOnscreenKeyboard() [2/2]

◆ ~CGUIOnscreenKeyboard()

Member Function Documentation

◆ DoAnimate()

◆ DoButtonDown()

◆ DoButtonUp()

◆ DoDrag()

◆ DoDraw()

◆ GetAllowSubChars()

◆ GetBackgroundColor()

◆ GetBackgroundColorSelected()

◆ GetBackgroundImage()

◆ GetBackgroundImageSelected()

◆ GetFont()

◆ GetFontColor()

◆ GetFontColorSelected()

◆ GetLayout()

◆ GetNinePatch()

◆ GetOverlayColor()

◆ GetOverlayImage()

◆ GetPageIndex()

◆ GetTargetObject()

◆ GetUseOverlay()

◆ LoadLayout() [1/3]

◆ LoadLayout() [2/3]

◆ LoadLayout() [3/3]

◆ ReadFromStream()

◆ SetAllowSubChars()

◆ SetBackgroundColor() [1/2]

◆ SetBackgroundColor() [2/2]

◆ SetBackgroundColorSelected() [1/2]

◆ SetBackgroundColorSelected() [2/2]

◆ SetBackgroundImage()

◆ SetBackgroundImageSelected()

◆ SetFont()

◆ SetFontColor() [1/2]

◆ SetFontColor() [2/2]

◆ SetFontColorSelected() [1/2]

◆ SetFontColorSelected() [2/2]

◆ SetHeight()

◆ SetLayout()

◆ SetOverlayColor() [1/2]

◆ SetOverlayColor() [2/2]

◆ SetOverlayImage()

◆ SetPageIndex()

◆ SetTargetObject()

◆ SetUseOverlay()

◆ SetWidth()

◆ WriteToStream()