window.mli

   1 (* Guestfs Browser.
   2  * Copyright (C) 2010 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 (** The Window module handles all aspects of the main window, menus,
  20     dialogs and so on. *)
  21
  22 class window :
  23 object ('a)
  24   method after : 'a
  25   method disconnect : GtkSignal.id -> unit
  26
  27   (** Signals that can be emitted by window. *)
  28   method connect_kvm_signal : callback:(unit -> unit) -> GtkSignal.id
  29   method connect_xen_signal : callback:(unit -> unit) -> GtkSignal.id
  30   method connect_none_signal : callback:(unit -> unit) -> GtkSignal.id
  31   method connect_uri_signal : callback:(unit -> unit) -> GtkSignal.id
  32   method inspection_signal : callback:(unit -> unit) -> GtkSignal.id
  33
  34   method failure : exn -> unit
  35     (** This is the global error handling function.  It is invoked in
  36         the main thread for failures in the slave thread (see
  37         {!Slave.set_failure_hook}). *)
  38
  39   method throbber_busy : unit -> unit
  40   method throbber_idle : unit -> unit
  41     (** These are callbacks from the slave thread (invoked in the main
  42         thread) which are called whenever the throbber should be
  43         animated/busy or idle.  *)
  44
  45   method set_statusbar : string -> unit
  46     (** This callback from the slave thread (invoked in the main thread)
  47         updates the status bar when some slave operation starts or
  48         stops. *)
  49
  50   method progress : int64 * int64 -> unit
  51     (** This called whenever the progress bar should move. *)
  52
  53   method tree : Filetree.tree
  54     (** Return the filetree contained in the window. *)
  55
  56   method connect_to : string option -> unit -> unit
  57     (** Connect to the given libvirt URI. *)
  58
  59   method run_cli_request : Cmdline.cli_request -> unit
  60     (** This function performs the {!Cmdline.cli_request} operation.
  61         The actual operation happens asynchronously after this function
  62         has returned. *)
  63
  64 end