[gtkmm] Container: Document several rarely used virtual functions



commit eed95de99f7703526c2a5b2605af84e15e02dc88
Author: Mark Vender <markv743 yahoo co uk>
Date:   Wed May 2 13:10:35 2012 +0000

    Container: Document several rarely used virtual functions
    
    * gtk/src/container.hg: Add documentation for the following functions:
    child_type(), forall(), composite_child(), [get|set]_child_property(). The
    documentation comes from the C docs.
    
    Bug #670206.

 gtk/src/container.hg |   33 ++++++++++++++++++++++++++++++++-
 1 files changed, 32 insertions(+), 1 deletions(-)
---
diff --git a/gtk/src/container.hg b/gtk/src/container.hg
index 8abf7fc..43f4894 100644
--- a/gtk/src/container.hg
+++ b/gtk/src/container.hg
@@ -178,11 +178,42 @@ public:
 protected:
   _CTOR_DEFAULT()
 
+  /** Implements child_type(). The default implementation returns G_TYPE_NONE
+   */
   _WRAP_VFUNC(GType child_type() const, child_type)
+
+  /** Invokes callback on all children of the container. The callback is invoked
+   * also on children that are considered "internal" (implementation details of
+   * the container). "Internal" children generally weren't added by the user
+   * of the container, but were added by the container implementation itself.
+   * Most applications should use foreach(), rather than forall().
+   */
   _WRAP_VFUNC(void forall(gboolean include_internals, GtkCallback callback, gpointer callback_data), forall)
-  //TODO: What is this?
+
+  /** Returns the composite name of a child widget. Composite widgets are
+   * children of the container that are considered "internal" (implementation
+   * details of the container). "Internal" children generally weren't added by
+   * the user of the container, but were added by the container implementation
+   * itself.
+   *
+   * The user is responsible for freeing the returned string.
+   */
   _WRAP_VFUNC(char* composite_name(GtkWidget* child), composite_name)
+
+  /** Sets a child property for this container and its child. Child properties
+   * are object properties that are not specific to either the container or the
+   * contained widget, but rather to their relation. Typical examples of child
+   * properties are the position or pack-type of a widget which is contained in
+   * a Gtk::Box.
+   */
   _WRAP_VFUNC(void set_child_property(GtkWidget* child, guint property_id, const GValue* value, GParamSpec* pspec), set_child_property)
+
+  /** Returns a child property for this container and its child. Child
+   * properties are object properties that are not specific to either the
+   * container or the contained widget, but rather to their relation. Typical
+   * examples of child properties are the position or pack-type of a widget
+   * which is contained in a Gtk::Box.
+   */
   _WRAP_VFUNC(void get_child_property(GtkWidget* child, guint property_id, GValue* value, GParamSpec* pspec) const, get_child_property)
 
   _WRAP_PROPERTY("border_width", guint)



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