Library
Module
Module type
Parameter
Class
Class type
Building graphical interface to edit configuration parameters.
type configuration_structure =
| Section of string * parameter_kind list
label of the section, parameters
*)| Section_list of string * configuration_structure list
label of the section, list of the sub sections
*)This type represents the structure of the configuration window.
val string_to_key : string -> Gdk.Tags.modifier list * int
val key_to_string : (Gdk.Tags.modifier list * int) -> string
val key_wrapper : (Gdk.Tags.modifier list * int) Ocf.wrapper
val key_option :
?doc:string ->
?cb:((Gdk.Tags.modifier list * int) -> unit) ->
(Gdk.Tags.modifier list * int) ->
(Gdk.Tags.modifier list * int) Ocf.conf_option
val string :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
string ->
string ->
parameter_kind
string label value
creates a string parameter.
val custom_string :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:('a -> unit) ->
to_string:('a -> string) ->
of_string:(string -> 'a) ->
string ->
'a ->
parameter_kind
Same as Configwin.string
but for values which are not strings.
val bool :
?editable:bool ->
?help:string ->
?f:(bool -> unit) ->
string ->
bool ->
parameter_kind
bool label value
creates a boolean parameter.
val strings :
?editable:bool ->
?help:string ->
?f:(string list -> unit) ->
?eq:(string -> string -> bool) ->
?add:(unit -> string list) ->
string ->
string list ->
parameter_kind
strings label value
creates a string list parameter.
val list :
?editable:bool ->
?help:string ->
?f:('a list -> unit) ->
?eq:('a -> 'a -> bool) ->
?edit:('a -> 'a) ->
?add:(unit -> 'a list) ->
?color:('a -> string option) ->
string ->
(('a -> string) * string option) list ->
'a list ->
parameter_kind
list label columns value
creates a list parameter. columns
is a list of pairs (f, title option), with f
takeing a value and returning a string to display it. The value
is the initial list.
val color :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
string ->
string ->
parameter_kind
color label value
creates a color parameter.
val font :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
string ->
string ->
parameter_kind
font label value
creates a font parameter.
val combo :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
?new_allowed:bool ->
string ->
string list ->
string ->
parameter_kind
combo label choices value
creates a combo parameter.
val text :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
string ->
string ->
parameter_kind
text label value
creates a text parameter.
val custom_text :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:('a -> unit) ->
to_string:('a -> string) ->
of_string:(string -> 'a) ->
string ->
'a ->
parameter_kind
Same as Configwin.text
but for values which are not strings.
val html :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
string ->
string ->
parameter_kind
Same as Configwin.text
but html bindings are available in the text widget. Use the configwin_html_config
utility to edit your bindings.
val filename :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:(string -> unit) ->
string ->
string ->
parameter_kind
filename label value
creates a filename parameter.
val filenames :
?editable:bool ->
?help:string ->
?f:(string list -> unit) ->
?eq:(string -> string -> bool) ->
string ->
string list ->
parameter_kind
filenames label value
creates a filename list parameter.
val date :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:((int * int * int) -> unit) ->
?f_string:((int * int * int) -> string) ->
string ->
(int * int * int) ->
parameter_kind
date label value
creates a date parameter.
val hotkey :
?editable:bool ->
?expand:bool ->
?help:string ->
?f:((Gdk.Tags.modifier list * int) -> unit) ->
string ->
(Gdk.Tags.modifier list * int) ->
parameter_kind
hotkey label value
creates a hot key parameter. A hot key is defined by a list of modifiers and a key code.
val custom :
?label:string ->
GPack.box ->
(unit -> unit) ->
bool ->
parameter_kind
custom box f expand
creates a custom parameter, with the given box
, the f
function is called when the user wants to apply his changes, and expand
indicates if the box must expand in its father.
val edit :
?parent:GWindow.window_skel ->
?apply:(unit -> unit) ->
string ->
?width:int ->
?height:int ->
configuration_structure list ->
return_button
This function takes a configuration structure and creates a window to configure the various parameters.
val get :
?parent:GWindow.window_skel ->
string ->
?width:int ->
?height:int ->
configuration_structure list ->
return_button
This function takes a configuration structure and creates a window used to get the various parameters from the user. It is the same window as edit but there is no apply button.
val simple_edit :
?parent:GWindow.window_skel ->
?apply:(unit -> unit) ->
string ->
?width:int ->
?height:int ->
parameter_kind list ->
return_button
This function takes a list of parameter specifications and creates a window to configure the various parameters.
val simple_get :
?parent:GWindow.window_skel ->
string ->
?width:int ->
?height:int ->
parameter_kind list ->
return_button
This function takes a list of parameter specifications and creates a window to configure the various parameters, without Apply button.
val box : parameter_kind list -> GPack.box * (unit -> unit)
Create a GPack.box
with the list of given parameters, Return the box and the function to call to apply new values to parameters.
val tabbed_box :
configuration_structure list ->
(string * (unit -> unit)) list ->
GPack.box
Create a GPack.box
with the list of given configuration structure list, and the given list of buttons (defined by their label and callback). Before calling the callback of a button, the apply
function of each parameter is called.