summaryrefslogtreecommitdiff
path: root/atk/atkobject.h
diff options
context:
space:
mode:
authorBill Haneman <billh@src.gnome.org>2006-08-01 15:07:14 +0000
committerBill Haneman <billh@src.gnome.org>2006-08-01 15:07:14 +0000
commit2056e054e4c25e15478b56c2d3c47ce8e098335a (patch)
tree75510682ca7f8830885af9e333361138fe874bc9 /atk/atkobject.h
parentc8234b660fda1143f8b2163c5379db8b283d84ae (diff)
downloadatk-2056e054e4c25e15478b56c2d3c47ce8e098335a.tar.gz
Tweak to AtkRoleType docs.
Diffstat (limited to 'atk/atkobject.h')
-rwxr-xr-xatk/atkobject.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/atk/atkobject.h b/atk/atkobject.h
index e338017..fbcc415 100755
--- a/atk/atkobject.h
+++ b/atk/atkobject.h
@@ -42,7 +42,7 @@ extern "C" {
*AtkRole:
*@ATK_ROLE_INVALID: Invalid role
*@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
- *@ATK_ROLE_ALERT: An object which is an alert to the user
+ *@ATK_ROLE_ALERT: An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc.
*@ATK_ROLE_ANIMATION: An object which is an animated image
*@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
*@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
@@ -113,7 +113,7 @@ extern "C" {
*@ATK_ROLE_FOOTER: An object that serves as a document footer.
*@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.
*@ATK_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).
- *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles.
+ *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION.
*@ATK_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry.
*@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar
*@ATK_ROLE_EMBEDDED: The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context.