CIOSKeyboard Class Reference

#include <IOSKeyboard.h>

Inheritance diagram for CIOSKeyboard:

Public Member Functions
	CIOSKeyboard ()
virtual bool	ShowAndGetInput (char_callback_t pCallback, const std::string &initialString, std::string &typedString, const std::string &heading, bool bHiddenInput)
	each native keyboard needs to implement this function with the following behaviour: More...
virtual void	Cancel ()
	This call should cancel a currently shown keyboard dialog. The implementation should return false from the modal ShowAndGetInput once anyone calls this method. More...
void	fireCallback (const std::string &str)
void	invalidateCallback ()
virtual bool	SetTextToKeyboard (const std::string &text, bool closeKeyboard=false)
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

Constructor & Destructor Documentation

CIOSKeyboard()

CIOSKeyboard::CIOSKeyboard ( )

inline

Member Function Documentation

Cancel()

void CIOSKeyboard::Cancel ( )

virtual

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 CIOSKeyboard::fireCallback

(

const std::string &

str

)

invalidateCallback()

void CIOSKeyboard::invalidateCallback ( )

inline

SetTextToKeyboard()

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

virtual

Reimplemented from CGUIKeyboard.

ShowAndGetInput()

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

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

Implements CGUIKeyboard.

---

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

• IOSKeyboard.h
• IOSKeyboard.mm