CGUIKeyboard Class Reference

#include <GUIKeyboard.h>

Inheritance diagram for CGUIKeyboard:

Public Member Functions
	CGUIKeyboard ()
	~CGUIKeyboard () override=default
virtual bool	ShowAndGetInput (char_callback_t pCallback, const std::string &initialString, std::string &typedString, const std::string &heading, bool bHiddenInput=false)=0
	each native keyboard needs to implement this function with the following behaviour:
virtual void	Cancel ()=0
	This call should cancel a currently shown keyboard dialog. The implementation should return false from the modal ShowAndGetInput once anyone calls this method.
virtual int	GetWindowId () const
void	OnTimeout () override
void	startAutoCloseTimer (unsigned int autoCloseMs)
void	resetAutoCloseTimer ()
virtual bool	SetTextToKeyboard (const std::string &text, bool closeKeyboard=false)
Public Member Functions inherited from ITimerCallback
virtual	~ITimerCallback ()=default

Constructor & Destructor Documentation

CGUIKeyboard()

CGUIKeyboard::CGUIKeyboard ( )

inline

~CGUIKeyboard()

CGUIKeyboard::~CGUIKeyboard ( )

overridedefault

Member Function Documentation

Cancel()

virtual void CGUIKeyboard::Cancel ( )

pure virtual

This call should cancel a currently shown keyboard dialog. The implementation should return false from the modal ShowAndGetInput once anyone calls this method.

Implemented in CGUIDialogKeyboardGeneric, CGUIDialogKeyboardTouch, and CDarwinEmbedKeyboard.

GetWindowId()

virtual int CGUIKeyboard::GetWindowId ( ) const

inlinevirtual

Reimplemented in CGUIDialogKeyboardGeneric, and CGUIDialogKeyboardTouch.

OnTimeout()

void CGUIKeyboard::OnTimeout ( )

inlineoverridevirtual

Implements ITimerCallback.

resetAutoCloseTimer()

void CGUIKeyboard::resetAutoCloseTimer ( )

inline

SetTextToKeyboard()

virtual bool CGUIKeyboard::SetTextToKeyboard ( const std::string & text, bool closeKeyboard = false )

inlinevirtual

Reimplemented in CGUIDialogKeyboardTouch, and CDarwinEmbedKeyboard.

ShowAndGetInput()

virtual bool CGUIKeyboard::ShowAndGetInput ( char_callback_t pCallback, const std::string & initialString, std::string & typedString, const std::string & heading, bool bHiddenInput = false )

pure virtual

each native keyboard needs to implement this function with the following behaviour:

Parameters

pCallback	implementation should call this on each keypress with the current whole string
initialString	implementation should show that initialstring
typedstring	returns the typed string after close if return is true
heading	implementation should show a heading (e.x. "search for a movie")
bHiddenInput	if true the implementation should obfuscate the user input (e.x. by printing "*" for each char)

Returns

- true if typedstring is valid and user has confirmed input - false if typedstring is undefined and user canceled the input

Implemented in CGUIDialogKeyboardGeneric, CGUIDialogKeyboardTouch, and CDarwinEmbedKeyboard.

startAutoCloseTimer()

void CGUIKeyboard::startAutoCloseTimer ( unsigned int autoCloseMs )

inline

---

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

• GUIKeyboard.h