Module Gtk_helper


module Gtk_helper: sig .. end
Generic Gtk helpers.
Consult the Plugin Development Guide for additional details.

val framac_logo : GdkPixbuf.pixbuf option
Since Boron-20100401
val framac_icon : GdkPixbuf.pixbuf option
Since Boron-20100401

Tags


val make_tag : < create_tag : ?name:string -> GText.tag_property list -> GText.tag;
tag_table : Gtk.text_tag_table; .. > ->
name:string -> GText.tag_property list -> GText.tag
Consult the Plugin Development Guide for additional details.
val apply_tag : GSourceView2.source_buffer -> GText.tag -> int -> int -> unit
Consult the Plugin Development Guide for additional details.
val remove_tag : GSourceView2.source_buffer -> GText.tag -> int -> int -> unit
val cleanup_tag : GSourceView2.source_buffer -> GText.tag -> unit
Consult the Plugin Development Guide for additional details.
val cleanup_all_tags : GSourceView2.source_buffer -> unit

Channels


val make_formatter : ?flush:(unit -> unit) -> #GText.buffer -> Format.formatter
Build a formatter that redirects its output to the given buffer. flush is called whenever the formatter is flushed.
val channel_redirector : Unix.file_descr -> (string -> bool) -> unit
Redirects all strings written to the file descriptor and call the given function on each.
val log_redirector : ?flush:(unit -> unit) -> (string -> unit) -> unit
Redirects all strings written to the terminal and call the given function on each.
val redirect : Format.formatter -> #GText.buffer -> unit
Redirect the given formatter to the given buffer

Locks


val gui_unlocked : bool Pervasives.ref
This is a mutex you may use to prevent running some code while the GUI is locked.
val register_locking_machinery : ?lock_last:bool ->
lock:(bool -> unit) -> unlock:(unit -> unit) -> unit -> unit
Add hooks to the locking mechanism of the GUI. lock_last must be set to true if lock must be executed after all the others locking actions and unlock must be executed before all the others unlocking actions. Default is false. At least one "lock_last" action is allowed.
Since Beryllium-20090901
Change in Boron-20100401: new optional argument lock_last and new argument ()

Chooser


type 'a chooser = GPack.box -> string -> (unit -> 'a) -> ('a -> unit) -> unit -> unit 
Pack a check button with the given getter and setter.
val on_bool : ?use_markup:bool -> bool chooser
val on_bool_radio : ?use_markup:bool ->
GPack.box ->
string -> string -> (unit -> bool) -> (bool -> unit) -> unit -> unit
val on_int : ?use_markup:bool ->
?lower:int ->
?upper:int ->
?sensitive:(unit -> bool) -> ?width:int -> int chooser
Returns a function usable for refreshing purpose. By default, sensitivity is set to true when this function is called.
val on_string : ?use_markup:bool -> ?validator:(string -> bool) -> string chooser
val on_string_set : ?use_markup:bool -> string chooser
val on_string_completion : ?use_markup:bool ->
?validator:(string -> bool) -> string list -> string chooser
val on_combo : string list -> ?use_markup:bool -> ?width:int -> string chooser

Error manager


class type host = object .. end
A utility class to catch exceptions and report proper error messages.
class error_manager : GWindow.window_skel -> host
A utility class to catch exceptions and report proper error messages.

Source files chooser


class type source_files_chooser_host = object .. end
val source_files_chooser : source_files_chooser_host ->
string list -> (string list -> unit) -> unit
Open a dialog box for choosing C source files and performing an action on them.
Since Boron-20100401

Miscellaneous


val refresh_gui : unit -> unit
Process pending events in the main Glib loop. This is intended to be called only when !gui_unlocked == false.
Since Beryllium-20090901
val string_selector : string list -> (GObj.widget -> unit) -> GEdit.entry
val expand_to_path : GTree.view -> Gtk.tree_path -> unit
val make_string_list : packing:(GObj.widget -> unit) ->
(string -> unit) * (unit -> unit) * (unit -> string list)
Returns (add, remove_selected, get_elements)
val place_paned : GPack.paned -> float -> unit
Sets the position of the paned widget to the given ratio
val old_gtk_compat : ('a -> unit) -> 'a -> unit
Catch exception Not_found and do nothing
val make_text_page : GPack.notebook -> string -> (GPack.notebook -> unit) * GText.view
Insert a GText.view in a new page of the notebook with the given title. It returns a new GText.view together with a function to reparent the inserted page in another notebook. The tab label of the created page will be highlighted whenever its contents changes.
Since Beryllium-20090901
module MAKE_CUSTOM_LIST: 
functor (A : sig
type t 
val custom_value : Gobject.g_type ->
t -> column:int -> Gobject.basic
val column_list : GTree.column_list
end) -> sig .. end
A functor to build custom Gtk lists.