[gtkmm] TreeView: set_row_separator_func(): Add some documentatino.



commit 8b6f6d6de41c3c1a1c73235e0f397a5baa117fac
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Sep 20 13:28:47 2011 +0200

    TreeView: set_row_separator_func(): Add some documentatino.
    
    * gtk/src/treeview.hg: Add documentation to the method and to the typedef,
    based on the C documentation.
    However, this will not all be seen by people because of bug #657844, which
    apparently is a regression in doxygen.

 ChangeLog           |    9 +++++++++
 gtk/src/treeview.hg |   10 ++++++++--
 2 files changed, 17 insertions(+), 2 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 6a3c544..a76efef 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2011-09-20  Murray Cumming  <murrayc murrayc com>
+
+	TreeView: set_row_separator_func(): Add some documentatino.
+
+	* gtk/src/treeview.hg: Add documentation to the method and to the typedef, 
+	based on the C documentation.
+	However, this will not all be seen by people because of bug #657844, which 
+	apparently is a regression in doxygen.
+
 3.1.90.1:
 
 2011-09-19  Murray Cumming  <murrayc murrayc com>
diff --git a/gtk/src/treeview.hg b/gtk/src/treeview.hg
index a5d23ce..258ae42 100644
--- a/gtk/src/treeview.hg
+++ b/gtk/src/treeview.hg
@@ -693,11 +693,17 @@ public:
   //TODO: Rename to get_is?
   _WRAP_METHOD(bool is_rubber_banding_active() const, gtk_tree_view_is_rubber_banding_active)
 
-  /** For instance,
-   * void on_row_separator(const Gtk::TreeModel& model, const Gtk::TreeModel::iterator& iter);
+  /** The slot type for determining whether the row pointed to by the iterator should be rendered as a separator.
+   * Return true if the row is a separator. 
+   * A common way to implement this is to have a boolean column in the model, whose values the slot returns. 
+   *
+   * For instance,
+   * bool on_row_separator(const Glib::RefPtr<Gtk::TreeModel>& model, const Gtk::TreeModel::iterator& iter);
    */
   typedef sigc::slot<bool, const Glib::RefPtr<TreeModel>&, const TreeModel::iterator&> SlotRowSeparator;
 
+  /** Sets the row separator function, which is used to determine whether a row should be drawn as a separator.
+   */
   void set_row_separator_func(const SlotRowSeparator& slot);
   _IGNORE(gtk_tree_view_set_row_separator_func, gtk_tree_view_get_row_separator_func)
 



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