CDarwinEmbedKeyboard Class Reference

#include <DarwinEmbedKeyboard.h>

Inheritance diagram for CDarwinEmbedKeyboard:

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

Static Public Member Functions
static bool	hasExternalKeyboard ()

Constructor & Destructor Documentation

CDarwinEmbedKeyboard()

CDarwinEmbedKeyboard::CDarwinEmbedKeyboard

(

)

Member Function Documentation

Cancel()

void CDarwinEmbedKeyboard::Cancel ( )

overridevirtual

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

Implements CGUIKeyboard.

fireCallback()

void CDarwinEmbedKeyboard::fireCallback

(

const std::string &

str

)

hasExternalKeyboard()

bool CDarwinEmbedKeyboard::hasExternalKeyboard ( )

static

invalidateCallback()

void CDarwinEmbedKeyboard::invalidateCallback

(

)

SetTextToKeyboard()

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

overridevirtual

Reimplemented from CGUIKeyboard.

ShowAndGetInput()

bool CDarwinEmbedKeyboard::ShowAndGetInput ( char_callback_t pCallback, const std::string & initialString, std::string & typedString, const std::string & heading, bool bHiddenInput )

overridevirtual

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

Implements CGUIKeyboard.

---

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

• DarwinEmbedKeyboard.h
• DarwinEmbedKeyboard.mm