[gtk+/wip/baseline2] Document gtkbox functions



commit 6ce70b33c60708264c2f151eba7564ff9cf74fc7
Author: Alexander Larsson <alexl redhat com>
Date:   Tue Mar 26 15:39:32 2013 +0100

    Document gtkbox functions

 gtk/gtkbox.c |   20 ++++++++++++++++++++
 gtk/gtkbox.h |    2 ++
 2 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkbox.c b/gtk/gtkbox.c
index 18b3165..c1e916a 100644
--- a/gtk/gtkbox.c
+++ b/gtk/gtkbox.c
@@ -1783,6 +1783,18 @@ gtk_box_get_spacing (GtkBox *box)
   return box->priv->spacing;
 }
 
+/**
+ * gtk_box_set_baseline_position:
+ * @box: a #GtkBox
+ * @position: a #GtkBaselinePosition
+ *
+ * Sets the baseline position of a box. This affects
+ * only horizontal boxes with at least one baseline aligned
+ * child. If there is more vertical space availible than requested,
+ * and the baseline is not allocated by the parent then
+ * @position is used to allocate the baseline wrt the
+ * extra space available.
+ */
 void
 gtk_box_set_baseline_position (GtkBox             *box,
                               GtkBaselinePosition position)
@@ -1803,6 +1815,14 @@ gtk_box_set_baseline_position (GtkBox             *box,
     }
 }
 
+/**
+ * gtk_box_get_baseline_position:
+ * @box: a #GtkBox
+ *
+ * Gets the value set by gtk_box_set_baseline_position().
+ *
+ * Return value: the baseline position
+ **/
 GtkBaselinePosition
 gtk_box_get_baseline_position (GtkBox         *box)
 {
diff --git a/gtk/gtkbox.h b/gtk/gtkbox.h
index accdbad..e93c97f 100644
--- a/gtk/gtkbox.h
+++ b/gtk/gtkbox.h
@@ -89,8 +89,10 @@ gboolean    gtk_box_get_homogeneous     (GtkBox         *box);
 void        gtk_box_set_spacing         (GtkBox         *box,
                                          gint            spacing);
 gint        gtk_box_get_spacing         (GtkBox         *box);
+GDK_AVAILABLE_IN_3_10
 void        gtk_box_set_baseline_position (GtkBox             *box,
                                           GtkBaselinePosition position);
+GDK_AVAILABLE_IN_3_10
 GtkBaselinePosition gtk_box_get_baseline_position (GtkBox         *box);
 
 void        gtk_box_reorder_child       (GtkBox         *box,


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