Mention that after setting a button child the user is responsible for a11y relations
authorLukáš Tyrychtr <lukastyrychtr@gmail.com>
Mon, 20 Sep 2021 08:52:16 +0000 (10:52 +0200)
committerLukáš Tyrychtr <lukastyrychtr@gmail.com>
Mon, 20 Sep 2021 08:52:16 +0000 (10:52 +0200)
gtk/gtkbutton.c

index 49f068176724f57c02300aae4a554d95995d5085..f02ca168bc89c32b566b6b1c55dbc44e24b6b3b0 100644 (file)
@@ -1035,6 +1035,12 @@ gtk_button_get_action_helper (GtkButton *button)
  * @child: (nullable): the child widget
  *
  * Sets the child widget of @button.
+ *
+ * Note that by using this API, you take full responsibility for setting
+ * up the proper accessibility label and description information for @button.
+ * Most likely, you'll either set the accessibility label or description
+ * for @button explicitly, or you'll set a labelled-by or described-by
+ * relations from @child to @button.
  */
 void
 gtk_button_set_child (GtkButton *button,