helm/matita/matitaGtkMisc.ml

   1 (* Copyright (C) 2004-2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 exception PopupClosed
  27 open Printf
  28
  29 open MatitaTypes
  30
  31 let wrap_callback f = f
  32
  33 let connect_button (button: #GButton.button) callback =
  34   ignore (button#connect#clicked (wrap_callback callback))
  35
  36 let connect_toggle_button (button: #GButton.toggle_button) callback =
  37   ignore (button#connect#toggled (wrap_callback callback))
  38
  39 let connect_menu_item (menu_item: #GMenu.menu_item) callback =
  40   ignore (menu_item#connect#activate (wrap_callback callback))
  41
  42 let connect_key (ev:GObj.event_ops) ?(modifiers = []) ?(stop = false) key
  43   callback
  44 =
  45   ignore (ev#connect#key_press (fun key' ->
  46     let modifiers' = GdkEvent.Key.state key' in
  47     (match key' with
  48     | key' when GdkEvent.Key.keyval key' = key
  49           && List.for_all (fun m -> List.mem m modifiers') modifiers ->
  50         callback ();
  51         stop
  52     | _ -> false)))
  53
  54 let toggle_widget_visibility ~(widget: GObj.widget)
  55                               ~(check: GMenu.check_menu_item)
  56 =
  57   ignore (check#connect#toggled (fun _ ->
  58     if check#active then widget#misc#show () else widget#misc#hide ()))
  59
  60 let toggle_window_visibility ~(window: GWindow.window)
  61                               ~(check: GMenu.check_menu_item)
  62 =
  63   ignore (check#connect#toggled (fun _ ->
  64     if check#active then window#show () else window#misc#hide ()));
  65   ignore (window#event#connect#delete (fun _ ->
  66     window#misc#hide ();
  67     check#set_active false;
  68     true))
  69
  70 let toggle_win ?(check: GMenu.check_menu_item option) (win: GWindow.window) () =
  71   if win#is_active then win#misc#hide () else win#show ();
  72   match check with
  73   | None -> ()
  74   | Some check -> check#set_active (not check#active)
  75
  76 let toggle_callback ~callback ~(check: GMenu.check_menu_item) =
  77   ignore (check#connect#toggled (fun _ -> callback check#active))
  78
  79 let add_key_binding key callback (evbox: GBin.event_box) =
  80   ignore (evbox#event#connect#key_press (function
  81     | key' when GdkEvent.Key.keyval key' = key ->
  82         callback ();
  83         false
  84     | _ -> false))
  85
  86 class stringListModel (tree_view: GTree.view) =
  87   let column_list = new GTree.column_list in
  88   let text_column = column_list#add Gobject.Data.string in
  89   let list_store = GTree.list_store column_list in
  90   let renderer = (GTree.cell_renderer_text [], ["text", text_column]) in
  91   let view_column = GTree.view_column ~renderer () in
  92   object (self)
  93     initializer
  94       tree_view#set_model (Some (list_store :> GTree.model));
  95       ignore (tree_view#append_column view_column)
  96
  97     method list_store = list_store
  98
  99     method easy_append s =
 100       let tree_iter = list_store#append () in
 101       list_store#set ~row:tree_iter ~column:text_column s
 102
 103     method easy_insert pos s =
 104       let tree_iter = list_store#insert pos in
 105       list_store#set ~row:tree_iter ~column:text_column s
 106
 107     method easy_selection () =
 108       List.map
 109         (fun tree_path ->
 110           let iter = list_store#get_iter tree_path in
 111           list_store#get ~row:iter ~column:text_column)
 112         tree_view#selection#get_selected_rows
 113   end
 114
 115 class taggedStringListModel ~(tags:(string * GdkPixbuf.pixbuf) list)
 116   (tree_view: GTree.view)
 117 =
 118   let column_list = new GTree.column_list in
 119   let tag_column = column_list#add Gobject.Data.gobject in
 120   let text_column = column_list#add Gobject.Data.string in
 121   let list_store = GTree.list_store column_list in
 122   let text_renderer = (GTree.cell_renderer_text [], ["text", text_column]) in
 123   let tag_renderer = (GTree.cell_renderer_pixbuf [], ["pixbuf", tag_column]) in
 124   let text_vcolumn = GTree.view_column ~renderer:text_renderer () in
 125   let tag_vcolumn = GTree.view_column ~renderer:tag_renderer () in
 126   let lookup_pixbuf tag =
 127     try List.assoc tag tags with Not_found -> assert false
 128   in
 129   object (self)
 130     initializer
 131       tree_view#set_model (Some (list_store :> GTree.model));
 132       ignore (tree_view#append_column tag_vcolumn);
 133       ignore (tree_view#append_column text_vcolumn)
 134
 135     method list_store = list_store
 136
 137     method easy_append ~tag s =
 138       let tree_iter = list_store#append () in
 139       list_store#set ~row:tree_iter ~column:text_column s;
 140       list_store#set ~row:tree_iter ~column:tag_column (lookup_pixbuf tag)
 141
 142     method easy_insert pos ~tag s =
 143       let tree_iter = list_store#insert pos in
 144       list_store#set ~row:tree_iter ~column:text_column s;
 145       list_store#set ~row:tree_iter ~column:tag_column (lookup_pixbuf tag)
 146
 147     method easy_selection () =
 148       List.map
 149         (fun tree_path ->
 150           let iter = list_store#get_iter tree_path in
 151           list_store#get ~row:iter ~column:text_column)
 152         tree_view#selection#get_selected_rows
 153   end
 154
 155 class type gui =
 156   object
 157     method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
 158     method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
 159     method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
 160     method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
 161   end
 162
 163 let popup_message
 164   ~title ~message ~buttons ~callback
 165   ?(message_type=`QUESTION) ?parent ?(use_markup=true)
 166   ?(destroy_with_parent=true) ?(allow_grow=false) ?(allow_shrink=false)
 167   ?icon ?(modal=true) ?(resizable=false) ?screen ?type_hint
 168   ?(position=`CENTER_ON_PARENT) ?wm_name ?wm_class ?border_width ?width
 169   ?height ?(show=true) ()
 170 =
 171   let m =
 172     GWindow.message_dialog
 173       ~message ~use_markup ~message_type ~buttons ?parent ~destroy_with_parent
 174       ~title ~allow_grow ~allow_shrink ?icon ~modal ~resizable ?screen
 175       ?type_hint ~position ?wm_name ?wm_class ?border_width ?width ?height
 176       ~show ()
 177   in
 178   ignore(m#connect#response
 179     ~callback:(fun a ->  GMain.Main.quit ();callback a));
 180   ignore(m#connect#close
 181     ~callback:(fun _ -> GMain.Main.quit ();raise PopupClosed));
 182   GtkThread.main ();
 183   m#destroy ()
 184
 185 let popup_message_lowlevel
 186   ~title ~message ?(no_separator=true) ~callback ~message_type ~buttons
 187   ?parent  ?(destroy_with_parent=true) ?(allow_grow=false) ?(allow_shrink=false)
 188   ?icon ?(modal=true) ?(resizable=false) ?screen ?type_hint
 189   ?(position=`CENTER_ON_PARENT) ?wm_name ?wm_class ?border_width ?width
 190   ?height ?(show=true) ()
 191 =
 192   let m =
 193     GWindow.dialog
 194       ~no_separator
 195       ?parent ~destroy_with_parent
 196       ~title ~allow_grow ~allow_shrink ?icon ~modal ~resizable ?screen
 197       ?type_hint ~position ?wm_name ?wm_class ?border_width ?width ?height
 198       ~show:false ()
 199   in
 200   let stock =
 201     match message_type with
 202     | `WARNING -> `DIALOG_WARNING
 203     | `INFO -> `DIALOG_INFO
 204     | `ERROR ->`DIALOG_ERROR
 205     | `QUESTION -> `DIALOG_QUESTION
 206   in
 207   let image = GMisc.image ~stock ~icon_size:`DIALOG () in
 208   let label = GMisc.label ~markup:message () in
 209   label#set_line_wrap true;
 210   let hbox = GPack.hbox ~spacing:10 () in
 211   hbox#pack ~from:`START ~expand:true ~fill:true (image:>GObj.widget);
 212   hbox#pack ~from:`START ~expand:true ~fill:true (label:>GObj.widget);
 213   m#vbox#pack ~from:`START
 214     ~padding:20 ~expand:true ~fill:true (hbox:>GObj.widget);
 215   List.iter (fun (x, y) ->
 216     m#add_button_stock x y;
 217     if y = `CANCEL then
 218       m#set_default_response y
 219   ) buttons;
 220   ignore(m#connect#response
 221     ~callback:(fun a ->  GMain.Main.quit ();callback a));
 222   ignore(m#connect#close
 223     ~callback:(fun _ -> GMain.Main.quit ();callback `POPUPCLOSED));
 224   if show = true then
 225       m#show ();
 226   GtkThread.main ();
 227   m#destroy ()
 228
 229
 230 let ask_confirmation ~title ~message ?parent () =
 231   let rc = ref `YES in
 232   let callback =
 233     function
 234     | `YES -> rc := `YES
 235     | `NO -> rc := `NO
 236     | `CANCEL -> rc := `CANCEL
 237     | `DELETE_EVENT -> rc := `CANCEL
 238     | `POPUPCLOSED -> rc := `CANCEL
 239   in
 240   let buttons = [`YES,`YES ; `NO,`NO ; `CANCEL,`CANCEL] in
 241     popup_message_lowlevel
 242       ~title ~message ~message_type:`WARNING ~callback ~buttons ?parent ();
 243     !rc
 244
 245 let report_error ~title ~message ?parent () =
 246   let rc = ref false in
 247   let callback _ = () in
 248   let buttons = GWindow.Buttons.ok in
 249   try
 250     popup_message
 251       ~title ~message ~message_type:`ERROR ~callback ~buttons ?parent ()
 252   with
 253   | PopupClosed -> ()
 254
 255
 256 let ask_text ~(gui:#gui) ?(title = "") ?(msg = "") ?(multiline = false) () =
 257   let dialog = gui#newEmptyDialog () in
 258   dialog#emptyDialog#set_title title;
 259   dialog#emptyDialogLabel#set_label msg;
 260   let result = ref None in
 261   let return r =
 262     result := r;
 263     dialog#emptyDialog#destroy ();
 264     GMain.Main.quit ()
 265   in
 266   ignore (dialog#emptyDialog#event#connect#delete (fun _ -> true));
 267   if multiline then begin (* multiline input required: use a TextView widget *)
 268     let win =
 269       GBin.scrolled_window ~width:400 ~height:150 ~hpolicy:`NEVER
 270         ~vpolicy:`ALWAYS ~packing:dialog#emptyDialogVBox#add ()
 271     in
 272     let view = GText.view ~wrap_mode:`CHAR ~packing:win#add () in
 273     view#misc#grab_focus ();
 274     connect_button dialog#emptyDialogOkButton (fun _ ->
 275       return (Some (view#buffer#get_text ())))
 276   end else begin (* monoline input required: use a TextEntry widget *)
 277     let entry = GEdit.entry ~packing:dialog#emptyDialogVBox#add () in
 278     entry#misc#grab_focus ();
 279     connect_button dialog#emptyDialogOkButton (fun _ ->
 280       return (Some entry#text))
 281   end;
 282   connect_button dialog#emptyDialogCancelButton (fun _ ->return None);
 283   dialog#emptyDialog#show ();
 284   GtkThread.main ();
 285   (match !result with None -> raise Cancel | Some r -> r)
 286