Add gtk_widget_get_baseline
authorMatthias Clasen <mclasen@redhat.com>
Fri, 28 Apr 2023 19:18:13 +0000 (15:18 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 28 Apr 2023 19:18:13 +0000 (15:18 -0400)
This is just a renaming of gtk_widget_get_allocated_baseline
that fits better with gtk_widget_get_width/height.

gtk/gtkwidget.c
gtk/gtkwidget.h

index 20bb2eba2566c5a269774ba4632df1993e052a53..dc9cb14cf3867d04188c1ddb6d81d0910e279af2 100644 (file)
  *
  * If a widget ends up baseline aligned it will be allocated all the space in
  * the parent as if it was %GTK_ALIGN_FILL, but the selected baseline can be
- * found via [id@gtk_widget_get_allocated_baseline]. If the baseline has a
+ * found via [id@gtk_widget_get_baseline]. If the baseline has a
  * value other than -1 you need to align the widget such that the baseline
  * appears at the position.
  *
@@ -10479,6 +10479,26 @@ gtk_widget_get_allocated_height (GtkWidget *widget)
  */
 int
 gtk_widget_get_allocated_baseline (GtkWidget *widget)
+{
+  return gtk_widget_get_baseline (widget);
+}
+
+/**
+ * gtk_widget_get_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`Class.snapshot() function, and when allocating
+ * child widgets in `GtkWidget`Class.size_allocate().
+ *
+ * Returns: the baseline of the @widget, or -1 if none
+ *
+ * Since: 4.12
+ */
+int
+gtk_widget_get_baseline (GtkWidget *widget)
 {
   GtkWidgetPrivate *priv = gtk_widget_get_instance_private (widget);
   GtkCssStyle *style;
index 7b39d839015f74c00773a60d4bb976fe57c2b931..70ddb1b91a21fb15b733c80991fb407a5be69e19 100644 (file)
@@ -497,6 +497,8 @@ GDK_AVAILABLE_IN_ALL
 int                   gtk_widget_get_width              (GtkWidget     *widget);
 GDK_AVAILABLE_IN_ALL
 int                   gtk_widget_get_height             (GtkWidget     *widget);
+GDK_AVAILABLE_IN_4_12
+int                   gtk_widget_get_baseline           (GtkWidget     *widget);
 GDK_AVAILABLE_IN_ALL
 int                   gtk_widget_get_size               (GtkWidget     *widget,
                                                          GtkOrientation orientation);