Code based skin access. More...

Topics
	Subclass - ControlSpin
	Used for cycling up/down controls.

	Subclass - ControlLabel
	Used to show some lines of text.

	Subclass - ControlEdit

	Subclass - ControlList
	Used for a scrolling lists of items. Replaces the list control.

	Subclass - ControlFadeLabel
	Used to show multiple pieces of text in the same position, by fading from one to the other.

	Subclass - ControlTextBox
	Used to show a multi-page piece of text.

	Subclass - ControlImage
	Used to show an image.

	Subclass - ControlProgress
	Used to show the progress of a particular operation.

	Subclass - ControlButton
	A standard push button control.

	Subclass - ControlGroup
	Used to group controls together..

	Subclass - ControlRadioButton
	A radio button control (as used for on/off settings).

	Subclass - ControlSlider
	Used for a volume slider.

Classes
class	XBMCAddon::xbmcgui::Control

Functions
	XBMCAddon::xbmcgui::Control::getId () inline bool operator
	`Function: getId()` Returns the control's current id as an integer.

	XBMCAddon::xbmcgui::Control::getX ()
	`Function: getX()` Returns the control's current X position.

	XBMCAddon::xbmcgui::Control::getY ()
	`Function: getY()` Returns the control's current Y position.

	XBMCAddon::xbmcgui::Control::getHeight ()
	`Function: getHeight()` Returns the control's current height as an integer.

	XBMCAddon::xbmcgui::Control::getWidth ()
	`Function: getWidth()` Returns the control's current width as an integer.

	XBMCAddon::xbmcgui::Control::setEnabled (...)
	`Function: setEnabled(enabled)` Sets the control's enabled/disabled state.

	XBMCAddon::xbmcgui::Control::setVisible (...)
	`Function: setVisible(visible)` Sets the control's visible/hidden state.

	XBMCAddon::xbmcgui::Control::isVisible (...)
	`Function: isVisible()` Get the control's visible/hidden state with respect to the container/window

	XBMCAddon::xbmcgui::Control::setVisibleCondition (...)
	`Function: setVisibleCondition(visible[,allowHiddenFocus])` Sets the control's visible condition.

	XBMCAddon::xbmcgui::Control::setEnableCondition (...)
	`Function: setEnableCondition(enable)` Sets the control's enabled condition.

	XBMCAddon::xbmcgui::Control::setAnimations (...)
	`Function: setAnimations([(event, attr,)*])` Sets the control's animations.

	XBMCAddon::xbmcgui::Control::setPosition (...)
	`Function: setPosition(x, y)` Sets the controls position.

	XBMCAddon::xbmcgui::Control::setWidth (...)
	`Function: setWidth(width)` Sets the controls width.

	XBMCAddon::xbmcgui::Control::setHeight (...)
	`Function: setHeight(height)` Sets the controls height.

	XBMCAddon::xbmcgui::Control::setNavigation (...)
	`Function: setNavigation(up, down, left, right)` Sets the controls navigation.

	XBMCAddon::xbmcgui::Control::controlUp (...)
	`Function: controlUp(control)` Sets the controls up navigation.

	XBMCAddon::xbmcgui::Control::controlDown (...)
	`Function: controlDown(control)` Sets the controls down navigation.

	XBMCAddon::xbmcgui::Control::controlLeft (...)
	`Function: controlLeft(control)` Sets the controls left navigation.

	XBMCAddon::xbmcgui::Control::controlRight (...)
	`Function: controlRight(control)` Sets the controls right navigation.

Detailed Description

Code based skin access.

Offers classes and functions that manipulate the add-on gui controls.

`Class: Control()`

Code based skin access.

Kodi is noted as having a very flexible and robust framework for its GUI, making theme-skinning and personal customization very accessible. Users can create their own skin (or modify an existing skin) and share it with others.

Kodi includes a new GUI library written from scratch. This library allows you to skin/change everything you see in Kodi, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

Function Documentation

◆ controlDown()

void XBMCAddon::xbmcgui::Control::controlDown ( ... )

`Function: controlDown(control)`

Sets the controls down navigation.

Parameters

control control object - control to navigate to on down.

Exceptions

TypeError	if one of the supplied arguments is not a control type.
ReferenceError	if one of the controls is not added to a window.

Note: You can also use setNavigation(). Set to self to disable navigation.

Example:

...
self.button.controlDown(self.button1)
...

◆ controlLeft()

void XBMCAddon::xbmcgui::Control::controlLeft ( ... )

`Function: controlLeft(control)`

Sets the controls left navigation.

Parameters

control control object - control to navigate to on left.

Exceptions

TypeError	if one of the supplied arguments is not a control type.
ReferenceError	if one of the controls is not added to a window.

Note: You can also use setNavigation(). Set to self to disable navigation.

Example:

...
self.button.controlLeft(self.button1)
...

◆ controlRight()

void XBMCAddon::xbmcgui::Control::controlRight ( ... )

`Function: controlRight(control)`

Sets the controls right navigation.

Parameters

control control object - control to navigate to on right.

Exceptions

TypeError	if one of the supplied arguments is not a control type.
ReferenceError	if one of the controls is not added to a window.

Note: You can also use setNavigation(). Set to self to disable navigation.

Example:

...
self.button.controlRight(self.button1)
...

◆ controlUp()

void XBMCAddon::xbmcgui::Control::controlUp ( ... )

`Function: controlUp(control)`

Sets the controls up navigation.

Parameters

control control object - control to navigate to on up.

Exceptions

TypeError	if one of the supplied arguments is not a control type.
ReferenceError	if one of the controls is not added to a window.

Note: You can also use setNavigation(). Set to self to disable navigation.

Example:

...
self.button.controlUp(self.button1)
...

◆ getHeight()

XBMCAddon::xbmcgui::Control::getHeight ( )

`Function: getHeight()`

Returns the control's current height as an integer.

Returns: int - Current height

Example:

...
height = self.button.getHeight()
...

◆ getId()

XBMCAddon::xbmcgui::Control::getId ( )

`Function: getId()`

Returns the control's current id as an integer.

Returns: int - Current id

Example:

...
id = self.button.getId()
...

◆ getWidth()

XBMCAddon::xbmcgui::Control::getWidth ( )

`Function: getWidth()`

Returns the control's current width as an integer.

Returns: int - Current width

Example:

...
width = self.button.getWidth()
...

◆ getX()

XBMCAddon::xbmcgui::Control::getX ( )

`Function: getX()`

Returns the control's current X position.

Returns: int - Current X position

Example:

...
posX = self.button.getX()
...

◆ getY()

XBMCAddon::xbmcgui::Control::getY ( )

`Function: getY()`

Returns the control's current Y position.

Returns: int - Current Y position

Example:

...
posY = self.button.getY()
...

◆ isVisible()

bool XBMCAddon::xbmcgui::Control::isVisible ( ... )

`Function: isVisible()`

Get the control's visible/hidden state with respect to the container/window

Note: If a given control is set visible (c.f. setVisible() but was not yet added to a window, this method will return False (the control is not visible yet since it was not added to the window).

v18 Python API changes: New function added.

Example:

...
if self.button.isVisible():
    ...

◆ setAnimations()

void XBMCAddon::xbmcgui::Control::setAnimations ( ... )

`Function: setAnimations([(event, attr,)*])`

Sets the control's animations.

[(event,attr,)*]: list - A list of tuples consisting of event and attributes pairs.

Animating your skin

Parameters

event	string - The event to animate.
attr	string - The whole attribute string separated by spaces.

Example:

...
# setAnimations([(event, attr,)*])
self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
...

◆ setEnableCondition()

void XBMCAddon::xbmcgui::Control::setEnableCondition ( ... )

`Function: setEnableCondition(enable)`

Sets the control's enabled condition.

Allows Kodi to control the enabled status of the control.

List of Conditions

Parameters

enable string - Enable condition.

Example:

...
# setEnableCondition(enable)
self.button.setEnableCondition('System.InternetState')
...

◆ setEnabled()

void XBMCAddon::xbmcgui::Control::setEnabled ( ... )

`Function: setEnabled(enabled)`

Sets the control's enabled/disabled state.

Parameters

enabled bool - True=enabled / False=disabled.

Example:

...
self.button.setEnabled(False)
...

◆ setHeight()

void XBMCAddon::xbmcgui::Control::setHeight ( ... )

`Function: setHeight(height)`

Sets the controls height.

Parameters

height integer - height of control.

Example:

...
self.image.setHeight(100)
...

◆ setNavigation()

void XBMCAddon::xbmcgui::Control::setNavigation ( ... )

`Function: setNavigation(up, down, left, right)`

Sets the controls navigation.

Parameters

up	control object - control to navigate to on up.
down	control object - control to navigate to on down.
left	control object - control to navigate to on left.
right	control object - control to navigate to on right.

Exceptions

TypeError	if one of the supplied arguments is not a control type.
ReferenceError	if one of the controls is not added to a window.

Note: Same as controlUp(), controlDown(), controlLeft(), controlRight(). Set to self to disable navigation for that direction.

Example:

...
self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
...

◆ setPosition()

void XBMCAddon::xbmcgui::Control::setPosition ( ... )

`Function: setPosition(x, y)`

Sets the controls position.

Parameters

x	integer - x coordinate of control.
y	integer - y coordinate of control.

Note: You may use negative integers. (e.g sliding a control into view)

Example:

...
self.button.setPosition(100, 250)
...

◆ setVisible()

void XBMCAddon::xbmcgui::Control::setVisible ( ... )

`Function: setVisible(visible)`

Sets the control's visible/hidden state.

Parameters

visible bool - True=visible / False=hidden.

v19 Python API changes: You can now define the visible state of a control before it being added to a window. This value will be taken into account when the control is later added.

Example:

...
self.button.setVisible(False)
...

◆ setVisibleCondition()

void XBMCAddon::xbmcgui::Control::setVisibleCondition ( ... )

`Function: setVisibleCondition(visible[,allowHiddenFocus])`

Sets the control's visible condition.

Allows Kodi to control the visible status of the control.

List of Conditions

Parameters

visible	string - Visible condition
allowHiddenFocus	[opt] bool - True=gains focus even if hidden

Example:

...
# setVisibleCondition(visible[,allowHiddenFocus])
self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
...

◆ setWidth()

void XBMCAddon::xbmcgui::Control::setWidth ( ... )

`Function: setWidth(width)`

Sets the controls width.

Parameters

width integer - width of control.

Example:

...
self.image.setWidth(100)
...

Topics

Classes

Functions

Function: getId()

Function: getX()

Function: getY()

Function: getHeight()

Function: getWidth()

Function: setEnabled(enabled)

Function: setVisible(visible)

Function: isVisible()

Function: setVisibleCondition(visible[,allowHiddenFocus])

Function: setEnableCondition(enable)

Function: setAnimations([(event, attr,)*])

Function: setPosition(x, y)

Function: setWidth(width)

Function: setHeight(height)

Function: setNavigation(up, down, left, right)

Function: controlUp(control)

Function: controlDown(control)

Function: controlLeft(control)

Function: controlRight(control)

Detailed Description

Class: Control()

Function Documentation

◆ controlDown()

Function: controlDown(control)

◆ controlLeft()

Function: controlLeft(control)

◆ controlRight()

Function: controlRight(control)

◆ controlUp()

Function: controlUp(control)

◆ getHeight()

Function: getHeight()

◆ getId()

Function: getId()

◆ getWidth()

Function: getWidth()

◆ getX()

Function: getX()

◆ getY()

Function: getY()

◆ isVisible()

Function: isVisible()

◆ setAnimations()

Function: setAnimations([(event, attr,)*])

◆ setEnableCondition()

Function: setEnableCondition(enable)

◆ setEnabled()

Function: setEnabled(enabled)

◆ setHeight()

Function: setHeight(height)

◆ setNavigation()

Function: setNavigation(up, down, left, right)

◆ setPosition()

Function: setPosition(x, y)

◆ setVisible()

Function: setVisible(visible)

◆ setVisibleCondition()

Function: setVisibleCondition(visible[,allowHiddenFocus])

◆ setWidth()

Function: setWidth(width)

`Function: getId()`

`Function: getX()`

`Function: getY()`

`Function: getHeight()`

`Function: getWidth()`

`Function: setEnabled(enabled)`

`Function: setVisible(visible)`

`Function: isVisible()`

`Function: setVisibleCondition(visible[,allowHiddenFocus])`

`Function: setEnableCondition(enable)`

`Function: setAnimations([(event, attr,)*])`

`Function: setPosition(x, y)`

`Function: setWidth(width)`

`Function: setHeight(height)`

`Function: setNavigation(up, down, left, right)`

`Function: controlUp(control)`

`Function: controlDown(control)`

`Function: controlLeft(control)`

`Function: controlRight(control)`

`Class: Control()`

`Function: controlDown(control)`

`Function: controlLeft(control)`

`Function: controlRight(control)`

`Function: controlUp(control)`

`Function: getHeight()`

`Function: getId()`

`Function: getWidth()`

`Function: getX()`

`Function: getY()`

`Function: isVisible()`

`Function: setAnimations([(event, attr,)*])`

`Function: setEnableCondition(enable)`

`Function: setEnabled(enabled)`

`Function: setHeight(height)`

`Function: setNavigation(up, down, left, right)`

`Function: setPosition(x, y)`

`Function: setVisible(visible)`

`Function: setVisibleCondition(visible[,allowHiddenFocus])`

`Function: setWidth(width)`