Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmc::Keyboard Class Reference

#include <Keyboard.h>

Inheritance diagram for XBMCAddon::xbmc::Keyboard:
XBMCAddon::AddonClass CCriticalSection XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >

Public Member Functions

 Keyboard (const String &line=emptyString, const String &heading=emptyString, bool hidden=false)
 
 ~Keyboard () override
 
 doModal (...)
 

Function: doModal([autoclose])


Show keyboard and wait for user action. More...

 
 setDefault (...)
 

Function: setDefault(line)


Set the default text entry. More...

 
 setHiddenInput (...)
 

Function: setHiddenInput(hidden)


Allows hidden text entry. More...

 
 setHeading (...)
 

Function: setHeading(heading)


Set the keyboard heading. More...

 
 getText ()
 

Function: getText()


Returns the user input as a string. More...

 
 isConfirmed ()
 

Function: isConfirmed()


Returns False if the user cancelled the input. More...

 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Public Attributes

String strDefault
 
String strHeading
 
bool bHidden
 
String strText
 
bool bConfirmed = false
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Constructor & Destructor Documentation

§ Keyboard()

XBMCAddon::xbmc::Keyboard::Keyboard ( const String line = emptyString,
const String heading = emptyString,
bool  hidden = false 
)

§ ~Keyboard()

XBMCAddon::xbmc::Keyboard::~Keyboard ( )
overridedefault

Member Data Documentation

§ bConfirmed

bool XBMCAddon::xbmc::Keyboard::bConfirmed = false

§ bHidden

bool XBMCAddon::xbmc::Keyboard::bHidden

§ strDefault

String XBMCAddon::xbmc::Keyboard::strDefault

§ strHeading

String XBMCAddon::xbmc::Keyboard::strHeading

§ strText

String XBMCAddon::xbmc::Keyboard::strText

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