Keyboard

Kodi's keyboard class. More...

Classes
class	XBMCAddon::xbmc::Keyboard

Functions
	XBMCAddon::xbmc::Keyboard::Keyboard (const String &line=emptyString, const String &heading=emptyString, bool hidden=false)
	XBMCAddon::xbmc::Keyboard::~Keyboard () override
	XBMCAddon::xbmc::Keyboard::doModal (...)
	XBMCAddon::xbmc::Keyboard::setDefault (...)
	XBMCAddon::xbmc::Keyboard::setHiddenInput (...)
	XBMCAddon::xbmc::Keyboard::setHeading (...)
	XBMCAddon::xbmc::Keyboard::getText ()
	XBMCAddon::xbmc::Keyboard::isConfirmed ()

Variables
String	XBMCAddon::xbmc::Keyboard::strDefault
String	XBMCAddon::xbmc::Keyboard::strHeading
bool	XBMCAddon::xbmc::Keyboard::bHidden
String	XBMCAddon::xbmc::Keyboard::strText
bool	XBMCAddon::xbmc::Keyboard::bConfirmed = false

Detailed Description

Kodi's keyboard class.

Class: xbmc.Keyboard([default, heading, hidden])

Creates a new Keyboard object with default text heading and hidden input flag if supplied.

Parameters

default	: [opt] string - default text entry.
heading	: [opt] string - keyboard heading.
hidden	: [opt] boolean - True for hidden text entry.

---

Example:

..
kb = xbmc.Keyboard('default', 'heading', True)
kb.setDefault('password') # optional
kb.setHeading('Enter password') # optional
kb.setHiddenInput(True) # optional
kb.doModal()
if (kb.isConfirmed()):
  text = kb.getText()
..

Function Documentation

doModal()

void XBMCAddon::xbmc::Keyboard::doModal

(

...

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> doModal([autoclose]) </big></font></span></code></h4> \endhtmlonly

Show keyboard and wait for user action.

Parameters

autoclose

[opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)

---

Example:

..
kb.doModal(30000)
..

getText()

String XBMCAddon::xbmc::Keyboard::getText

(

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> getText() </big></font></span></code></h4> \endhtmlonly

Returns the user input as a string.

Note

This will always return the text entry even if you cancel the keyboard. Use the isConfirmed() method to check if user cancelled the keyboard.

Returns

get the in keyboard entered text

---

Example:

..
text = kb.getText()
..

isConfirmed()

bool XBMCAddon::xbmc::Keyboard::isConfirmed

(

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> isConfirmed() </big></font></span></code></h4> \endhtmlonly

Returns False if the user cancelled the input.

Returns

true if confirmed, if cancelled false

---

Example:

..
if (kb.isConfirmed()):
  ..

Keyboard()

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

setDefault()

void XBMCAddon::xbmc::Keyboard::setDefault

(

...

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> setDefault(line) </big></font></span></code></h4> \endhtmlonly

Set the default text entry.

Parameters

line	string - default text entry.

---

Example:

..
kb.setDefault('password')
..

setHeading()

void XBMCAddon::xbmc::Keyboard::setHeading

(

...

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> setHeading(heading) </big></font></span></code></h4> \endhtmlonly

Set the keyboard heading.

Parameters

heading

string - keyboard heading.

---

Example:

..
kb.setHeading('Enter password')
..

setHiddenInput()

void XBMCAddon::xbmc::Keyboard::setHiddenInput

(

...

)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> setHiddenInput(hidden) </big></font></span></code></h4> \endhtmlonly

Allows hidden text entry.

Parameters

hidden

boolean - True for hidden text entry.

---

Example:

..
kb.setHiddenInput(True)
..

~Keyboard()

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

overridedefault

Variable 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