File: event_arrows.mli

package info (click to toggle)
js-of-ocaml 2.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,612 kB
  • ctags: 10,589
  • sloc: ml: 36,459; makefile: 665; lisp: 41; sh: 14; ruby: 4; perl: 4
file content (126 lines) | stat: -rw-r--r-- 5,685 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
(* Js_of_ocaml library
 * http://www.ocsigen.org/js_of_ocaml/
 * Copyright (C) 2010 Vincent Balat
 * Laboratoire PPS - CNRS Université Paris Diderot
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *)

(** Warning: this module is now deprecated. Use Lwt_js_events instead. *)

type canceller (*VVV ? *)
type ('a, 'b) t
val lwt_arr : ('a -> 'b Lwt.t) -> ('a, 'b) t
val arr : ('a -> 'b) -> ('a, 'b) t
val (>>>) : ('a, 'b) t -> ('b, 'c) t -> ('a, 'c) t
val (>>>|) : ('a, 'b) t -> ('b -> 'c Lwt.t) -> ('a, 'c) t
val run : ('a, unit) t -> 'a -> canceller
val cancel : canceller -> unit

(** Behaves as the first element of the list to terminate *)
val first : ('a, 'b) t list -> ('a, 'b) t

(** Behaves as one element of the list, then another one, etc.
    If you launch several run in parallel, event handler will be parallelized,
    that is: one will not be desactivated while another is running.
    To sequentialize them, use iter.
*)
val iter : ('a, 'b) t list -> ('a, 'b) t

(*  val loop : ('a, 'b) t -> ('b, 'a) t -> ('a, 'c) t *)

(**
   Browsers propagate events from external boxes to internal (capture phase),
   then from internal to external (bubble phase).

   If [use_capture] is set to [true], the event will be caught during the
   capture phase (default: bubble phase).
 
   If [keep_default] is set to [true], the default event will not be removed.

   If [propagate] is set to [true], the event will continue to propagate
   after the handler.

*)

val click : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val dblclick : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val mousedown : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val mouseup : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val mouseover : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val mousemove : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val mouseout : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mouseEvent Js.t) t
val keypress : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.keyboardEvent Js.t) t
val keydown : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.keyboardEvent Js.t) t
val keyup : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.keyboardEvent Js.t) t
(* val mousewheel : ?use_capture : bool ->  ?keep_default : bool ->
  #Dom_html.eventTarget Js.t -> ('a, Dom_html.mousewheelEvent Js.t) t *)

val clicks : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val dblclicks : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val mousedowns : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val mouseups : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val mouseovers : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val mousemoves : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val mouseouts : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mouseEvent Js.t, 'a) t -> ('b, 'c) t
val keypresses : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.keyboardEvent Js.t, 'a) t -> ('b, 'c) t
val keydowns : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.keyboardEvent Js.t, 'a) t -> ('b, 'c) t
val keyups : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.keyboardEvent Js.t, 'a) t -> ('b, 'c) t
(* val mousewheels : ?use_capture : bool ->  ?keep_default : bool ->
  ?propagate : bool ->
  #Dom_html.eventTarget Js.t -> (Dom_html.mousewheelEvent Js.t, 'a) t -> ('b, 'c) t
*)