Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Windows and Messages

Classes

class  CGUIDialog
 
class  CGUIMessage
 
class  CGUIWindow
 

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. 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 SEND_CLICK_MESSAGE(id, parentID, action)
 Click message sent from controls to windows. More...
 

Detailed Description

Windows and messages

Macro Definition Documentation

◆ CONTROL_DESELECT

#define CONTROL_DESELECT (   controlID)
Value:
do { \
CGUIMessage msg(GUI_MSG_SET_DESELECTED, GetID(), controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_SET_DESELECTED
Definition: GUIMessage.h:32

◆ CONTROL_DISABLE

#define CONTROL_DISABLE (   controlID)
Value:
do { \
CGUIMessage msg(GUI_MSG_DISABLED, GetID(), controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_DISABLED
Definition: GUIMessage.h:29

◆ CONTROL_ENABLE

#define CONTROL_ENABLE (   controlID)
Value:
do { \
CGUIMessage msg(GUI_MSG_ENABLED, GetID(), controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_ENABLED
Definition: GUIMessage.h:28

◆ CONTROL_ENABLE_ON_CONDITION

#define CONTROL_ENABLE_ON_CONDITION (   controlID,
  bCondition 
)
Value:
do { \
CGUIMessage msg(bCondition ? GUI_MSG_ENABLED:GUI_MSG_DISABLED, GetID(), controlID); \
OnMessage(msg); \
} while(0)

◆ CONTROL_SELECT

#define CONTROL_SELECT (   controlID)
Value:
do { \
CGUIMessage msg(GUI_MSG_SET_SELECTED, GetID(), controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_SET_SELECTED
Definition: GUIMessage.h:31

◆ CONTROL_SELECT_ITEM

#define CONTROL_SELECT_ITEM (   controlID,
  iItem 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_ITEM_SELECT, GetID(), controlID,iItem); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_ITEM_SELECT
Definition: GUIMessage.h:41

◆ SEND_CLICK_MESSAGE

#define SEND_CLICK_MESSAGE (   id,
  parentID,
  action 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_CLICKED, id, parentID, action); \
SendWindowMessage(msg); \
} while(0)
#define GUI_MSG_CLICKED
Definition: GUIMessage.h:23

Click message sent from controls to windows.

◆ SET_CONTROL_FILENAME

#define SET_CONTROL_FILENAME (   controlID,
  label 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_SET_FILENAME, GetID(), controlID); \
msg.SetLabel(label); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_SET_FILENAME
Set the filename for an image control.
Definition: GUIMessage.h:134

Set the label of the current control.

◆ SET_CONTROL_FOCUS

#define SET_CONTROL_FOCUS (   controlID,
  dwParam 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_SETFOCUS, GetID(), controlID, dwParam); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_SETFOCUS
Definition: GUIMessage.h:20

◆ SET_CONTROL_HIDDEN

#define SET_CONTROL_HIDDEN (   controlID)
Value:
do { \
CGUIMessage msg(GUI_MSG_HIDDEN, GetID(), controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_HIDDEN
Definition: GUIMessage.h:26

◆ SET_CONTROL_LABEL

#define SET_CONTROL_LABEL (   controlID,
  label 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_LABEL_SET, GetID(), controlID); \
msg.SetLabel(label); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_LABEL_SET
Definition: GUIMessage.h:36

Set the label of the current control.

◆ SET_CONTROL_LABEL2

#define SET_CONTROL_LABEL2 (   controlID,
  label 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_LABEL2_SET, GetID(), controlID); \
msg.SetLabel(label); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_LABEL2_SET
Definition: GUIMessage.h:42

Set the second label of the current control.

◆ SET_CONTROL_LABEL_THREAD_SAFE

#define SET_CONTROL_LABEL_THREAD_SAFE (   controlID,
  label 
)
Value:
{ \
CGUIMessage msg(GUI_MSG_LABEL_SET, GetID(), controlID); \
msg.SetLabel(label); \
if(g_application.IsCurrentThread()) \
OnMessage(msg); \
else \
CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg, GetID()); \
}
#define g_application
Definition: Application.h:485

Set the label of the current control.

◆ SET_CONTROL_LABELS

#define SET_CONTROL_LABELS (   controlID,
  defaultValue,
  labels 
)
Value:
do { \
CGUIMessage msg(GUI_MSG_SET_LABELS, GetID(), controlID, defaultValue); \
msg.SetPointer(labels); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_SET_LABELS
Bind a set of labels to a spin (or similar) control.
Definition: GUIMessage.h:129

Set a bunch of labels on the given control.

◆ SET_CONTROL_VISIBLE

#define SET_CONTROL_VISIBLE (   controlID)
Value:
do { \
CGUIMessage msg(GUI_MSG_VISIBLE, GetID(), controlID); \
OnMessage(msg); \
} while(0)
#define GUI_MSG_VISIBLE
Definition: GUIMessage.h:25