Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
GUIMessage.h File Reference
#include <string>
#include <vector>
#include <memory>

Classes

class  CGUIMessage
 

Macros

#define CONTROL_SELECT(controlID)
 
#define CONTROL_DESELECT(controlID)
 
#define CONTROL_ENABLE(controlID)
 
#define CONTROL_DISABLE(controlID)
 
#define CONTROL_ENABLE_ON_CONDITION(controlID, bCondition)
 
#define CONTROL_SELECT_ITEM(controlID, iItem)
 
#define SET_CONTROL_LABEL(controlID, label)
 Set the label of the current control.
 
#define SET_CONTROL_LABEL_THREAD_SAFE(controlID, label)
 Set the label of the current control.
 
#define SET_CONTROL_LABEL2(controlID, label)
 Set the second label of the current control.
 
#define SET_CONTROL_LABELS(controlID, defaultValue, labels)
 Set a bunch of labels on the given control.
 
#define SET_CONTROL_FILENAME(controlID, label)
 Set the label of the current control.
 
#define SET_CONTROL_HIDDEN(controlID)
 
#define SET_CONTROL_FOCUS(controlID, dwParam)
 
#define SET_CONTROL_VISIBLE(controlID)
 
#define SET_CONTROL_SELECTED(dwSenderId, controlID, bSelect)
 
#define SEND_CLICK_MESSAGE(id, parentID, action)
 Click message sent from controls to windows.
 

Variables

constexpr const int GUI_MSG_WINDOW_INIT = 1
 
constexpr const int GUI_MSG_WINDOW_DEINIT = 2
 
constexpr const int GUI_MSG_WINDOW_RESET = 27
 
constexpr const int GUI_MSG_SETFOCUS = 3
 
constexpr const int GUI_MSG_LOSTFOCUS = 4
 
constexpr const int GUI_MSG_CLICKED = 5
 
constexpr const int GUI_MSG_VISIBLE = 6
 
constexpr const int GUI_MSG_HIDDEN = 7
 
constexpr const int GUI_MSG_ENABLED = 8
 
constexpr const int GUI_MSG_DISABLED = 9
 
constexpr const int GUI_MSG_SET_SELECTED = 10
 
constexpr const int GUI_MSG_SET_DESELECTED = 11
 
constexpr const int GUI_MSG_LABEL_ADD = 12
 
constexpr const int GUI_MSG_LABEL_SET = 13
 
constexpr const int GUI_MSG_LABEL_RESET = 14
 
constexpr const int GUI_MSG_ITEM_SELECTED = 15
 
constexpr const int GUI_MSG_ITEM_SELECT = 16
 
constexpr const int GUI_MSG_LABEL2_SET = 17
 
constexpr const int GUI_MSG_SHOWRANGE = 18
 
constexpr const int GUI_MSG_FULLSCREEN = 19
 
constexpr const int GUI_MSG_EXECUTE = 20
 
constexpr const int GUI_MSG_NOTIFY_ALL = 21
 
constexpr const int GUI_MSG_REFRESH_THUMBS = 22
 
constexpr const int GUI_MSG_MOVE = 23
 
constexpr const int GUI_MSG_LABEL_BIND = 24
 
constexpr const int GUI_MSG_FOCUSED = 26
 
constexpr const int GUI_MSG_PAGE_CHANGE = 28
 
constexpr const int GUI_MSG_REFRESH_LIST = 29
 
constexpr const int GUI_MSG_PAGE_UP = 30
 
constexpr const int GUI_MSG_PAGE_DOWN = 31
 
constexpr const int GUI_MSG_MOVE_OFFSET = 32
 
constexpr const int GUI_MSG_SET_TYPE = 33
 Instruct a control to set it's type appropriately.
 
constexpr const int GUI_MSG_WINDOW_RESIZE = 34
 Message indicating the window has been resized Any controls that keep stored sizing information based on aspect ratio or window size should recalculate sizing information.
 
constexpr const int GUI_MSG_RENDERER_LOST = 35
 Message indicating loss of renderer, prior to reset Any controls that keep shared resources should free them on receipt of this message, as the renderer is about to be reset.
 
constexpr const int GUI_MSG_RENDERER_RESET = 36
 Message indicating regain of renderer, after reset Any controls that keep shared resources may reallocate them now that the renderer is back.
 
constexpr const int GUI_MSG_EXCLUSIVE_MOUSE = 37
 A control wishes to have (or release) exclusive access to mouse actions.
 
constexpr const int GUI_MSG_GESTURE_NOTIFY = 38
 A request for supported gestures is made.
 
constexpr const int GUI_MSG_ADD_CONTROL = 39
 A request to add a control.
 
constexpr const int GUI_MSG_REMOVE_CONTROL = 40
 A request to remove a control.
 
constexpr const int GUI_MSG_UNFOCUS_ALL = 41
 A request to unfocus all currently focused controls.
 
constexpr const int GUI_MSG_SET_TEXT = 42
 
constexpr const int GUI_MSG_WINDOW_LOAD = 43
 
constexpr const int GUI_MSG_VALIDITY_CHANGED = 44
 
constexpr const int GUI_MSG_IS_SELECTED = 45
 Check whether a button is selected.
 
constexpr const int GUI_MSG_SET_LABELS = 46
 Bind a set of labels to a spin (or similar) control.
 
constexpr const int GUI_MSG_SET_FILENAME = 47
 Set the filename for an image control.
 
constexpr const int GUI_MSG_GET_FILENAME = 48
 Get the filename of an image control.
 
constexpr const int GUI_MSG_UI_READY = 49
 The user interface is ready for usage.
 
constexpr const int GUI_MSG_REFRESH_TIMER = 50
 Called every 500ms to allow time dependent updates.
 
constexpr const int GUI_MSG_STATE_CHANGED = 51
 Called if state has changed which could lead to GUI changes.
 
constexpr const int GUI_MSG_SUBTITLE_DOWNLOADED = 52
 Called when a subtitle download has finished.
 
constexpr const int GUI_MSG_USER = 1000
 
constexpr const int GUI_MSG_CODINGTABLE_LOOKUP_COMPLETED = 65000
 Complete to get codingtable page.
 

Macro Definition Documentation

◆ SET_CONTROL_SELECTED

#define SET_CONTROL_SELECTED ( dwSenderId,
controlID,
bSelect )
Value:
do \
{ \
controlID); \
OnMessage(_msg); \
} while (0)
constexpr const int GUI_MSG_SET_SELECTED
Definition GUIMessage.h:31
constexpr const int GUI_MSG_SET_DESELECTED
Definition GUIMessage.h:32
Definition GUIMessage.h:366

Variable Documentation

◆ GUI_MSG_ADD_CONTROL

const int GUI_MSG_ADD_CONTROL = 39
constexpr

A request to add a control.

◆ GUI_MSG_CLICKED

const int GUI_MSG_CLICKED = 5
constexpr

◆ GUI_MSG_CODINGTABLE_LOOKUP_COMPLETED

const int GUI_MSG_CODINGTABLE_LOOKUP_COMPLETED = 65000
constexpr

Complete to get codingtable page.

◆ GUI_MSG_DISABLED

const int GUI_MSG_DISABLED = 9
constexpr

◆ GUI_MSG_ENABLED

const int GUI_MSG_ENABLED = 8
constexpr

◆ GUI_MSG_EXCLUSIVE_MOUSE

const int GUI_MSG_EXCLUSIVE_MOUSE = 37
constexpr

A control wishes to have (or release) exclusive access to mouse actions.

◆ GUI_MSG_EXECUTE

const int GUI_MSG_EXECUTE = 20
constexpr

◆ GUI_MSG_FOCUSED

const int GUI_MSG_FOCUSED = 26
constexpr

◆ GUI_MSG_FULLSCREEN

const int GUI_MSG_FULLSCREEN = 19
constexpr

◆ GUI_MSG_GESTURE_NOTIFY

const int GUI_MSG_GESTURE_NOTIFY = 38
constexpr

A request for supported gestures is made.

◆ GUI_MSG_GET_FILENAME

const int GUI_MSG_GET_FILENAME = 48
constexpr

Get the filename of an image control.

◆ GUI_MSG_HIDDEN

const int GUI_MSG_HIDDEN = 7
constexpr

◆ GUI_MSG_IS_SELECTED

const int GUI_MSG_IS_SELECTED = 45
constexpr

Check whether a button is selected.

◆ GUI_MSG_ITEM_SELECT

const int GUI_MSG_ITEM_SELECT = 16
constexpr

◆ GUI_MSG_ITEM_SELECTED

const int GUI_MSG_ITEM_SELECTED = 15
constexpr

◆ GUI_MSG_LABEL2_SET

const int GUI_MSG_LABEL2_SET = 17
constexpr

◆ GUI_MSG_LABEL_ADD

const int GUI_MSG_LABEL_ADD = 12
constexpr

◆ GUI_MSG_LABEL_BIND

const int GUI_MSG_LABEL_BIND = 24
constexpr

◆ GUI_MSG_LABEL_RESET

const int GUI_MSG_LABEL_RESET = 14
constexpr

◆ GUI_MSG_LABEL_SET

const int GUI_MSG_LABEL_SET = 13
constexpr

◆ GUI_MSG_LOSTFOCUS

const int GUI_MSG_LOSTFOCUS = 4
constexpr

◆ GUI_MSG_MOVE

const int GUI_MSG_MOVE = 23
constexpr

◆ GUI_MSG_MOVE_OFFSET

const int GUI_MSG_MOVE_OFFSET = 32
constexpr

◆ GUI_MSG_NOTIFY_ALL

const int GUI_MSG_NOTIFY_ALL = 21
constexpr

◆ GUI_MSG_PAGE_CHANGE

const int GUI_MSG_PAGE_CHANGE = 28
constexpr

◆ GUI_MSG_PAGE_DOWN

const int GUI_MSG_PAGE_DOWN = 31
constexpr

◆ GUI_MSG_PAGE_UP

const int GUI_MSG_PAGE_UP = 30
constexpr

◆ GUI_MSG_REFRESH_LIST

const int GUI_MSG_REFRESH_LIST = 29
constexpr

◆ GUI_MSG_REFRESH_THUMBS

const int GUI_MSG_REFRESH_THUMBS = 22
constexpr

◆ GUI_MSG_REFRESH_TIMER

const int GUI_MSG_REFRESH_TIMER = 50
constexpr

Called every 500ms to allow time dependent updates.

◆ GUI_MSG_REMOVE_CONTROL

const int GUI_MSG_REMOVE_CONTROL = 40
constexpr

A request to remove a control.

◆ GUI_MSG_RENDERER_LOST

const int GUI_MSG_RENDERER_LOST = 35
constexpr

Message indicating loss of renderer, prior to reset Any controls that keep shared resources should free them on receipt of this message, as the renderer is about to be reset.

◆ GUI_MSG_RENDERER_RESET

const int GUI_MSG_RENDERER_RESET = 36
constexpr

Message indicating regain of renderer, after reset Any controls that keep shared resources may reallocate them now that the renderer is back.

◆ GUI_MSG_SET_DESELECTED

const int GUI_MSG_SET_DESELECTED = 11
constexpr

◆ GUI_MSG_SET_FILENAME

const int GUI_MSG_SET_FILENAME = 47
constexpr

Set the filename for an image control.

◆ GUI_MSG_SET_LABELS

const int GUI_MSG_SET_LABELS = 46
constexpr

Bind a set of labels to a spin (or similar) control.

◆ GUI_MSG_SET_SELECTED

const int GUI_MSG_SET_SELECTED = 10
constexpr

◆ GUI_MSG_SET_TEXT

const int GUI_MSG_SET_TEXT = 42
constexpr

◆ GUI_MSG_SET_TYPE

const int GUI_MSG_SET_TYPE = 33
constexpr

Instruct a control to set it's type appropriately.

◆ GUI_MSG_SETFOCUS

const int GUI_MSG_SETFOCUS = 3
constexpr

◆ GUI_MSG_SHOWRANGE

const int GUI_MSG_SHOWRANGE = 18
constexpr

◆ GUI_MSG_STATE_CHANGED

const int GUI_MSG_STATE_CHANGED = 51
constexpr

Called if state has changed which could lead to GUI changes.

◆ GUI_MSG_SUBTITLE_DOWNLOADED

const int GUI_MSG_SUBTITLE_DOWNLOADED = 52
constexpr

Called when a subtitle download has finished.

◆ GUI_MSG_UI_READY

const int GUI_MSG_UI_READY = 49
constexpr

The user interface is ready for usage.

◆ GUI_MSG_UNFOCUS_ALL

const int GUI_MSG_UNFOCUS_ALL = 41
constexpr

A request to unfocus all currently focused controls.

◆ GUI_MSG_USER

const int GUI_MSG_USER = 1000
constexpr

◆ GUI_MSG_VALIDITY_CHANGED

const int GUI_MSG_VALIDITY_CHANGED = 44
constexpr

◆ GUI_MSG_VISIBLE

const int GUI_MSG_VISIBLE = 6
constexpr

◆ GUI_MSG_WINDOW_DEINIT

const int GUI_MSG_WINDOW_DEINIT = 2
constexpr

◆ GUI_MSG_WINDOW_INIT

const int GUI_MSG_WINDOW_INIT = 1
constexpr

◆ GUI_MSG_WINDOW_LOAD

const int GUI_MSG_WINDOW_LOAD = 43
constexpr

◆ GUI_MSG_WINDOW_RESET

const int GUI_MSG_WINDOW_RESET = 27
constexpr

◆ GUI_MSG_WINDOW_RESIZE

const int GUI_MSG_WINDOW_RESIZE = 34
constexpr

Message indicating the window has been resized Any controls that keep stored sizing information based on aspect ratio or window size should recalculate sizing information.