Subclass - ControlTextBox

Used to show a multi-page piece of text. More...

Classes
class	XBMCAddon::xbmcgui::ControlTextBox

Functions
	XBMCAddon::xbmcgui::ControlTextBox::setText (...)
	XBMCAddon::xbmcgui::ControlTextBox::getText ()
	XBMCAddon::xbmcgui::ControlTextBox::reset ()
	XBMCAddon::xbmcgui::ControlTextBox::scroll (...)
	XBMCAddon::xbmcgui::ControlTextBox::autoScroll (...)

Detailed Description

Used to show a multi-page piece of text.

Class: 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()
...

Function Documentation

autoScroll()

void XBMCAddon::xbmcgui::ControlTextBox::autoScroll

(

...

)

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

Set autoscrolling times.

Parameters

delay	integer - Scroll delay (in ms)
time	integer - Scroll time (in ms)
repeat	integer - Repeat time

Note

autoScroll only works after you add the control to a window.

---

v15 Python API changes:

New function added.

Example:

...
self.textbox.autoScroll(1, 2, 1)
...

getText()

String XBMCAddon::xbmcgui::ControlTextBox::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 text value for this textbox.

Returns

To get text from box

Note

getText only works after you add the control to a window and set the control text (using setText).

---

Example:

...
# getText()
text = self.text.getText()
...

reset()

void XBMCAddon::xbmcgui::ControlTextBox::reset

(

void

)

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

Clear's this textbox.

Note

reset only works after you add the control to a window.

---

Example:

...
# reset()
self.textbox.reset()
...

scroll()

void XBMCAddon::xbmcgui::ControlTextBox::scroll

(

...

)

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

Scrolls to the given position.

Parameters

id	integer - position to scroll to.

Note

scroll() only works after the control is added to a window.

---

Example:

...
# scroll(position)
self.textbox.scroll(10)
...

setText()

void XBMCAddon::xbmcgui::ControlTextBox::setText

(

...

)

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

Set's the text for this textbox.

Parameters

text	string - text string.

Note

setText only has effect after the control is added to a window

---

Example:

...
# setText(text)
self.textbox.setText('This is a line of text that can wrap.')
...