(* Copyright (C) 2004-2005, HELM Team.
 * 
 * This file is part of HELM, an Hypertextual, Electronic
 * Library of Mathematics, developed at the Computer Science
 * Department, University of Bologna, Italy.
 * 
 * HELM is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * HELM 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HELM; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA  02111-1307, USA.
 * 
 * For details, see the HELM World-Wide-Web page,
 * http://helm.cs.unibo.it/
 *)

class type console =
object
  method message: string -> unit
  method error: string -> unit
  method warning: string -> unit
  method debug: string -> unit
  method clear: unit -> unit

  method log_callback: MatitaLog.log_callback
end

class type browserWin =
object
  inherit MatitaGeneratedGui.browserWin
  method browserUri: GEdit.combo_box_entry
end

  (** @param fname name of the Glade file describing the GUI *)
class type gui =
object

  method setQuitCallback    : (unit -> unit) -> unit

    (** {2 Access to singleton instances of lower-level GTK widgets} *)

  method about :        MatitaGeneratedGui.aboutWin
  method fileSel :      MatitaGeneratedGui.fileSelectionWin
  method main :         MatitaGeneratedGui.mainWin
(*   method toolbar :      MatitaGeneratedGui.toolBarWin *)

  method console:       console

    (** {2 Dialogs instantiation}
     * methods below create a new window on each invocation. You should
     * remember to destroy windows after use *)

  method newBrowserWin:         unit -> browserWin
  method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
  method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
  method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
  method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog

    (** {2 Utility methods} *)

    (** ask the used to choose a file with the file chooser
    * @param ok_not_exists if set to true returns also non existent files
    * (useful for save). Defaults to false *)
  method chooseFile: ?ok_not_exists:bool -> unit -> string option

    (** prompt the user for a (multiline) text entry *)
  method askText: ?title:string -> ?msg:string -> unit -> string option

  method loadScript: string -> unit
                                                            
end

  (** singleton instance of the gui *)
val instance: unit -> gui

  (** {2 Disambiguation callbacks}
  * Use singleton gui instance. *)

  (** @param selection_mode selection mode in uri list, default to `MULTIPLE
    * @param title window title, defaults to ""
    * @param msg message for the user, defaults to ""
    * @param nonvars_button enable button to exclude vars?, defaults to false
    * @raise MatitaTypes.Cancel *)
val interactive_uri_choice:
  ?selection_mode:([`SINGLE|`MULTIPLE]) -> ?title:string ->
  ?msg:string -> ?nonvars_button:bool -> 
  ?hide_uri_entry:bool -> ?hide_try:bool -> ?ok_label:string ->
  ?ok_action:[`AUTO|`SELECT] ->
  ?copy_cb:(string -> unit) -> unit ->
    MatitaDisambiguator.choose_uris_callback

  (** @raise MatitaTypes.Cancel *)
val interactive_interp_choice:
  unit ->
    MatitaDisambiguator.choose_interp_callback