widget: Add docs for {get,set}_focus_child
authorTimm Bäder <mail@baedert.org>
Sun, 3 Jun 2018 09:32:09 +0000 (11:32 +0200)
committerTimm Bäder <mail@baedert.org>
Mon, 4 Jun 2018 19:58:44 +0000 (21:58 +0200)
With get_ being still private.

docs/reference/gtk/gtk4-sections.txt
gtk/gtkwidget.c

index 34c9d6b030e34783d940a2618b852254175e90aa..aef56e724ebc704b4a357cf26ccc5efb55a18f39 100644 (file)
@@ -4334,6 +4334,7 @@ gtk_widget_get_can_focus
 gtk_widget_set_can_focus
 gtk_widget_get_focus_on_click
 gtk_widget_set_focus_on_click
+gtk_widget_set_focus_child
 gtk_widget_get_has_surface
 gtk_widget_set_has_surface
 gtk_widget_get_sensitive
index 3e5864df06a1657c0860e63646914c4a6d4ed60a..ac2e6bd65605531509e62f6394f4a513f4e8722b 100644 (file)
@@ -13330,6 +13330,19 @@ gtk_widget_snapshot_child (GtkWidget   *widget,
   gtk_snapshot_offset (snapshot, -x, -y);
 }
 
+/**
+ * gtk_widget_set_focus_child:
+ * @widget: a #GtkWidget
+ * @child: (nullable): a direct child widget of @widget or %NULL
+ *   to unset the focus child of @widget
+ *
+ * Set @child as the current focus child of @widget. The previous
+ * focus child will be unset.
+ *
+ * This function is only suitable for widget implementations.
+ * If you want a certain widget to get the input focus, call
+ * gtk_widget_grab_focus() on it.
+*/
 void
 gtk_widget_set_focus_child (GtkWidget *widget,
                             GtkWidget *child)
@@ -13364,10 +13377,17 @@ gtk_widget_set_focus_child (GtkWidget *widget,
 
   if (GTK_IS_CONTAINER (widget))
     gtk_container_set_focus_child (GTK_CONTAINER (widget), child);
-
-  /* TODO: ??? */
 }
 
+/**
+ * gtk_widget_get_focus_child:
+ * @widget: a #GtkWidget
+ *
+ * Returns the current focus child of @widget.
+ *
+ * Returns: (nullable): The current focus child of @widget,
+ *   or %NULL in case the focus child is unset.
+ */
 GtkWidget *
 gtk_widget_get_focus_child (GtkWidget *widget)
 {