summaryrefslogtreecommitdiff
path: root/gtk/gtkaccessible.c
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2020-11-10 14:38:09 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2020-11-10 14:38:09 +0000
commit2229d7f66c91fb44f828af1325e7b0233b34ba37 (patch)
tree908fbbad3fb1299ba4a6507438511de09ec85ddb /gtk/gtkaccessible.c
parented7619ec1667e0113bc454e1e09aa26c3f57be5e (diff)
downloadgtk+-2229d7f66c91fb44f828af1325e7b0233b34ba37.tar.gz
docs: Add example of relations with lists of references
Diffstat (limited to 'gtk/gtkaccessible.c')
-rw-r--r--gtk/gtkaccessible.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/gtk/gtkaccessible.c b/gtk/gtkaccessible.c
index 39c31d5b1e..13c4cb35ed 100644
--- a/gtk/gtkaccessible.c
+++ b/gtk/gtkaccessible.c
@@ -411,6 +411,18 @@ gtk_accessible_reset_property (GtkAccessible *self,
*
* This function should be called by #GtkWidget types whenever an accessible
* relation change must be communicated to assistive technologies.
+ *
+ * If the #GtkAccessibleRelation requires a list of references, you should
+ * pass each reference individually, followed by %NULL, e.g.
+ *
+ * |[<!-- language="C" -->
+ * gtk_accessible_update_relation (accessible,
+ * GTK_ACCESSIBLE_RELATION_CONTROLS,
+ * ref1, NULL,
+ * GTK_ACCESSIBLE_LABELLED_BY,
+ * ref1, ref2, ref3, NULL,
+ * -1);
+ * ]|
*/
void
gtk_accessible_update_relation (GtkAccessible *self,