From bff31f58a80b40dffd15a994de6bc3707f7fed51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Tyrychtr?= Date: Fri, 6 Oct 2023 16:25:04 +0200 Subject: [PATCH] Expand the docs on when you would want to use this API --- gtk/gtkaccessible.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/gtk/gtkaccessible.c b/gtk/gtkaccessible.c index 0fc86d9a9d..15daa06cff 100644 --- a/gtk/gtkaccessible.c +++ b/gtk/gtkaccessible.c @@ -756,7 +756,15 @@ gtk_accessible_reset_relation (GtkAccessible *self, * @self: a `GtkAccessible` * @message: the string to announce * @priority: the priority of the announcement + * * Requests the user's screen reader to announce the given message. + * This kind of notification is useful for messages that + * either have only a visual representation or that are not + * exposed visually at all, e.g. a notification about a + * successful operation. + * + * Also, by using this API, you can ensure that the message + * does not interrupts the user's current screen reader output. * * Since: 4.14 */