NetSurf
Typedefs | Enumerations | Functions
mouse.h File Reference

Core mouse and pointer states. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef enum browser_mouse_state browser_mouse_state
 Mouse state. More...
 
typedef enum gui_pointer_shape gui_pointer_shape
 

Enumerations

enum  browser_mouse_state {
  BROWSER_MOUSE_HOVER = 0 , BROWSER_MOUSE_PRESS_1 = (1 << 0) , BROWSER_MOUSE_PRESS_2 = (1 << 1) , BROWSER_MOUSE_CLICK_1 = (1 << 2) ,
  BROWSER_MOUSE_CLICK_2 = (1 << 3) , BROWSER_MOUSE_DOUBLE_CLICK = (1 << 4) , BROWSER_MOUSE_TRIPLE_CLICK = (1 << 5) , BROWSER_MOUSE_DRAG_1 = (1 << 6) ,
  BROWSER_MOUSE_DRAG_2 = (1 << 7) , BROWSER_MOUSE_DRAG_ON = (1 << 8) , BROWSER_MOUSE_HOLDING_1 = (1 << 9) , BROWSER_MOUSE_HOLDING_2 = (1 << 10) ,
  BROWSER_MOUSE_MOD_1 = (1 << 11) , BROWSER_MOUSE_MOD_2 = (1 << 12) , BROWSER_MOUSE_MOD_3 = (1 << 13) , BROWSER_MOUSE_LEAVE = (1 << 14)
}
 Mouse state. More...
 
enum  gui_pointer_shape {
  GUI_POINTER_DEFAULT , GUI_POINTER_POINT , GUI_POINTER_CARET , GUI_POINTER_MENU ,
  GUI_POINTER_UP , GUI_POINTER_DOWN , GUI_POINTER_LEFT , GUI_POINTER_RIGHT ,
  GUI_POINTER_RU , GUI_POINTER_LD , GUI_POINTER_LU , GUI_POINTER_RD ,
  GUI_POINTER_CROSS , GUI_POINTER_MOVE , GUI_POINTER_WAIT , GUI_POINTER_HELP ,
  GUI_POINTER_NO_DROP , GUI_POINTER_NOT_ALLOWED , GUI_POINTER_PROGRESS
}
 
enum  browser_pointer_shape {
  BROWSER_POINTER_DEFAULT = GUI_POINTER_DEFAULT , BROWSER_POINTER_POINT = GUI_POINTER_POINT , BROWSER_POINTER_CARET = GUI_POINTER_CARET , BROWSER_POINTER_MENU = GUI_POINTER_MENU ,
  BROWSER_POINTER_UP = GUI_POINTER_UP , BROWSER_POINTER_DOWN = GUI_POINTER_DOWN , BROWSER_POINTER_LEFT = GUI_POINTER_LEFT , BROWSER_POINTER_RIGHT = GUI_POINTER_RIGHT ,
  BROWSER_POINTER_RU = GUI_POINTER_RU , BROWSER_POINTER_LD = GUI_POINTER_LD , BROWSER_POINTER_LU = GUI_POINTER_LU , BROWSER_POINTER_RD = GUI_POINTER_RD ,
  BROWSER_POINTER_CROSS = GUI_POINTER_CROSS , BROWSER_POINTER_MOVE = GUI_POINTER_MOVE , BROWSER_POINTER_WAIT = GUI_POINTER_WAIT , BROWSER_POINTER_HELP = GUI_POINTER_HELP ,
  BROWSER_POINTER_NO_DROP = GUI_POINTER_NO_DROP , BROWSER_POINTER_NOT_ALLOWED = GUI_POINTER_NOT_ALLOWED , BROWSER_POINTER_PROGRESS = GUI_POINTER_PROGRESS , BROWSER_POINTER_AUTO
}
 Mouse pointer type. More...
 

Functions

void browser_mouse_state_dump (browser_mouse_state mouse)
 Debug function logs a browser mouse state. More...
 

Detailed Description

Core mouse and pointer states.

Definition in file mouse.h.

Typedef Documentation

◆ browser_mouse_state

Mouse state.

1 is primary mouse button (e.g. Select on RISC OS). 2 is secondary mouse button (e.g. Adjust on RISC OS).

Note
click meaning is different for different front ends. On RISC OS, it is standard to act on press, so a click is fired at the same time as a mouse button is pressed. With GTK, it is standard to act on release, so a click is fired when the mouse button is released, if the operation wasn't a drag.
double and triple clicks are fired alongside a BROWSER_MOUSE_CLICK_[1|2] to indicate which button is used.

◆ gui_pointer_shape

Enumeration Type Documentation

◆ browser_mouse_state

Mouse state.

1 is primary mouse button (e.g. Select on RISC OS). 2 is secondary mouse button (e.g. Adjust on RISC OS).

Note
click meaning is different for different front ends. On RISC OS, it is standard to act on press, so a click is fired at the same time as a mouse button is pressed. With GTK, it is standard to act on release, so a click is fired when the mouse button is released, if the operation wasn't a drag.
double and triple clicks are fired alongside a BROWSER_MOUSE_CLICK_[1|2] to indicate which button is used.
Enumerator
BROWSER_MOUSE_HOVER 

No mouse buttons pressed, May be used to indicate hover or end of drag.

BROWSER_MOUSE_PRESS_1 

button 1 pressed

BROWSER_MOUSE_PRESS_2 

button 2 pressed

BROWSER_MOUSE_CLICK_1 

button 1 clicked.

BROWSER_MOUSE_CLICK_2 

button 2 clicked.

BROWSER_MOUSE_DOUBLE_CLICK 

button double clicked

BROWSER_MOUSE_TRIPLE_CLICK 

button triple clicked

BROWSER_MOUSE_DRAG_1 

start of button 1 drag

BROWSER_MOUSE_DRAG_2 

start of button 2 drag

BROWSER_MOUSE_DRAG_ON 

a drag operation was started and a mouse button is still pressed

BROWSER_MOUSE_HOLDING_1 

during button 1 drag

BROWSER_MOUSE_HOLDING_2 

during button 2 drag

BROWSER_MOUSE_MOD_1 

1st modifier key pressed (eg.

Shift)

BROWSER_MOUSE_MOD_2 

2nd modifier key pressed (eg.

Ctrl)

BROWSER_MOUSE_MOD_3 

3rd modifier key pressed (eg.

Alt)

BROWSER_MOUSE_LEAVE 

pointer leaving window

Definition at line 43 of file mouse.h.

◆ browser_pointer_shape

Mouse pointer type.

Enumerator
BROWSER_POINTER_DEFAULT 
BROWSER_POINTER_POINT 
BROWSER_POINTER_CARET 
BROWSER_POINTER_MENU 
BROWSER_POINTER_UP 
BROWSER_POINTER_DOWN 
BROWSER_POINTER_LEFT 
BROWSER_POINTER_RIGHT 
BROWSER_POINTER_RU 
BROWSER_POINTER_LD 
BROWSER_POINTER_LU 
BROWSER_POINTER_RD 
BROWSER_POINTER_CROSS 
BROWSER_POINTER_MOVE 
BROWSER_POINTER_WAIT 
BROWSER_POINTER_HELP 
BROWSER_POINTER_NO_DROP 
BROWSER_POINTER_NOT_ALLOWED 
BROWSER_POINTER_PROGRESS 
BROWSER_POINTER_AUTO 

Definition at line 112 of file mouse.h.

◆ gui_pointer_shape

Enumerator
GUI_POINTER_DEFAULT 
GUI_POINTER_POINT 
GUI_POINTER_CARET 
GUI_POINTER_MENU 
GUI_POINTER_UP 
GUI_POINTER_DOWN 
GUI_POINTER_LEFT 
GUI_POINTER_RIGHT 
GUI_POINTER_RU 
GUI_POINTER_LD 
GUI_POINTER_LU 
GUI_POINTER_RD 
GUI_POINTER_CROSS 
GUI_POINTER_MOVE 
GUI_POINTER_WAIT 
GUI_POINTER_HELP 
GUI_POINTER_NO_DROP 
GUI_POINTER_NOT_ALLOWED 
GUI_POINTER_PROGRESS 

Definition at line 89 of file mouse.h.

Function Documentation

◆ browser_mouse_state_dump()

void browser_mouse_state_dump ( browser_mouse_state  mouse)