package inquire

  1. Overview
  2. Docs

Module LTerm_mouse

Mouse events

type button =
  1. | Button1
  2. | Button2
  3. | Button3
  4. | Button4
  5. | Button5
  6. | Button6
  7. | Button7
  8. | Button8
  9. | Button9

Type of mouse button.

type t = {
  1. control : bool;
    (*

    Is the control key down ?

    *)
  2. meta : bool;
    (*

    Is the meta key down ?

    *)
  3. shift : bool;
    (*

    Is the shift key down ?

    *)
  4. button : button;
    (*

    Which button have been pressed ?

    *)
  5. row : int;
    (*

    The row at which the mouse was when the button has been pressed.

    *)
  6. col : int;
    (*

    The column at which the mouse was when the button has been pressed.

    *)
}

Type of mouse click event.

val compare : t -> t -> int

Same as Pervasives.compare.

val control : t -> bool
val meta : t -> bool
val button : t -> button
val row : t -> int
val col : t -> int
val coord : t -> LTerm_geom.coord
val to_string : t -> string

Returns the string representation of the given mouse event.