treemodel foreach doc



The pod for treemodel->foreach() could helpfully show a sample call
rather than just describe it.  I always reckon a picture is worth a
thousand words with such things :-).

Index: GtkTreeModel.xs
===================================================================
--- GtkTreeModel.xs     (revision 2095)
+++ GtkTreeModel.xs     (working copy)
@@ -1317,8 +1317,11 @@
 ## void gtk_tree_model_foreach (GtkTreeModel *model, GtkTreeModelForeachFunc func, gpointer user_data)
 =for apidoc
 =for arg func (subroutine)
-Call I<$func> on each row in I<$model>.  I<$func> gets the tree path and iter
-of the current row; if I<$func> returns true, the tree ceases to be walked,
+Call I<$func> on each row in I<$model> as
+
+    bool = &$func ($model, $path, $iter, $user_data)
+
+If I<$func> returns true, the tree ceases to be walked,
 and C<< $treemodel->foreach >> returns.
 =cut
 void

-- 
Advertising jargon elucidated for the layman:
"Gadget" - any product which by definition you'll buy then never use.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]