Remove bogus =end from end of manpage.
[virt-top.git] / virt-ctrl / vc_helpers.mli
1 (* virt-ctrl: A graphical management tool.
2    (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
3    http://libvirt.org/
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19    Helper functions.
20 *)
21
22 (** Given two lists, xs and ys, return a list of items which have been
23     added to ys, items which are the same, and items which have been
24     removed from ys.
25     Returns a triplet (list of added, list of same, list of removed).
26 *)
27 val differences : 'a list -> 'a list -> 'a list * 'a list * 'a list
28
29 (** Convert libvirt domain state to a string. *)
30 val string_of_domain_state : Libvirt.Domain.state -> string
31
32 (** Filter top level rows (only) in a GtkTreeStore.  If function f returns
33     true then the row remains, but if it returns false then the row is
34     removed.
35 *)
36 val filter_top_level_rows : GTree.tree_store -> (Gtk.tree_iter -> bool) -> unit
37
38 (** Filter rows in a tree_store at a particular level. *)
39 val filter_rows : GTree.tree_store -> (Gtk.tree_iter -> bool) -> Gtk.tree_iter -> unit
40
41 (** Find the first top level row matching predicate and return it. *)
42 val find_top_level_row : GTree.tree_store -> (Gtk.tree_iter -> bool) -> Gtk.tree_iter
43
44 (** Find the first row matching predicate f at a particular level. *)
45 val find_row : GTree.tree_store -> (Gtk.tree_iter -> bool) -> Gtk.tree_iter -> Gtk.tree_iter
46
47 (** Iterate over top level rows (only) in a GtkTreeStore. *)
48 val iter_top_level_rows : GTree.tree_store -> (Gtk.tree_iter -> unit) -> unit
49
50 (** Iterate over rows in a tree_store at a particular level. *)
51 val iter_rows : GTree.tree_store -> (Gtk.tree_iter -> unit) -> Gtk.tree_iter -> unit