**Used to show a multi-page piece of text. More...
Collaboration diagram for Subclass - ControlTextBox:
|
Classes | |
| class | XBMCAddon::xbmcgui::ControlTextBox |
Detailed Description
**Used to show a multi-page piece of text.
**
{ ControlTextBox(x, y, width, height[, font, textColor]) }
The text box is used for showing a large multipage piece of text in Kodi. You can choose the position, size, and look of the text.
- Note
- This class include also all calls from Control
- Parameters
-
x integer - x coordinate of control. y integer - y coordinate of control. width integer - width of control. height integer - height of control. font [opt] string - font used for text. (e.g. 'font13') textColor [opt] hexstring - color of textbox's text. (e.g. '0xFFFFFFFF')
- Note
- You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
Example:
...
# ControlTextBox(x, y, width, height[, font, textColor])
self.textbox = xbmcgui.ControlTextBox(100, 250, 300, 300, textColor='0xFFFFFFFF')
...
As stated above, the GUI control is only created once added to a window. The example below shows how a ControlTextBox can be created, added to the current window and have some of its properties changed.
Extended example:
...
textbox = xbmcgui.ControlTextBox(100, 250, 300, 300, textColor='0xFFFFFFFF')
window = xbmcgui.Window(xbmcgui.getCurrentWindowId())
window.addControl(textbox)
textbox.setText("My Text Box")
textbox.scroll()
...
