From c6e623b3b7eddc69917503ccf9f13d9986eb5ec0 Mon Sep 17 00:00:00 2001 From: Joanmarie Diggs Date: Tue, 11 Nov 2014 16:37:40 -0500 Subject: [PATCH] Add ATK_ROLE_STATIC and clarify ATK_ROLE_TEXT https://bugzilla.gnome.org/show_bug.cgi?id=739981 --- atk/atkobject.h | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/atk/atkobject.h b/atk/atkobject.h index 93b7c84..e0165d8 100755 --- a/atk/atkobject.h +++ b/atk/atkobject.h @@ -104,7 +104,13 @@ G_BEGIN_DECLS *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal. @Since: ATK-0.6 - *@ATK_ROLE_TEXT: An object that presents text to the user + *@ATK_ROLE_TEXT: An interactive widget that supports multiple lines of text and + * optionally accepts user input, but whose purpose is not to solicit user input. + * Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor + * but inappropriate for an input field in a dialog box or web form. For widgets + * whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and + * ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of + * textual information, see ATK_ROLE_STATIC. *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons *@ATK_ROLE_TOOL_TIP: An object that provides information about another object @@ -204,6 +210,19 @@ G_BEGIN_DECLS * description list. The values within a group are alternatives, * meaning that you can have several ATK_ROLE_DESCRIPTION_VALUE for a * given ATK_ROLE_DESCRIPTION_TERM. @Since: ATK-2.12 + *@ATK_ROLE_STATIC: A generic non-container object whose purpose is to display a + * brief amount of information to the user and whose role is known by the + * implementor but lacks semantic value for the user. Examples in which + * ATK_ROLE_STATIC is appropriate include the message displayed in a message box + * and an image used as an alternative means to display text. ATK_ROLE_STATIC + * should not be applied to widgets which are traditionally interactive, objects + * which display a significant amount of content, or any object which has an + * accessible relation pointing to another object. Implementors should expose the + * displayed information through the accessible name of the object. If doing so seems + * inappropriate, it may indicate that a different role should be used. For + * labels which describe another widget, see ATK_ROLE_LABEL. For text views, see + * ATK_ROLE_TEXT. For generic containers, see ATK_ROLE_PANEL. For objects whose + * role is not known by the implementor, see ATK_ROLE_UNKNOWN. @Since: ATK-2.16. *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration * * Describes the role of an object @@ -331,6 +350,7 @@ typedef enum ATK_ROLE_DESCRIPTION_LIST, ATK_ROLE_DESCRIPTION_TERM, ATK_ROLE_DESCRIPTION_VALUE, + ATK_ROLE_STATIC, ATK_ROLE_LAST_DEFINED } AtkRole; -- 2.7.4