xbmc
Public Member Functions | Static Public Member Functions | List of all members
CDarwinEmbedKeyboard Class Reference
Inheritance diagram for CDarwinEmbedKeyboard:
Inheritance graph
[legend]
Collaboration diagram for CDarwinEmbedKeyboard:
Collaboration graph
[legend]

Public Member Functions

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: More...
 
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
virtual int GetWindowId () const
 
void OnTimeout () override
 
void startAutoCloseTimer (unsigned int autoCloseMs)
 
void resetAutoCloseTimer ()
 

Static Public Member Functions

static bool hasExternalKeyboard ()
 

Member Function Documentation

◆ 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
pCallbackimplementation should call this on each keypress with the current whole string
initialStringimplementation should show that initialstring
typedstringreturns the typed string after close if return is true
headingimplementation should show a heading (e.x. "search for a movie")
bHiddenInputif 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: