CGUIOnscreenKeyboardLayout Class Reference

Layout for an OnScreenKeyboard. More...

#include <GUIOnscreenKeyboardLayout.h>

Classes
struct	KeyboardKey_t
	struct for a key More...
struct	KeyboardLine_t
	keyboard line More...
struct	KeyboardPage_t
	page-struct More...
struct	KeyboardSubChars_t
	sub-chars More...

Public Types
enum	KeyboardKeyType_t {   KT_UNKNOWN = 0 , KT_PRINTABLE_KEY , KT_SPECIAL_KEY , KT_SEPARATOR ,   KT_PAGE_UPPERCASE , KT_PAGE_LOWERCASE , KT_PAGE_NUMBERS , KT_PAGE_SYMBOLS }
	type of key
enum	KeyboardPageType_t {   PT_UNKNOWN = 0 , PT_LOWERCASE , PT_UPPERCASE , PT_NUMBERS ,   PT_SYMBOLS }
	page-type

Public Member Functions
	CGUIOnscreenKeyboardLayout ()
virtual	~CGUIOnscreenKeyboardLayout ()
void	AddKey (KeyboardLine_t *pkLine)
void	AddLine (KeyboardPage_t *pkPage)
void	AddPage ()
void	AddSubKey (KeyboardKey_t *pkKey)
void	CalcKeyRects (const eC_Value &vWidth=eC_FromInt(0), const eC_Value &vHeight=eC_FromInt(0))
void	Clear ()
eC_Bool	DeleteKey (KeyboardKey_t *pkKey)
eC_Bool	DeleteLine (KeyboardLine_t *pkLine)
eC_Bool	DeletePage (KeyboardPage_t *pkPage)
eC_Bool	DeleteSubKey (KeyboardKey_t *pkKey)
eC_Bool	FindPage (const KeyboardPageType_t &ePageType, eC_UByte &ubIndex)
eC_UInt	GetNumberOfPages () const
KeyboardPage_t *	GetPage (const eC_UInt &uiIndex)
KeyboardPage_t *	GetPage (KeyboardKey_t *pkKey)
KeyboardPage_t *	GetPage (KeyboardLine_t *pkLine)
virtual void	ReadFromStream ()
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Detailed Description

Layout for an OnScreenKeyboard.

Constructor & Destructor Documentation

CGUIOnscreenKeyboardLayout()

CGUIOnscreenKeyboardLayout::CGUIOnscreenKeyboardLayout

(

)

default constructor

~CGUIOnscreenKeyboardLayout()

virtual CGUIOnscreenKeyboardLayout::~CGUIOnscreenKeyboardLayout ( )

virtual

destructor

Member Function Documentation

AddKey()

void CGUIOnscreenKeyboardLayout::AddKey

(

KeyboardLine_t *

pkLine

)

add a new key

Parameters

pkLine

AddLine()

void CGUIOnscreenKeyboardLayout::AddLine

(

KeyboardPage_t *

pkPage

)

add a new line

Parameters

pkPage

page

AddPage()

void CGUIOnscreenKeyboardLayout::AddPage

(

)

add a new page

AddSubKey()

void CGUIOnscreenKeyboardLayout::AddSubKey

(

KeyboardKey_t *

pkKey

)

add a new subkey

Parameters

pkKey

CalcKeyRects()

void CGUIOnscreenKeyboardLayout::CalcKeyRects	(	const eC_Value &	vWidth = eC_FromInt(0),
		const eC_Value &	vHeight = eC_FromInt(0)
	)

calculate the rects for each line and key

Parameters

vWidth	width
vHeight	height

Clear()

void CGUIOnscreenKeyboardLayout::Clear

(

)

clear the layout

DeleteKey()

eC_Bool CGUIOnscreenKeyboardLayout::DeleteKey

(

KeyboardKey_t *

pkKey

)

delete key

Parameters

pkKey

Returns

true if successful

DeleteLine()

eC_Bool CGUIOnscreenKeyboardLayout::DeleteLine

(

KeyboardLine_t *

pkLine

)

delete line

Parameters

pkLine

Returns

true if successful

DeletePage()

eC_Bool CGUIOnscreenKeyboardLayout::DeletePage

(

KeyboardPage_t *

pkPage

)

delete page

Parameters

pkPage

Returns

true if successful

DeleteSubKey()

eC_Bool CGUIOnscreenKeyboardLayout::DeleteSubKey

(

KeyboardKey_t *

pkKey

)

delete subkey

Parameters

pkKey

Returns

true if successful

FindPage()

eC_Bool CGUIOnscreenKeyboardLayout::FindPage	(	const KeyboardPageType_t &	ePageType,
		eC_UByte &	ubIndex
	)

find the page for the given type

Parameters

ePageType	page-type
ubIndex	index of page

Returns

true if page was found

GetNumberOfPages()

eC_UInt CGUIOnscreenKeyboardLayout::GetNumberOfPages

(

)

const

get the number of pages

Returns

number of pages

GetPage() [1/3]

KeyboardPage_t * CGUIOnscreenKeyboardLayout::GetPage

(

const eC_UInt &

uiIndex

)

get the page for index

Parameters

uiIndex

index

Returns

page

GetPage() [2/3]

KeyboardPage_t * CGUIOnscreenKeyboardLayout::GetPage

(

KeyboardKey_t *

pkKey

)

get the page including given key

Parameters

pkKey

key

Returns

page

GetPage() [3/3]

KeyboardPage_t * CGUIOnscreenKeyboardLayout::GetPage

(

KeyboardLine_t *

pkLine

)

get the page including the given line

Parameters

pkLine

line

Returns

page

ReadFromStream()

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

WriteToStream()

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

---

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

• GUIOnscreenKeyboardLayout.h