Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
3. GUI controls (kodi::gui::controls::C...)

Namespace: kodi::gui::controls

GUI control elements
This group contains classes which are used in kodi::gui::CWindow to edit associated skin control elements, be it to set or get their values, or to make them visible or hidden. More...

Topics

 Control Button
 

Class: kodi::gui::controls::CButton

Standard push button control for window
The button control is used for creating push buttons in Kodi.
 
 Control Edit
 

Class: kodi::gui::controls::CEdit

Editable window text control used as an input control for the osd keyboard and other input fields
The edit control allows a user to input text in Kodi.
 
 Control Fade Label
 

Class: kodi::gui::controls::CFadeLabel

Window control used to show multiple pieces of text in the same position, by fading from one to the other
The fade label control is used for displaying multiple pieces of text in the same space in Kodi.
 
 Control Image
 

Class: kodi::gui::controls::CImage

Window control used to show an image.
The image control is used for displaying images in Kodi. You can choose the position, size, transparency and contents of the image to be displayed.
 
 Control Label
 

Class: kodi::gui::controls::CLabel

Window control used to show some lines of text
The label control is used for displaying text in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed.
 
 Control Progress
 

Class: kodi::gui::controls::CProgress

Window control to show the progress of a particular operation
The progress control is used to show the progress of an item that may take a long time, or to show how far through a movie you are.
 
 Control Radio Button
 

Class: kodi::gui::controls::CRadioButton

Window control for a radio button (as used for on/off settings)
The radio button control is used for creating push button on/off settings in Kodi.
 
 Control Rendering
 

Class: kodi::gui::controls::CRendering

Window control for rendering own parts
This rendering control is used when own parts are needed.
 
 Control Settings Slider
 

Class: kodi::gui::controls::CSettingsSlider

Window control for moveable slider with text name
The settings slider control is used in the settings screens for when an option is best specified on a sliding scale.
 
 Control Slider
 

Class: kodi::gui::controls::CSlider

Window control for moveable slider
The slider control is used for things where a sliding bar best represents the operation at hand (such as a volume control or seek control).
 
 Control Spin
 

Class: kodi::gui::controls::CSpin

Window control used for cycling up/down controls
The settings spin control is used in the settings screens for when a list of options can be chosen from using up/down arrows.
 
 Control Text Box
 

Class: kodi::gui::controls::CTextBox

Used to show a multi-page piece of text
The text box control can be used to display descriptions, help texts or other larger texts.
 

Detailed Description

Namespace: kodi::gui::controls

GUI control elements
This group contains classes which are used in kodi::gui::CWindow to edit associated skin control elements, be it to set or get their values, or to make them visible or hidden.

See Skin Development for a detailed description of the skin XML parts accessed from here.

In order to access a control in skin XML using an add-on, it must have an id, otherwise an add-on cannot access it.

<control type="..." id="1"> <!-- Id's defined here to use on addon -->
...
</control>
Note
These classes from here can only be used together with the associated window and cannot be used independently.