Interface - kodi::gui

Graphical functions for Windows and Dialogs to show More...

Modules
	Control Button
	\cpp_class{ kodi::gui::controls::CButton } Standard push button control for window
	Control Edit
	\cpp_class{ kodi::gui::controls::CEdit } Editable window text control used as an input control for the osd keyboard and other input fields
	Control Fade Label
	\cpp_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
	Control Image
	\cpp_class{ kodi::gui::controls::CImage } Window control used to show an image.
	Control Label
	\cpp_class{ kodi::gui::controls::CLabel } Window control used to show some lines of text.
	Control Progress
	\cpp_class{ kodi::gui::controls::CProgress } Window control to show the progress of a particular operation
	Control Radio Button
	\cpp_class{ kodi::gui::controls::CRadioButton } Window control for a radio button (as used for on/off settings)
	Control Rendering
	\cpp_class{ kodi::gui::controls::CRendering } Window control for rendering own parts
	Control Settings Slider
	\cpp_class{ kodi::gui::controls::CSettingsSlider } Window control for moveable slider with text name
	Control Slider
	\cpp_class{ kodi::gui::controls::CSlider } Window control for moveable slider
	Control Spin
	\cpp_class{ kodi::gui::controls::CSpin } Window control used for cycling up/down controls
	Control Text Box
	\cpp_class{ kodi::gui::controls::CTextBox } Used to show a multi-page piece of text
	Dialog Context Menu
	\cpp_namespace{ kodi::gui::dialogs::ContextMenu } Context menu dialog
	Dialog Extended Progress
	\cpp_class{ kodi::gui::dialogs::ExtendedProgress } Progress dialog shown for background work
	Dialog File Browser
	\cpp_namespace{ kodi::gui::dialogs::FileBrowser } File browser dialog
	Dialog Keyboard
	\cpp_namespace{ kodi::gui::dialogs::Keyboard } Keyboard dialogs
	Dialog Numeric
	\cpp_namespace{ kodi::gui::dialogs::Numeric } Numeric dialogs
	Dialog OK
	\cpp_namespace{ kodi::gui::dialogs::OK } OK dialog
	Dialog Progress
	\cpp_class{ kodi::gui::dialogs::CProgress } Progress dialog shown in center
	Dialog Select
	\cpp_namespace{ kodi::gui::dialogs::Select } Selection dialog
	Dialog Text Viewer
	\cpp_namespace{ kodi::gui::dialogs::TextViewer } Text viewer dialog
	Dialog Yes/No
	\cpp_namespace{ kodi::gui::dialogs::YesNo } Yes / No dialog
	List Item
	\cpp_class{ kodi::gui::CListItem } Selectable window list item
	Window
	\cpp_class{ kodi::gui::CWindow } Main window control class

Functions
void	kodi::gui::Lock ()
	Performs a graphical lock of rendering engine. More...
void	kodi::gui::Unlock ()
	Performs a graphical unlock of previous locked rendering engine. More...
int	kodi::gui::GetScreenHeight ()
	Return the the current screen height with pixel. More...
int	kodi::gui::GetScreenWidth ()
	Return the the current screen width with pixel. More...
int	kodi::gui::GetVideoResolution ()
	Return the the current screen rendering resolution. More...
int	kodi::gui::GetCurrentWindowDialogId ()
	Returns the id for the current 'active' dialog as an integer. More...
int	kodi::gui::GetCurrentWindowId ()
	Returns the id for the current 'active' window as an integer. More...

Detailed Description

Graphical functions for Windows and Dialogs to show

Allow use of binary classes and function to use on add-on's

Permits the use of the required functions of the add-on to Kodi. This class also contains some functions to the control.

These are pure functions them no other initialization need.

It has the header #include <kodi/gui/General.h> be included to enjoy it.

Function Documentation

GetCurrentWindowDialogId()

int kodi::gui::GetCurrentWindowDialogId ( )

inline

Returns the id for the current 'active' dialog as an integer.

Returns

The currently active dialog Id

---

Example:

..
int wid = kodi::gui::GetCurrentWindowDialogId()
..

GetCurrentWindowId()

int kodi::gui::GetCurrentWindowId ( )

inline

Returns the id for the current 'active' window as an integer.

Returns

The currently active window Id

---

Example:

..
int wid = kodi::gui::GetCurrentWindowId()
..

GetScreenHeight()

int kodi::gui::GetScreenHeight ( )

inline

Return the the current screen height with pixel.

GetScreenWidth()

int kodi::gui::GetScreenWidth ( )

inline

Return the the current screen width with pixel.

GetVideoResolution()

int kodi::gui::GetVideoResolution ( )

inline

Return the the current screen rendering resolution.

Lock()

void kodi::gui::Lock ( )

inline

Performs a graphical lock of rendering engine.

Unlock()

void kodi::gui::Unlock ( )

inline

Performs a graphical unlock of previous locked rendering engine.