Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
GUIMessage.h File Reference
#include <string>
#include <vector>
#include <memory>

Classes

class  CGUIMessage
 

Macros

#define GUI_MSG_WINDOW_INIT   1
 
#define GUI_MSG_WINDOW_DEINIT   2
 
#define GUI_MSG_WINDOW_RESET   27
 
#define GUI_MSG_SETFOCUS   3
 
#define GUI_MSG_LOSTFOCUS   4
 
#define GUI_MSG_CLICKED   5
 
#define GUI_MSG_VISIBLE   6
 
#define GUI_MSG_HIDDEN   7
 
#define GUI_MSG_ENABLED   8
 
#define GUI_MSG_DISABLED   9
 
#define GUI_MSG_SET_SELECTED   10
 
#define GUI_MSG_SET_DESELECTED   11
 
#define GUI_MSG_LABEL_ADD   12
 
#define GUI_MSG_LABEL_SET   13
 
#define GUI_MSG_LABEL_RESET   14
 
#define GUI_MSG_ITEM_SELECTED   15
 
#define GUI_MSG_ITEM_SELECT   16
 
#define GUI_MSG_LABEL2_SET   17
 
#define GUI_MSG_SHOWRANGE   18
 
#define GUI_MSG_FULLSCREEN   19
 
#define GUI_MSG_EXECUTE   20
 
#define GUI_MSG_NOTIFY_ALL   21
 
#define GUI_MSG_REFRESH_THUMBS   22
 
#define GUI_MSG_MOVE   23
 
#define GUI_MSG_LABEL_BIND   24
 
#define GUI_MSG_FOCUSED   26
 
#define GUI_MSG_PAGE_CHANGE   28
 
#define GUI_MSG_REFRESH_LIST   29
 
#define GUI_MSG_PAGE_UP   30
 
#define GUI_MSG_PAGE_DOWN   31
 
#define GUI_MSG_MOVE_OFFSET   32
 
#define GUI_MSG_SET_TYPE   33
 Instruct a control to set it's type appropriately. More...
 
#define 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. More...
 
#define 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. More...
 
#define 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. More...
 
#define GUI_MSG_EXCLUSIVE_MOUSE   37
 A control wishes to have (or release) exclusive access to mouse actions. More...
 
#define GUI_MSG_GESTURE_NOTIFY   38
 A request for supported gestures is made. More...
 
#define GUI_MSG_ADD_CONTROL   39
 A request to add a control. More...
 
#define GUI_MSG_REMOVE_CONTROL   40
 A request to remove a control. More...
 
#define GUI_MSG_UNFOCUS_ALL   41
 A request to unfocus all currently focused controls. More...
 
#define GUI_MSG_SET_TEXT   42
 
#define GUI_MSG_WINDOW_LOAD   43
 
#define GUI_MSG_VALIDITY_CHANGED   44
 
#define GUI_MSG_IS_SELECTED   45
 Check whether a button is selected. More...
 
#define GUI_MSG_SET_LABELS   46
 Bind a set of labels to a spin (or similar) control. More...
 
#define GUI_MSG_SET_FILENAME   47
 Set the filename for an image control. More...
 
#define GUI_MSG_GET_FILENAME   48
 Get the filename of an image control. More...
 
#define GUI_MSG_UI_READY   49
 The user interface is ready for usage. More...
 
#define GUI_MSG_REFRESH_TIMER   50
 Called every 500ms to allow time dependent updates. More...
 
#define GUI_MSG_STATE_CHANGED   51
 Called if state has changed wich could lead to GUI changes. More...
 
#define GUI_MSG_SUBTITLE_DOWNLOADED   52
 Called when a subtitle download has finished. More...
 
#define GUI_MSG_USER   1000
 
#define GUI_MSG_CODINGTABLE_LOOKUP_COMPLETED   65000
 Complete to get codingtable page. More...
 
#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. More...
 
#define SET_CONTROL_LABEL_THREAD_SAFE(controlID, label)
 Set the label of the current control. More...
 
#define SET_CONTROL_LABEL2(controlID, label)
 Set the second label of the current control. More...
 
#define SET_CONTROL_LABELS(controlID, defaultValue, labels)
 Set a bunch of labels on the given control. More...
 
#define SET_CONTROL_FILENAME(controlID, label)
 Set the label of the current control. More...
 
#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. More...
 

Typedefs

typedef std::shared_ptr< CGUIListItemCGUIListItemPtr
 

Macro Definition Documentation

◆ GUI_MSG_ADD_CONTROL

#define GUI_MSG_ADD_CONTROL   39

A request to add a control.

◆ GUI_MSG_CLICKED

#define GUI_MSG_CLICKED   5

◆ GUI_MSG_CODINGTABLE_LOOKUP_COMPLETED

#define GUI_MSG_CODINGTABLE_LOOKUP_COMPLETED   65000

Complete to get codingtable page.

◆ GUI_MSG_DISABLED

#define GUI_MSG_DISABLED   9

◆ GUI_MSG_ENABLED

#define GUI_MSG_ENABLED   8

◆ GUI_MSG_EXCLUSIVE_MOUSE

#define GUI_MSG_EXCLUSIVE_MOUSE   37

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

◆ GUI_MSG_EXECUTE

#define GUI_MSG_EXECUTE   20

◆ GUI_MSG_FOCUSED

#define GUI_MSG_FOCUSED   26

◆ GUI_MSG_FULLSCREEN

#define GUI_MSG_FULLSCREEN   19

◆ GUI_MSG_GESTURE_NOTIFY

#define GUI_MSG_GESTURE_NOTIFY   38

A request for supported gestures is made.

◆ GUI_MSG_GET_FILENAME

#define GUI_MSG_GET_FILENAME   48

Get the filename of an image control.

◆ GUI_MSG_HIDDEN

#define GUI_MSG_HIDDEN   7

◆ GUI_MSG_IS_SELECTED

#define GUI_MSG_IS_SELECTED   45

Check whether a button is selected.

◆ GUI_MSG_ITEM_SELECT

#define GUI_MSG_ITEM_SELECT   16

◆ GUI_MSG_ITEM_SELECTED

#define GUI_MSG_ITEM_SELECTED   15

◆ GUI_MSG_LABEL2_SET

#define GUI_MSG_LABEL2_SET   17

◆ GUI_MSG_LABEL_ADD

#define GUI_MSG_LABEL_ADD   12

◆ GUI_MSG_LABEL_BIND

#define GUI_MSG_LABEL_BIND   24

◆ GUI_MSG_LABEL_RESET

#define GUI_MSG_LABEL_RESET   14

◆ GUI_MSG_LABEL_SET

#define GUI_MSG_LABEL_SET   13

◆ GUI_MSG_LOSTFOCUS

#define GUI_MSG_LOSTFOCUS   4

◆ GUI_MSG_MOVE

#define GUI_MSG_MOVE   23

◆ GUI_MSG_MOVE_OFFSET

#define GUI_MSG_MOVE_OFFSET   32

◆ GUI_MSG_NOTIFY_ALL

#define GUI_MSG_NOTIFY_ALL   21

◆ GUI_MSG_PAGE_CHANGE

#define GUI_MSG_PAGE_CHANGE   28

◆ GUI_MSG_PAGE_DOWN

#define GUI_MSG_PAGE_DOWN   31

◆ GUI_MSG_PAGE_UP

#define GUI_MSG_PAGE_UP   30

◆ GUI_MSG_REFRESH_LIST

#define GUI_MSG_REFRESH_LIST   29

◆ GUI_MSG_REFRESH_THUMBS

#define GUI_MSG_REFRESH_THUMBS   22

◆ GUI_MSG_REFRESH_TIMER

#define GUI_MSG_REFRESH_TIMER   50

Called every 500ms to allow time dependent updates.

◆ GUI_MSG_REMOVE_CONTROL

#define GUI_MSG_REMOVE_CONTROL   40

A request to remove a control.

◆ GUI_MSG_RENDERER_LOST

#define 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.

◆ GUI_MSG_RENDERER_RESET

#define 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.

◆ GUI_MSG_SET_DESELECTED

#define GUI_MSG_SET_DESELECTED   11

◆ GUI_MSG_SET_FILENAME

#define GUI_MSG_SET_FILENAME   47

Set the filename for an image control.

◆ GUI_MSG_SET_LABELS

#define GUI_MSG_SET_LABELS   46

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

◆ GUI_MSG_SET_SELECTED

#define GUI_MSG_SET_SELECTED   10

◆ GUI_MSG_SET_TEXT

#define GUI_MSG_SET_TEXT   42

◆ GUI_MSG_SET_TYPE

#define GUI_MSG_SET_TYPE   33

Instruct a control to set it's type appropriately.

◆ GUI_MSG_SETFOCUS

#define GUI_MSG_SETFOCUS   3

◆ GUI_MSG_SHOWRANGE

#define GUI_MSG_SHOWRANGE   18

◆ GUI_MSG_STATE_CHANGED

#define GUI_MSG_STATE_CHANGED   51

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

◆ GUI_MSG_SUBTITLE_DOWNLOADED

#define GUI_MSG_SUBTITLE_DOWNLOADED   52

Called when a subtitle download has finished.

◆ GUI_MSG_UI_READY

#define GUI_MSG_UI_READY   49

The user interface is ready for usage.

◆ GUI_MSG_UNFOCUS_ALL

#define GUI_MSG_UNFOCUS_ALL   41

A request to unfocus all currently focused controls.

◆ GUI_MSG_USER

#define GUI_MSG_USER   1000

◆ GUI_MSG_VALIDITY_CHANGED

#define GUI_MSG_VALIDITY_CHANGED   44

◆ GUI_MSG_VISIBLE

#define GUI_MSG_VISIBLE   6

◆ GUI_MSG_WINDOW_DEINIT

#define GUI_MSG_WINDOW_DEINIT   2

◆ GUI_MSG_WINDOW_INIT

#define GUI_MSG_WINDOW_INIT   1

◆ GUI_MSG_WINDOW_LOAD

#define GUI_MSG_WINDOW_LOAD   43

◆ GUI_MSG_WINDOW_RESET

#define GUI_MSG_WINDOW_RESET   27

◆ GUI_MSG_WINDOW_RESIZE

#define 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.

◆ SET_CONTROL_SELECTED

#define SET_CONTROL_SELECTED (   dwSenderId,
  controlID,
  bSelect 
)
Value:
do { \
CGUIMessage msg(bSelect?GUI_MSG_SET_SELECTED:GUI_MSG_SET_DESELECTED, dwSenderId, controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_SET_DESELECTED
Definition: GUIMessage.h:32
#define GUI_MSG_SET_SELECTED
Definition: GUIMessage.h:31

Typedef Documentation

◆ CGUIListItemPtr

typedef std::shared_ptr<CGUIListItem> CGUIListItemPtr