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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
(**************************************************************************)
(* 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$ *)
(** Useful functions for LablGTK. *)
(** {2 Menus} *)
(** Tree description of a menu *)
type menu_entry =
[ `I of string * (unit -> unit)
| `C of string * bool * (bool -> unit)
| `R of (string * bool * (bool -> unit)) list
| `M of string * menu_entry list
| `S ]
(** Build a menu from a tree description *)
val build_menu : GMenu.menu -> entries: menu_entry list -> unit
(** Popup a menu created from the given list of
labels and functions. *)
val popup_menu : entries: menu_entry list -> button: int -> time: int32 -> unit
(** {2 Parametrized dialog windows} *)
(**This function is used to display a question in a dialog box,
with a parametrized list of buttons. The function returns the number
of the clicked button (starting at 1), or 0 if the window is
savagedly destroyed.
@param parent the parent window in the front of which it should be displayed.
this also sets the [destroy_with_parent] property.
@param title the title of the dialog
@param buttons the list of button labels.
@param default the index of the default answer
@param icon a widget (usually a pixmap) which can be displayed on the left
of the window.
@param message the text to display
*)
val question_box :
?parent:#GWindow.window_skel ->
title:string ->
buttons:string list ->
?default:int -> ?icon:#GObj.widget -> string -> int
(**This function is used to display a message in a dialog box with just an Ok button.
We use [question_box] with just an ok button.
@param parent the parent window in the front of which it should be displayed.
this also sets the [destroy_with_parent] property.
@param title the title of the dialog
@param icon a widget (usually a pixmap) which can be displayed on the left
of the window.
@param ok the text for the ok button (default is "Ok")
@param message the text to display
*)
val message_box :
?parent:#GWindow.window_skel ->
title:string -> ?icon:#GObj.widget -> ?ok:string -> string -> unit
(** Make the user type in a string.
@return [None] if the user clicked on cancel, or [Some s] if the user
clicked on the ok button.
@param parent the parent window in the front of which it should be displayed.
this also sets the [destroy_with_parent] property.
@param title the title of the dialog
@param ok the text for the confirmation button (default is "Ok")
@param cancel the text for the cancel button (default is "Cancel")
@param text the default text displayed in the entry widget
@param message the text to display
*)
val input_string :
?parent:#GWindow.window_skel ->
title:string ->
?ok:string -> ?cancel:string -> ?text:string -> string -> string option
(** Make the user type in a text.
@return [None] if the user clicked on cancel, or [Some s] if the user
clicked on the ok button.
@param parent the parent window in the front of which it should be displayed.
this also sets the [destroy_with_parent] property.
@param title the title of the dialog
@param ok the text for the confirmation button (default is "Ok")
@param cancel the text for the cancel button (default is "Cancel")
@param text the default text displayed in the entry widget (utf8)
@param message the text to display
*)
val input_text :
?parent:#GWindow.window_skel ->
title:string ->
?ok:string -> ?cancel:string -> ?text:string -> string -> string option
(**This function allows the user to select a file and returns the
selected file name.
A VOIR : multi-selection ?
*)
val select_file :
title:string ->
?dir:string ref -> ?filename:string -> unit -> string option
(** A tree. *)
type 'a tree = [ `L of 'a | `N of 'a * 'a tree list]
(** A class to make the user select a node in a tree.
@param parent the parent window in the front of which it should be displayed.
this also sets the [destroy_with_parent] property.
@param tree is the tree to display.
@param label gives a label from the data of a node.
@param info gives a (Utf8) string from the data of a node,
to give more information to the user when he selects
a node.
@param width is the width of the tree widget
@param height is the height of the tree widget
*)
class ['a] tree_selection :
tree:'a tree ->
label:('a -> string) ->
info:('a -> string) ->
?packing:(GObj.widget -> unit) -> ?show:bool -> unit ->
object
inherit GObj.widget
val obj : Gtk.widget Gtk.obj
val mutable selection : 'a option
method clear_selection : unit -> unit
method selection : 'a option
method wview : GText.view
method wtree : GBroken.tree
end
(** A function to make the user select a node in a tree.
@param parent the parent window in the front of which it should be displayed.
this also sets the [destroy_with_parent] property.
@param tree the to build a tree selection widget
@param ok the text for the confirmation button (default is "Ok")
@param cancel the text for the cancel button (default is "Cancel")
@param title is the title of the window.
@return The data associated to the selected node, or None
if the user canceled the selection.
*)
val tree_selection_dialog :
?parent:#GWindow.window_skel ->
tree:'a tree ->
label:('a -> string) ->
info:('a -> string) ->
title:string ->
?ok:string -> ?cancel:string ->
?width:int -> ?height:int ->
?show:bool -> unit -> 'a option
(** {2 Keyboard shortcuts}
Associate messages to key combinations. *)
(** A keyboard shorcut: a combination of Alt, Control and Shift and a letter. *)
type key_combination = [ `A | `C | `S ] list * char
(** A shortcut specification: name of a GTK+ signal to emit, keyboard shortcuts
and the message to send. The name must be unique. *)
type 'a shortcut_specification = {
name : string;
keys : key_combination list;
message : 'a;
}
(** Setup the given shortcut spec list for the given window and callback.
This create the GTK+ signal, associate the keyboard shortcuts to it, make the
window listen to these shortcuts and eventually call the given callback with
the messages from the shortcut specification. *)
val create_shortcuts : window:#GWindow.window_skel ->
shortcuts:'a shortcut_specification list ->
callback:('a -> unit) ->
unit
(** {2 Miscellaneous functions} *)
(** Resize the columns of a clist according to the length of the
content and the title of each column.*)
val autosize_clist : 'a GList.clist -> unit
|
