Daily check-in.

[guestfs-browser.git] / filetree.mli

diff --git a/filetree.mli b/filetree.mli
index 46fd39a..cd047cc 100644 (file)
--- a/filetree.mli
+++ b/filetree.mli
@@ -27,9 +27,19 @@
     http://mail.gnome.org/archives/gtk-app-devel-list/2003-May/msg00241.html *)
 
 type t
+  (** A filetree widget.  Actually an opaque object which contains the
+      widget and other data.  Use the accessors below. *)
 
-val create : packing:(GObj.widget -> unit) -> unit -> t
-  (** Create a new filetree widget (empty). *)
+val create : ?status:(string -> unit) -> packing:(GObj.widget -> unit) -> unit -> t
+  (** Create a new filetree widget (empty).
+
+      In the optional [?status] parameter you can pass in some
+      function that updates a status bar.  This function will be
+      called by the filetree whenever the user should be told about
+      some ordinary event having happened (for example, that a file is
+      being downloaded or has finished downloading).
+
+      [~packing] is the required packing for the widget. *)
 
 val clear : t -> unit
   (** Clear out all rows in existing widget. *)
@@ -39,3 +49,6 @@ val add : t -> string -> Slave.inspection_data -> unit
       system and/or filesystems described by the [data] struct.  The
       [name] parameter should be some host-side (verifiable) name;
       usually we pass the name of the guest from libvirt here. *)
+
+val set_status_fn : t -> (string -> unit) -> unit
+  (** Set or update the [status] function. *)