Module OsgGA.Gui_event_adapter

module Gui_event_adapter: sig .. end

Event class for storing keyboard, mouse and window events.

type event_type =

`\|`	`NONE`
`\|`	`PUSH`
`\|`	`RELEASE`
`\|`	`DOUBLECLICK`
`\|`	`DRAG`
`\|`	`MOVE`
`\|`	`KEYDOWN`
`\|`	`KEYUP`
`\|`	`FRAME`
`\|`	`RESIZE`
`\|`	`SCROLL`
`\|`	`PEN_PRESSURE`
`\|`	`PEN_PROXIMITY_ENTER`
`\|`	`PEN_PROXIMITY_LEAVE`
`\|`	`CLOSE_WINDOW`
`\|`	`QUIT_APPLICATION`
`\|`	`USER`

type key_symbol =

`\|`	`KEY_Custom of int`
`\|`	`KEY_Space`	`(*`	0x20	`*)`
`\|`	`KEY_BackSpace`	`(*`	0xFF08	`*)`
`\|`	`KEY_Tab`	`(*`	0xFF09	`*)`
`\|`	`KEY_Linefeed`	`(*`	0xFF0A	`*)`
`\|`	`KEY_Clear`	`(*`	0xFF0B	`*)`
`\|`	`KEY_Return`	`(*`	0xFF0D	`*)`
`\|`	`KEY_Pause`	`(*`	0xFF13	`*)`
`\|`	`KEY_Scroll_Lock`	`(*`	0xFF14	`*)`
`\|`	`KEY_Sys_Req`	`(*`	0xFF15	`*)`
`\|`	`KEY_Escape`	`(*`	0xFF1B	`*)`
`\|`	`KEY_Delete`	`(*`	0xFFFF	`*)`
`\|`	`KEY_Home`	`(*`	0xFF50	`*)`
`\|`	`KEY_Left`	`(*`	0xFF51	`*)`
`\|`	`KEY_Up`	`(*`	0xFF52	`*)`
`\|`	`KEY_Right`	`(*`	0xFF53	`*)`
`\|`	`KEY_Down`	`(*`	0xFF54	`*)`
`\|`	`KEY_Prior`	`(*`	0xFF55	`*)`
`\|`	`KEY_Page_Up`	`(*`	0xFF55	`*)`
`\|`	`KEY_Next`	`(*`	0xFF56	`*)`
`\|`	`KEY_Page_Down`	`(*`	0xFF56	`*)`
`\|`	`KEY_End`	`(*`	0xFF57	`*)`
`\|`	`KEY_Begin`	`(*`	0xFF58	`*)`
`\|`	`KEY_Select`	`(*`	0xFF60	`*)`
`\|`	`KEY_Print`	`(*`	0xFF61	`*)`
`\|`	`KEY_Execute`	`(*`	0xFF62	`*)`
`\|`	`KEY_Insert`	`(*`	0xFF63	`*)`
`\|`	`KEY_Undo`	`(*`	0xFF65	`*)`
`\|`	`KEY_Redo`	`(*`	0xFF66	`*)`
`\|`	`KEY_Menu`	`(*`	0xFF67	`*)`
`\|`	`KEY_Find`	`(*`	0xFF68	`*)`
`\|`	`KEY_Cancel`	`(*`	0xFF69	`*)`
`\|`	`KEY_Help`	`(*`	0xFF6A	`*)`
`\|`	`KEY_Break`	`(*`	0xFF6B	`*)`
`\|`	`KEY_Mode_switch`	`(*`	0xFF7E	`*)`
`\|`	`KEY_Script_switch`	`(*`	0xFF7E	`*)`
`\|`	`KEY_Num_Lock`	`(*`	0xFF7F	`*)`
`\|`	`KEY_KP_Space`	`(*`	0xFF80	`*)`
`\|`	`KEY_KP_Tab`	`(*`	0xFF89	`*)`
`\|`	`KEY_KP_Enter`	`(*`	0xFF8D	`*)`
`\|`	`KEY_KP_F1`	`(*`	0xFF91	`*)`
`\|`	`KEY_KP_F2`	`(*`	0xFF92	`*)`
`\|`	`KEY_KP_F3`	`(*`	0xFF93	`*)`
`\|`	`KEY_KP_F4`	`(*`	0xFF94	`*)`
`\|`	`KEY_KP_Home`	`(*`	0xFF95	`*)`
`\|`	`KEY_KP_Left`	`(*`	0xFF96	`*)`
`\|`	`KEY_KP_Up`	`(*`	0xFF97	`*)`
`\|`	`KEY_KP_Right`	`(*`	0xFF98	`*)`
`\|`	`KEY_KP_Down`	`(*`	0xFF99	`*)`
`\|`	`KEY_KP_Prior`	`(*`	0xFF9A	`*)`
`\|`	`KEY_KP_Page_Up`	`(*`	0xFF9A	`*)`
`\|`	`KEY_KP_Next`	`(*`	0xFF9B	`*)`
`\|`	`KEY_KP_Page_Down`	`(*`	0xFF9B	`*)`
`\|`	`KEY_KP_End`	`(*`	0xFF9C	`*)`
`\|`	`KEY_KP_Begin`	`(*`	0xFF9D	`*)`
`\|`	`KEY_KP_Insert`	`(*`	0xFF9E	`*)`
`\|`	`KEY_KP_Delete`	`(*`	0xFF9F	`*)`
`\|`	`KEY_KP_Equal`	`(*`	0xFFBD	`*)`
`\|`	`KEY_KP_Multiply`	`(*`	0xFFAA	`*)`
`\|`	`KEY_KP_Add`	`(*`	0xFFAB	`*)`
`\|`	`KEY_KP_Separator`	`(*`	0xFFAC	`*)`
`\|`	`KEY_KP_Subtract`	`(*`	0xFFAD	`*)`
`\|`	`KEY_KP_Decimal`	`(*`	0xFFAE	`*)`
`\|`	`KEY_KP_Divide`	`(*`	0xFFAF	`*)`
`\|`	`KEY_KP_0`	`(*`	0xFFB0	`*)`
`\|`	`KEY_KP_1`	`(*`	0xFFB1	`*)`
`\|`	`KEY_KP_2`	`(*`	0xFFB2	`*)`
`\|`	`KEY_KP_3`	`(*`	0xFFB3	`*)`
`\|`	`KEY_KP_4`	`(*`	0xFFB4	`*)`
`\|`	`KEY_KP_5`	`(*`	0xFFB5	`*)`
`\|`	`KEY_KP_6`	`(*`	0xFFB6	`*)`
`\|`	`KEY_KP_7`	`(*`	0xFFB7	`*)`
`\|`	`KEY_KP_8`	`(*`	0xFFB8	`*)`
`\|`	`KEY_KP_9`	`(*`	0xFFB9	`*)`
`\|`	`KEY_F1`	`(*`	0xFFBE	`*)`
`\|`	`KEY_F2`	`(*`	0xFFBF	`*)`
`\|`	`KEY_F3`	`(*`	0xFFC0	`*)`
`\|`	`KEY_F4`	`(*`	0xFFC1	`*)`
`\|`	`KEY_F5`	`(*`	0xFFC2	`*)`
`\|`	`KEY_F6`	`(*`	0xFFC3	`*)`
`\|`	`KEY_F7`	`(*`	0xFFC4	`*)`
`\|`	`KEY_F8`	`(*`	0xFFC5	`*)`
`\|`	`KEY_F9`	`(*`	0xFFC6	`*)`
`\|`	`KEY_F10`	`(*`	0xFFC7	`*)`
`\|`	`KEY_F11`	`(*`	0xFFC8	`*)`
`\|`	`KEY_F12`	`(*`	0xFFC9	`*)`
`\|`	`KEY_F13`	`(*`	0xFFCA	`*)`
`\|`	`KEY_F14`	`(*`	0xFFCB	`*)`
`\|`	`KEY_F15`	`(*`	0xFFCC	`*)`
`\|`	`KEY_F16`	`(*`	0xFFCD	`*)`
`\|`	`KEY_F17`	`(*`	0xFFCE	`*)`
`\|`	`KEY_F18`	`(*`	0xFFCF	`*)`
`\|`	`KEY_F19`	`(*`	0xFFD0	`*)`
`\|`	`KEY_F20`	`(*`	0xFFD1	`*)`
`\|`	`KEY_F21`	`(*`	0xFFD2	`*)`
`\|`	`KEY_F22`	`(*`	0xFFD3	`*)`
`\|`	`KEY_F23`	`(*`	0xFFD4	`*)`
`\|`	`KEY_F24`	`(*`	0xFFD5	`*)`
`\|`	`KEY_F25`	`(*`	0xFFD6	`*)`
`\|`	`KEY_F26`	`(*`	0xFFD7	`*)`
`\|`	`KEY_F27`	`(*`	0xFFD8	`*)`
`\|`	`KEY_F28`	`(*`	0xFFD9	`*)`
`\|`	`KEY_F29`	`(*`	0xFFDA	`*)`
`\|`	`KEY_F30`	`(*`	0xFFDB	`*)`
`\|`	`KEY_F31`	`(*`	0xFFDC	`*)`
`\|`	`KEY_F32`	`(*`	0xFFDD	`*)`
`\|`	`KEY_F33`	`(*`	0xFFDE	`*)`
`\|`	`KEY_F34`	`(*`	0xFFDF	`*)`
`\|`	`KEY_F35`	`(*`	0xFFE0	`*)`
`\|`	`KEY_Shift_L`	`(*`	0xFFE1	`*)`
`\|`	`KEY_Shift_R`	`(*`	0xFFE2	`*)`
`\|`	`KEY_Control_L`	`(*`	0xFFE3	`*)`
`\|`	`KEY_Control_R`	`(*`	0xFFE4	`*)`
`\|`	`KEY_Caps_Lock`	`(*`	0xFFE5	`*)`
`\|`	`KEY_Shift_Lock`	`(*`	0xFFE6	`*)`
`\|`	`KEY_Meta_L`	`(*`	0xFFE7	`*)`
`\|`	`KEY_Meta_R`	`(*`	0xFFE8	`*)`
`\|`	`KEY_Alt_L`	`(*`	0xFFE9	`*)`
`\|`	`KEY_Alt_R`	`(*`	0xFFEA	`*)`
`\|`	`KEY_Super_L`	`(*`	0xFFEB	`*)`
`\|`	`KEY_Super_R`	`(*`	0xFFEC	`*)`
`\|`	`KEY_Hyper_L`	`(*`	0xFFED	`*)`
`\|`	`KEY_Hyper_R`	`(*`	0xFFEE	`*)`

type mouse_button =

`\|`	`LEFT_MOUSE_BUTTON`	`(*`	= 1	`*)`
`\|`	`MIDDLE_MOUSE_BUTTON`	`(*`	= 2	`*)`
`\|`	`RIGHT_MOUSE_BUTTON`	`(*`	= 4	`*)`

type t

osgGA::GUIEventAdapter holder. Used in OsgGA.Gui_event_handlers.

val get_event_type : t -> event_type

Get the type of the GUI.

val get_x : t -> float

get current mouse x position.

val get_y : t -> float

get current mouse y position.

val get_key : t -> key_symbol option

get key pressed, return None if inappropriate for this OsgGA.Gui_event_adapter.

val get_button_mask : t -> int

get current mouse button state

val get_mouse_buttons : t -> mouse_button list

get currently pressed mouse buttons list

val get_window : t -> float * float * float * float

get_window t -> (x, y, width, height)

val get_mouse : t -> float * float * float * float

get_mouse t -> (min_x, min_y, max_x, max_y)