File: modules_cpp_gui.dox

package info (click to toggle)
kodi 2%3A21.2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 143,076 kB
  • sloc: cpp: 694,471; xml: 52,618; ansic: 38,300; python: 7,161; sh: 4,289; javascript: 2,325; makefile: 1,791; perl: 969; java: 513; cs: 390; objc: 340
file content (96 lines) | stat: -rw-r--r-- 2,929 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*!
@defgroup cpp_kodi_gui_Defs Definitions, structures and enumerators
@ingroup cpp_kodi_gui
@brief **GUI add-on interface definition values**\n
All GUI functions associated data structures.

Used to exchange the available options between Kodi and addon.\n
The groups described here correspond to the groups of functions on GUI.
*/


/*!
@defgroup cpp_kodi_gui_general 1. General
@ingroup cpp_kodi_gui
@brief **General GUI related functions**\n
This includes independent functions which can be used by different locations and
called up independently.

*/

/*!
@defgroup cpp_kodi_gui_dialogs 2. Dialogs
@ingroup cpp_kodi_gui
@brief **Different GUI dialog for user queries**\n
This is where the individual dialogs possible for addons are carried out, with
which any user access can be given, e.g. Yes/No dialog.


*/

/*!
@defgroup cpp_kodi_gui_windows 3. Windows
@ingroup cpp_kodi_gui
@brief **Classes and data for displaying a window in Kodi**\n
This group contains the primary class @ref cpp_kodi_gui_windows_window "kodi::gui::CWindow"
and also various subclasses belonging to it (various controls, list item).

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.

This class is used to process the display of a window in Kodi from the addon.

The addon can process the controls stored in the XML and lists displayed in the
GUI, set values and manage user access.

*/

/*!
@defgroup cpp_kodi_gui_windows_window 1. GUI window (kodi::gui::CWindow)
@ingroup cpp_kodi_gui_windows
*/

/*!
@defgroup cpp_kodi_gui_windows_listitem 2. GUI list item (kodi::gui::CListItem)
@ingroup cpp_kodi_gui_windows
*/

/*!
@defgroup cpp_kodi_gui_windows_controls 3. GUI controls (kodi::gui::controls::C...)
@ingroup cpp_kodi_gui_windows
@brief @cpp_namespace{ kodi::gui::controls }
<b>GUI control elements</b>\n
This group contains classes which are used in @ref cpp_kodi_gui_windows_window "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 @ref skin_parts 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.

~~~~~~~~~~~~~~~xml
  <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.


*/


/*!
@defgroup cpp_kodi_gui_helpers 4. Helpers
@ingroup cpp_kodi_gui
@brief **Auxiliary classes for processing the GUI within the addon**\n
The auxiliary functions and classes stored here only work indirectly with Kodi
and are mostly only intended to simplify an add-on development.


*/