[gtk+/wip/baseline2] Document gtk_widget_get_allocated_baseline



commit 3de86b38a064a73fc7f83f7b81069ef084ee4067
Author: Alexander Larsson <alexl redhat com>
Date:   Tue Mar 26 15:43:44 2013 +0100

    Document gtk_widget_get_allocated_baseline

 gtk/gtkwidget.c |   11 +++++++++++
 gtk/gtkwidget.h |    1 +
 2 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index d9bba88..7e0611f 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -14181,6 +14181,17 @@ gtk_widget_get_allocated_height (GtkWidget *widget)
   return widget->priv->allocation.height;
 }
 
+/**
+ * gtk_widget_get_allocated_baseline:
+ * @widget: the widget to query
+ *
+ * Returns the baseline that has currently been allocated to @widget.
+ * This function is intended to be used when implementing handlers
+ * for the #GtkWidget::draw function, and when allocating child
+ * widgets in #GtkWidget::size_allocate.
+ *
+ * Returns: the baseline of the @widget, or -1 if none
+ **/
 int
 gtk_widget_get_allocated_baseline (GtkWidget *widget)
 {
diff --git a/gtk/gtkwidget.h b/gtk/gtkwidget.h
index a81fbe6..c74038e 100644
--- a/gtk/gtkwidget.h
+++ b/gtk/gtkwidget.h
@@ -683,6 +683,7 @@ void                  gtk_widget_unregister_window      (GtkWidget    *widget,
 
 int                   gtk_widget_get_allocated_width    (GtkWidget     *widget);
 int                   gtk_widget_get_allocated_height   (GtkWidget     *widget);
+GDK_AVAILABLE_IN_3_10
 int                   gtk_widget_get_allocated_baseline (GtkWidget     *widget);
 
 void                  gtk_widget_get_allocation         (GtkWidget     *widget,


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