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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
(**************************************************************************)
(* Lablgtk *)
(* *)
(* This program is free software; you can redistribute it *)
(* and/or modify it under the terms of the GNU Library General *)
(* Public License as published by the Free Software Foundation *)
(* version 2, with the exception described in file COPYING which *)
(* comes with the library. *)
(* *)
(* 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 Library General Public License for more details. *)
(* *)
(* You should have received a copy of the GNU Library 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 *)
(* *)
(* *)
(**************************************************************************)
(* $Id$ *)
open Gobject
(** Signals *)
type id
type 'a marshaller = 'a -> Closure.argv -> unit
type ('a,'b) t =
{ name: string; classe: 'a; marshaller: 'b marshaller }
(** When writing marshallers, beware that the list omits the 0th
argument of argv, which is the referent object *)
type query = {
id : int;
signal_name : string;
itype : string;
flags : int;
return : string;
params : string array;
}
val stop_emit : unit -> unit
(** Call [stop_emit ()] in a callback to prohibit further handling
of the current signal invocation, by calling [emit_stop_by_name].
Be careful about where you use it, since the concept of current
signal may be tricky. *)
val connect :
sgn:('a, 'b) t -> callback:'b -> ?after:bool -> 'a obj -> id
(** You may use [stop_emit] inside the callback *)
val connect_property : prop:('a, 'b) Gobject.property ->
callback:('b -> unit) -> 'a Gobject.obj -> id
(** Connect to the "notify::foo" signal associated with a property. These
are emitted each time the property "foo" is set (including when it is
set to the same value). *)
val user_handler : (exn -> unit) ref
(** A hook to allow changing the behaviour of exceptions in callbacks
The default behaviour of printing the exception and ignoring it
is obtained when [user_handler] is set to [Pervasives.raise] *)
val safe_call : ?where:string -> ('a -> unit) -> 'a -> unit
(** Safe wrapper for function calls. Tries to handle exceptions
with user_handler, and reports an error otherwise. *)
external signal_new : string -> g_type -> Gobject.signal_type list -> unit = "ml_g_signal_new_me"
external list_ids : g_type -> int array = "ml_g_signal_list_ids"
external query : int -> query = "ml_g_signal_query"
external connect_by_name :
'a obj -> name:string -> callback:g_closure -> after:bool -> id
= "ml_g_signal_connect_closure"
external disconnect : 'a obj -> id -> unit
= "ml_g_signal_handler_disconnect"
external emit_stop_by_name : 'a obj -> name:string -> unit
= "ml_g_signal_stop_emission_by_name"
(** Unsafe: use [stop_emit] instead. *)
external handler_block : 'a obj -> id -> unit
= "ml_g_signal_handler_block"
external handler_unblock : 'a obj -> id -> unit
= "ml_g_signal_handler_unblock"
(** {4 Marshallers} Some marshaller functions, to build signals *)
val marshal_unit : (unit -> unit) marshaller
val marshal_int : (int -> unit) marshaller
val marshal_string : (string -> unit) marshaller
val marshal1 : 'a data_conv -> string -> ('a -> unit) marshaller
val marshal2 :
'a data_conv -> 'b data_conv -> string -> ('a -> 'b -> unit) marshaller
val marshal3 :
'a data_conv -> 'b data_conv -> 'c data_conv ->
string -> ('a -> 'b -> 'c -> unit) marshaller
val marshal4 :
'a data_conv -> 'b data_conv -> 'c data_conv -> 'd data_conv ->
string -> ('a -> 'b -> 'c -> 'd -> unit) marshaller
val marshal5 :
'a data_conv -> 'b data_conv -> 'c data_conv -> 'd data_conv ->
'e data_conv -> string -> ('a -> 'b -> 'c -> 'd -> 'e -> unit) marshaller
val marshal6 :
'a data_conv -> 'b data_conv -> 'c data_conv -> 'd data_conv ->
'e data_conv -> 'f data_conv ->
string -> ('a -> 'b -> 'c -> 'd -> 'e -> 'f -> unit) marshaller
val marshal0_ret : ret:'a data_conv -> (unit -> 'a) marshaller
val marshal1_ret :
ret:'a data_conv -> 'b data_conv -> string -> ('b -> 'a) marshaller
val marshal2_ret :
ret:'a data_conv -> 'b data_conv -> 'c data_conv ->
string -> ('b -> 'c -> 'a) marshaller
val marshal3_ret :
ret:'a data_conv -> 'b data_conv -> 'c data_conv -> 'd data_conv ->
string -> ('b -> 'c -> 'd -> 'a) marshaller
val marshal4_ret :
ret:'a data_conv -> 'b data_conv -> 'c data_conv -> 'd data_conv ->
'e data_conv -> string -> ('b -> 'c -> 'd -> 'e -> 'a) marshaller
(** {4 Emitter functions} *)
val emit :
'a Gobject.obj -> sgn:('a, 'b) t ->
emitter:(cont:('c Gobject.data_set array -> 'd) -> 'b) ->
conv:(Gobject.g_value -> 'd) -> 'b
val emit_unit : 'a obj -> sgn:('a, unit -> unit) t -> unit
val emit_int : 'a obj -> sgn:('a, int -> unit) t -> int -> unit
(** {4 Default handler override} *)
val override_class_closure : ('a, 'b) t -> g_type -> g_closure -> unit
external chain_from_overridden : Closure.argv -> unit = "ml_g_signal_chain_from_overridden"
(**/**)
(* Internal functions. *)
val enter_callback : (unit -> unit) ref
val exit_callback : (unit -> unit) ref
type saved_state
val push_callback : unit -> saved_state
val pop_callback : saved_state -> bool
|
