Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
MouseStat.h File Reference

Classes

struct  MouseState
 
struct  MousePosition
 
class  CMouseStat
 

Macros

#define XBMC_BUTTON(X)   (1 << ((X)-1))
 
#define XBMC_BUTTON_LEFT   1
 
#define XBMC_BUTTON_MIDDLE   2
 
#define XBMC_BUTTON_RIGHT   3
 
#define XBMC_BUTTON_WHEELUP   4
 
#define XBMC_BUTTON_WHEELDOWN   5
 
#define XBMC_BUTTON_X1   6
 
#define XBMC_BUTTON_X2   7
 
#define XBMC_BUTTON_X3   8
 
#define XBMC_BUTTON_X4   9
 
#define XBMC_BUTTON_LMASK   XBMC_BUTTON(XBMC_BUTTON_LEFT)
 
#define XBMC_BUTTON_MMASK   XBMC_BUTTON(XBMC_BUTTON_MIDDLE)
 
#define XBMC_BUTTON_RMASK   XBMC_BUTTON(XBMC_BUTTON_RIGHT)
 
#define XBMC_BUTTON_X1MASK   XBMC_BUTTON(XBMC_BUTTON_X1)
 
#define XBMC_BUTTON_X2MASK   XBMC_BUTTON(XBMC_BUTTON_X2)
 
#define XBMC_BUTTON_X3MASK   XBMC_BUTTON(XBMC_BUTTON_X3)
 
#define XBMC_BUTTON_X4MASK   XBMC_BUTTON(XBMC_BUTTON_X4)
 
#define MOUSE_MINIMUM_MOVEMENT   2
 
#define MOUSE_DOUBLE_CLICK_LENGTH   500L
 
#define MOUSE_ACTIVE_LENGTH   5000L
 
#define MOUSE_MAX_BUTTON   7
 

Enumerations

enum  MOUSE_STATE { MOUSE_STATE_NORMAL = 1 , MOUSE_STATE_FOCUS , MOUSE_STATE_DRAG , MOUSE_STATE_CLICK }
 
enum  MOUSE_BUTTON {
  MOUSE_LEFT_BUTTON = 0 , MOUSE_RIGHT_BUTTON , MOUSE_MIDDLE_BUTTON , MOUSE_EXTRA_BUTTON1 ,
  MOUSE_EXTRA_BUTTON2 , MOUSE_EXTRA_BUTTON3 , MOUSE_EXTRA_BUTTON4
}
 

Macro Definition Documentation

◆ MOUSE_ACTIVE_LENGTH

#define MOUSE_ACTIVE_LENGTH   5000L

◆ MOUSE_DOUBLE_CLICK_LENGTH

#define MOUSE_DOUBLE_CLICK_LENGTH   500L

◆ MOUSE_MAX_BUTTON

#define MOUSE_MAX_BUTTON   7

◆ MOUSE_MINIMUM_MOVEMENT

#define MOUSE_MINIMUM_MOVEMENT   2

◆ XBMC_BUTTON

#define XBMC_BUTTON (   X)    (1 << ((X)-1))

◆ XBMC_BUTTON_LEFT

#define XBMC_BUTTON_LEFT   1

◆ XBMC_BUTTON_LMASK

#define XBMC_BUTTON_LMASK   XBMC_BUTTON(XBMC_BUTTON_LEFT)

◆ XBMC_BUTTON_MIDDLE

#define XBMC_BUTTON_MIDDLE   2

◆ XBMC_BUTTON_MMASK

#define XBMC_BUTTON_MMASK   XBMC_BUTTON(XBMC_BUTTON_MIDDLE)

◆ XBMC_BUTTON_RIGHT

#define XBMC_BUTTON_RIGHT   3

◆ XBMC_BUTTON_RMASK

#define XBMC_BUTTON_RMASK   XBMC_BUTTON(XBMC_BUTTON_RIGHT)

◆ XBMC_BUTTON_WHEELDOWN

#define XBMC_BUTTON_WHEELDOWN   5

◆ XBMC_BUTTON_WHEELUP

#define XBMC_BUTTON_WHEELUP   4

◆ XBMC_BUTTON_X1

#define XBMC_BUTTON_X1   6

◆ XBMC_BUTTON_X1MASK

#define XBMC_BUTTON_X1MASK   XBMC_BUTTON(XBMC_BUTTON_X1)

◆ XBMC_BUTTON_X2

#define XBMC_BUTTON_X2   7

◆ XBMC_BUTTON_X2MASK

#define XBMC_BUTTON_X2MASK   XBMC_BUTTON(XBMC_BUTTON_X2)

◆ XBMC_BUTTON_X3

#define XBMC_BUTTON_X3   8

◆ XBMC_BUTTON_X3MASK

#define XBMC_BUTTON_X3MASK   XBMC_BUTTON(XBMC_BUTTON_X3)

◆ XBMC_BUTTON_X4

#define XBMC_BUTTON_X4   9

◆ XBMC_BUTTON_X4MASK

#define XBMC_BUTTON_X4MASK   XBMC_BUTTON(XBMC_BUTTON_X4)

Enumeration Type Documentation

◆ MOUSE_BUTTON

Enumerator
MOUSE_LEFT_BUTTON 
MOUSE_RIGHT_BUTTON 
MOUSE_MIDDLE_BUTTON 
MOUSE_EXTRA_BUTTON1 
MOUSE_EXTRA_BUTTON2 
MOUSE_EXTRA_BUTTON3 
MOUSE_EXTRA_BUTTON4 

◆ MOUSE_STATE

Enumerator
MOUSE_STATE_NORMAL 
MOUSE_STATE_FOCUS 

< Normal state

MOUSE_STATE_DRAG 

< Control below the mouse is currently in focus

MOUSE_STATE_CLICK 

< A drag operation is being performed

< A mousebutton is being clicked