atkobject.h 39.5 KB
Newer Older
Bill Haneman's avatar
Bill Haneman committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* ATK -  Accessibility Toolkit
 * Copyright 2001 Sun Microsystems Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Piotr Drąg's avatar
Piotr Drąg committed
15
16
17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Bill Haneman's avatar
Bill Haneman committed
18
19
 */

20
21
22
#ifndef __ATK_OBJECT_H__
#define __ATK_OBJECT_H__

23
24
25
26
#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
#error "Only <atk/atk.h> can be included directly."
#endif

Bill Haneman's avatar
Bill Haneman committed
27
#include <glib-object.h>
28
29

#include <atk/atkversion.h>
30
#include <atk/atkstate.h>
31
#include <atk/atkrelationtype.h>
Bill Haneman's avatar
Bill Haneman committed
32

33
34
G_BEGIN_DECLS

35
36
37
38
/**
 *AtkRole:
 *@ATK_ROLE_INVALID: Invalid role
 *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
Bill Haneman's avatar
Bill Haneman committed
39
 *@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.
40
41
42
43
44
45
46
47
 *@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
 *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
 *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
 *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
 *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
 *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
48
 *@ATK_ROLE_COMBO_BOX: A collapsible list of choices the user can select from
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
 *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
 *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
 *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
 *@ATK_ROLE_DIALOG: A top level window with title bar and a border
 *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
 *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
 *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
 *@ATK_ROLE_FILLER: A object that fills up space in a user interface
 *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
 *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
 *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
 *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
 *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
 *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
 *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
 *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
 *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
 *@ATK_ROLE_LIST: An object that presents a list of objects to the user and allows the user to select one or more of them 
 *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list 
 *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
 *@ATK_ROLE_MENU_BAR: An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from 
 *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
 *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
 *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
 *@ATK_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object 
 *@ATK_ROLE_PANEL: A generic container that is often used to group objects
 *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
 *@ATK_ROLE_POPUP_MENU: A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
 *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
 *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
80
 *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked
81
82
83
84
85
86
87
88
89
 *@ATK_ROLE_RADIO_MENU_ITEM: A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
 *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
 *@ATK_ROLE_ROW_HEADER: The header for a row of data
 *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
 *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
 *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
 *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
 *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
 *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
90
 *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
91
 *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
92
93
94
95
 *@ATK_ROLE_TABLE_CELL: A cell in a table
 *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
 *@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
96
 *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal.  (Since: 0.6)
97
98
99
100
101
102
103
 *@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.
104
 *@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
105
106
 *@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
107
 *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
108
 *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data.   (Since: 0.7)
109
110
 *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
 *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
111
 *@ATK_ROLE_WINDOW: A top level window with no title or border.
112
113
114
115
116
117
118
119
120
121
122
123
 *@ATK_ROLE_HEADER: An object that serves as a document header. (Since: 1.1.1)
 *@ATK_ROLE_FOOTER: An object that serves as a document footer.  (Since: 1.1.1)
 *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.   (Since: 1.1.1)
 *@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).   (Since: 1.1.1)
 *@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.   (Since: 1.1.4)
 *@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.   (Since: 1.3)
 *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar.  (Since: 1.5)
 *@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.  (Since: 1.7.2)
 *@ATK_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present.   (Since: 1.11)
 *@ATK_ROLE_CHART: The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property.  (Since: 1.11)
 *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.  (Since: 1.11)
 *@ATK_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface.  (Since: 1.11)
124
 *@ATK_ROLE_HEADING: The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.
125
126
127
 *@ATK_ROLE_PAGE: The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model.  (Since: 1.11)
 *@ATK_ROLE_SECTION: The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. (Since: 1.11)
 *@ATK_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons.  Objects of this role should normally be ignored by clients. (Since: 1.11)
128
129
130
 *@ATK_ROLE_FORM: The object is a container for form controls, for instance as part of a 
 * web form or user-input form within a document.  This role is primarily a tag/convenience for 
 * clients when navigating complex documents, it is not expected that ordinary GUI containers will 
131
 * always have ATK_ROLE_FORM. (Since: 1.12.0)
Bill Haneman's avatar
Bill Haneman committed
132
133
134
135
 *@ATK_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
 * hypertext document.  Such objects are distinct from 'inline'
 * content which may also use the Hypertext/Hyperlink interfaces
 * to indicate the range/location within a text object where
136
 * an inline or embedded object lies.  (Since: 1.12.1)
137
138
 *@ATK_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport 
 * which is used to allow composition or input of a 'complex character',
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 * in other words it is an "input method window." (Since: 1.12.1)
 *@ATK_ROLE_TABLE_ROW: A row in a table.  (Since: 2.1.0)
 *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree.  (Since: 2.1.0)
 *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet.  (Since: 2.1.0)
 *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content.  (Since: 2.1.0)
 *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application.  (Since: 2.1.0)
 *@ATK_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other markup suitable for display in a web browser.  (Since: 2.1.0)
 *@ATK_ROLE_DOCUMENT_EMAIL: A document frame which contains email content to be displayed or composed either in plain text or HTML.  (Since: 2.1.0)
 *@ATK_ROLE_COMMENT: An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated.  (Since: 2.1.0)
 *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. (Since: 2.1.0)
 *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. (Since: 2.1.0)
 *@ATK_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. (Since: 2.1.0)
 *@ATK_ROLE_NOTIFICATION: A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application.  (Since: 2.1.0)
 *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. (Since: 2.1.0)
 *@ATK_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery.  (Since: 2.7.3)
154
 *@ATK_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
155
 * dialog. (Since: 2.12)
156
 *@ATK_ROLE_BLOCK_QUOTE: An object which contains a text section
157
158
159
160
 * that is quoted from another source. (Since: 2.12)
 *@ATK_ROLE_AUDIO: An object which represents an audio element. (Since: 2.12)
 *@ATK_ROLE_VIDEO: An object which represents a video element. (Since: 2.12)
 *@ATK_ROLE_DEFINITION: A definition of a term or concept. (Since: 2.12)
161
162
 *@ATK_ROLE_ARTICLE: A section of a page that consists of a
 * composition that forms an independent part of a document, page, or
163
 * site. Examples: A blog entry, a news story, a forum post. (Since: 2.12)
164
165
166
 *@ATK_ROLE_LANDMARK: A region of a web page intended as a
 * navigational landmark. This is designed to allow Assistive
 * Technologies to provide quick navigation among key regions within a
167
 * document. (Since: 2.12)
168
169
170
171
172
 *@ATK_ROLE_LOG: A text widget or container holding log content, such
 * as chat history and error logs. In this role there is a
 * relationship between the arrival of new items in the log and the
 * reading order. The log contains a meaningful sequence and new
 * information is added only to the end of the log, not at arbitrary
173
 * points. (Since: 2.12)
174
175
176
177
 *@ATK_ROLE_MARQUEE: A container where non-essential information
 * changes frequently. Common usages of marquee include stock tickers
 * and ad banners. The primary difference between a marquee and a log
 * is that logs usually have a meaningful order or sequence of
178
 * important content changes. (Since: 2.12)
179
 *@ATK_ROLE_MATH: A text widget or container that holds a mathematical
180
 * expression. (Since: 2.12)
181
182
183
 *@ATK_ROLE_RATING: A widget whose purpose is to display a rating,
 * such as the number of stars associated with a song in a media
 * player. Objects of this role should also implement
184
 * AtkValue. (Since: 2.12)
185
186
 *@ATK_ROLE_TIMER: An object containing a numerical counter which
 * indicates an amount of elapsed time from a start point, or the time
187
 * remaining until an end point. (Since: 2.12)
188
189
190
191
192
 *@ATK_ROLE_DESCRIPTION_LIST: An object that represents a list of
 * term-value groups. A term-value group represents a individual
 * description and consist of one or more names
 * (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
 * (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be
193
 * more than one group with the same term name. (Since: 2.12)
194
 *@ATK_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase
195
 * with a corresponding definition. (Since: 2.12)
196
 *@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the
197
 * description, definition or value of a term. (Since: 2.12)
198
199
200
 *@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
201
202
 * %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
203
204
205
206
207
 * 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
208
209
210
 * 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: 2.16)
211
 *@ATK_ROLE_MATH_FRACTION: An object that represents a mathematical fraction.
212
 * (Since: 2.16)
213
 *@ATK_ROLE_MATH_ROOT: An object that represents a mathematical expression
214
 * displayed with a radical. (Since: 2.16)
215
 *@ATK_ROLE_SUBSCRIPT: An object that contains text that is displayed as a
216
 * subscript. (Since: 2.16)
217
 *@ATK_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a
218
219
 * superscript. (Since: 2.16)
 *@ATK_ROLE_FOOTNOTE: An object that contains the text of a footnote. (Since: 2.26)
220
221
 *@ATK_ROLE_CONTENT_DELETION: Content previously deleted or proposed to be
 * deleted, e.g. in revision history or a content view providing suggestions
222
 * from reviewers. (Since: 2.34)
223
224
 *@ATK_ROLE_CONTENT_INSERTION: Content previously inserted or proposed to be
 * inserted, e.g. in revision history or a content view providing suggestions
225
 * from reviewers. (Since: 2.34)
226
227
228
229
230
231
232
233
234
235
236
237
 *@ATK_ROLE_MARK: A run of content that is marked or highlighted, such as for
 * reference purposes, or to call it out as having a special purpose. If the
 * marked content has an associated section in the document elaborating on the
 * reason for the mark, then %ATK_RELATION_DETAILS should be used on the mark
 * to point to that associated section. In addition, the reciprocal relation
 * %ATK_RELATION_DETAILS_FOR should be used on the associated content section
 * to point back to the mark. (Since: 2.36)
 *@ATK_ROLE_SUGGESTION: A container for content that is called out as a proposed
 * change from the current version of the document, such as by a reviewer of the
 * content. This role should include either %ATK_ROLE_CONTENT_DELETION and/or
 * %ATK_ROLE_CONTENT_INSERTION children, in any order, to indicate what the
 * actual change is. (Since: 2.36)
238
 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
239
 *
240
241
 * Describes the role of an object
 *
242
243
244
245
 * These are the built-in enumerated roles that UI components can have
 * in ATK.  Other roles may be added at runtime, so an AtkRole >=
 * %ATK_ROLE_LAST_DEFINED is not necessarily an error.
 */
Bill Haneman's avatar
Bill Haneman committed
246
247
typedef enum
{
248
249
  ATK_ROLE_INVALID = 0,
  ATK_ROLE_ACCEL_LABEL,      /*<nick=accelerator-label>*/
Bill Haneman's avatar
Bill Haneman committed
250
  ATK_ROLE_ALERT,
251
252
253
  ATK_ROLE_ANIMATION,
  ATK_ROLE_ARROW,
  ATK_ROLE_CALENDAR,
Bill Haneman's avatar
Bill Haneman committed
254
255
  ATK_ROLE_CANVAS,
  ATK_ROLE_CHECK_BOX,
256
  ATK_ROLE_CHECK_MENU_ITEM,
Bill Haneman's avatar
Bill Haneman committed
257
258
259
  ATK_ROLE_COLOR_CHOOSER,
  ATK_ROLE_COLUMN_HEADER,
  ATK_ROLE_COMBO_BOX,
260
  ATK_ROLE_DATE_EDITOR,
Bill Haneman's avatar
Bill Haneman committed
261
262
  ATK_ROLE_DESKTOP_ICON,
  ATK_ROLE_DESKTOP_FRAME,
263
  ATK_ROLE_DIAL,
Bill Haneman's avatar
Bill Haneman committed
264
265
  ATK_ROLE_DIALOG,
  ATK_ROLE_DIRECTORY_PANE,
266
  ATK_ROLE_DRAWING_AREA,
Bill Haneman's avatar
Bill Haneman committed
267
268
  ATK_ROLE_FILE_CHOOSER,
  ATK_ROLE_FILLER,
269
  ATK_ROLE_FONT_CHOOSER,
Bill Haneman's avatar
Bill Haneman committed
270
271
272
273
  ATK_ROLE_FRAME,
  ATK_ROLE_GLASS_PANE,
  ATK_ROLE_HTML_CONTAINER,
  ATK_ROLE_ICON,
274
  ATK_ROLE_IMAGE,
Bill Haneman's avatar
Bill Haneman committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
  ATK_ROLE_INTERNAL_FRAME,
  ATK_ROLE_LABEL,
  ATK_ROLE_LAYERED_PANE,
  ATK_ROLE_LIST,
  ATK_ROLE_LIST_ITEM,
  ATK_ROLE_MENU,
  ATK_ROLE_MENU_BAR,
  ATK_ROLE_MENU_ITEM,
  ATK_ROLE_OPTION_PANE,
  ATK_ROLE_PAGE_TAB,
  ATK_ROLE_PAGE_TAB_LIST,
  ATK_ROLE_PANEL,
  ATK_ROLE_PASSWORD_TEXT,
  ATK_ROLE_POPUP_MENU,
  ATK_ROLE_PROGRESS_BAR,
  ATK_ROLE_PUSH_BUTTON,
  ATK_ROLE_RADIO_BUTTON,
292
  ATK_ROLE_RADIO_MENU_ITEM,
Bill Haneman's avatar
Bill Haneman committed
293
294
295
296
297
298
299
  ATK_ROLE_ROOT_PANE,
  ATK_ROLE_ROW_HEADER,
  ATK_ROLE_SCROLL_BAR,
  ATK_ROLE_SCROLL_PANE,
  ATK_ROLE_SEPARATOR,
  ATK_ROLE_SLIDER,
  ATK_ROLE_SPLIT_PANE,
300
  ATK_ROLE_SPIN_BUTTON,
301
  ATK_ROLE_STATUSBAR,
Bill Haneman's avatar
Bill Haneman committed
302
303
304
305
  ATK_ROLE_TABLE,
  ATK_ROLE_TABLE_CELL,
  ATK_ROLE_TABLE_COLUMN_HEADER,
  ATK_ROLE_TABLE_ROW_HEADER,
306
  ATK_ROLE_TEAR_OFF_MENU_ITEM,
307
  ATK_ROLE_TERMINAL,
Bill Haneman's avatar
Bill Haneman committed
308
309
310
311
312
  ATK_ROLE_TEXT,
  ATK_ROLE_TOGGLE_BUTTON,
  ATK_ROLE_TOOL_BAR,
  ATK_ROLE_TOOL_TIP,
  ATK_ROLE_TREE,
313
  ATK_ROLE_TREE_TABLE,
Bill Haneman's avatar
Bill Haneman committed
314
315
316
  ATK_ROLE_UNKNOWN,
  ATK_ROLE_VIEWPORT,
  ATK_ROLE_WINDOW,
317
318
319
320
  ATK_ROLE_HEADER,
  ATK_ROLE_FOOTER,
  ATK_ROLE_PARAGRAPH,
  ATK_ROLE_RULER,
321
  ATK_ROLE_APPLICATION,
322
  ATK_ROLE_AUTOCOMPLETE,
323
  ATK_ROLE_EDITBAR,          /*<nick=edit-bar>*/
324
  ATK_ROLE_EMBEDDED,
325
326
327
328
329
330
331
332
  ATK_ROLE_ENTRY,
  ATK_ROLE_CHART,
  ATK_ROLE_CAPTION,
  ATK_ROLE_DOCUMENT_FRAME,
  ATK_ROLE_HEADING,
  ATK_ROLE_PAGE,
  ATK_ROLE_SECTION,
  ATK_ROLE_REDUNDANT_OBJECT,
333
  ATK_ROLE_FORM,
334
335
  ATK_ROLE_LINK,
  ATK_ROLE_INPUT_METHOD_WINDOW,
336
337
338
339
340
341
342
343
344
345
346
347
348
  ATK_ROLE_TABLE_ROW,
  ATK_ROLE_TREE_ITEM,
  ATK_ROLE_DOCUMENT_SPREADSHEET,
  ATK_ROLE_DOCUMENT_PRESENTATION,
  ATK_ROLE_DOCUMENT_TEXT,
  ATK_ROLE_DOCUMENT_WEB,
  ATK_ROLE_DOCUMENT_EMAIL,
  ATK_ROLE_COMMENT,
  ATK_ROLE_LIST_BOX,
  ATK_ROLE_GROUPING,
  ATK_ROLE_IMAGE_MAP,
  ATK_ROLE_NOTIFICATION,
  ATK_ROLE_INFO_BAR,
Mike Gorse's avatar
Mike Gorse committed
349
  ATK_ROLE_LEVEL_BAR,
350
  ATK_ROLE_TITLE_BAR,
351
  ATK_ROLE_BLOCK_QUOTE,
352
353
  ATK_ROLE_AUDIO,
  ATK_ROLE_VIDEO,
354
355
356
357
358
359
360
361
  ATK_ROLE_DEFINITION,
  ATK_ROLE_ARTICLE,
  ATK_ROLE_LANDMARK,
  ATK_ROLE_LOG,
  ATK_ROLE_MARQUEE,
  ATK_ROLE_MATH,
  ATK_ROLE_RATING,
  ATK_ROLE_TIMER,
362
363
364
  ATK_ROLE_DESCRIPTION_LIST,
  ATK_ROLE_DESCRIPTION_TERM,
  ATK_ROLE_DESCRIPTION_VALUE,
365
  ATK_ROLE_STATIC,
366
367
368
369
  ATK_ROLE_MATH_FRACTION,
  ATK_ROLE_MATH_ROOT,
  ATK_ROLE_SUBSCRIPT,
  ATK_ROLE_SUPERSCRIPT,
Joanmarie Diggs's avatar
Joanmarie Diggs committed
370
  ATK_ROLE_FOOTNOTE,
371
372
  ATK_ROLE_CONTENT_DELETION,
  ATK_ROLE_CONTENT_INSERTION,
373
374
  ATK_ROLE_MARK,
  ATK_ROLE_SUGGESTION,
Bill Haneman's avatar
Bill Haneman committed
375
376
377
  ATK_ROLE_LAST_DEFINED
} AtkRole;

378
379
380
381
382
383
384
385
386
/**
 *AtkLayer:
 *@ATK_LAYER_INVALID: The object does not have a layer
 *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
 *@ATK_LAYER_CANVAS: This layer is used for Canvas components
 *@ATK_LAYER_WIDGET: This layer is normally used for components
 *@ATK_LAYER_MDI: This layer is used for layered components
 *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
 *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
Mark McLoughlin's avatar
Mark McLoughlin committed
387
 *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
388
389
 *
 * Describes the layer of a component
390
391
392
393
 *
 * These enumerated "layer values" are used when determining which UI
 * rendering layer a component is drawn into, which can help in making
 * determinations of when components occlude one another.
394
395
396
397
398
399
400
401
402
 **/
typedef enum
{
  ATK_LAYER_INVALID,
  ATK_LAYER_BACKGROUND,
  ATK_LAYER_CANVAS,
  ATK_LAYER_WIDGET,
  ATK_LAYER_MDI,
  ATK_LAYER_POPUP,
Mark McLoughlin's avatar
Mark McLoughlin committed
403
404
  ATK_LAYER_OVERLAY,
  ATK_LAYER_WINDOW
405
} AtkLayer;
Bill Haneman's avatar
Bill Haneman committed
406

407
408
409
410
/**
 * AtkAttributeSet:
 *
 * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
411
412
413
414
 * used by atk_text_get_run_attributes(),
 * atk_text_get_default_attributes(),
 * atk_editable_text_set_run_attributes(),
 * atk_document_get_attributes() and atk_object_get_attributes()
415
416
417
418
419
 **/
typedef GSList AtkAttributeSet;

/**
 * AtkAttribute:
420
421
 * @name: The attribute name.
 * @value: the value of the attribute, represented as a string.
422
 *
423
424
425
426
427
428
429
430
431
432
433
 * AtkAttribute is a string name/value pair representing a generic
 * attribute. This can be used to expose additional information from
 * an accessible object as a whole (see atk_object_get_attributes())
 * or an document (see atk_document_get_attributes()). In the case of
 * text attributes (see atk_text_get_default_attributes()),
 * #AtkTextAttribute enum defines all the possible text attribute
 * names. You can use atk_text_attribute_get_name() to get the string
 * name from the enum value. See also atk_text_attribute_for_name()
 * and atk_text_attribute_get_value() for more information.
 *
 * A string name/value pair representing a generic attribute.
434
435
436
437
438
439
440
441
 **/
typedef struct _AtkAttribute AtkAttribute;

struct _AtkAttribute {
  gchar* name;
  gchar* value;
};

Bill Haneman's avatar
Bill Haneman committed
442
443
444
445
446
447
448
#define ATK_TYPE_OBJECT                           (atk_object_get_type ())
#define ATK_OBJECT(obj)                           (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
#define ATK_OBJECT_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
#define ATK_IS_OBJECT(obj)                        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
#define ATK_IS_OBJECT_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
#define ATK_OBJECT_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))

449
450
451
452
#define ATK_TYPE_IMPLEMENTOR                      (atk_implementor_get_type ())
#define ATK_IS_IMPLEMENTOR(obj)                   G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
#define ATK_IMPLEMENTOR(obj)                      G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
#define ATK_IMPLEMENTOR_GET_IFACE(obj)            (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
Bill Haneman's avatar
Bill Haneman committed
453
454


455
456
typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
typedef struct _AtkImplementorIface       AtkImplementorIface;
Bill Haneman's avatar
Bill Haneman committed
457
458


459
460
461
typedef struct _AtkObject                 AtkObject;
typedef struct _AtkObjectClass            AtkObjectClass;
typedef struct _AtkRelationSet            AtkRelationSet;
462
typedef struct _AtkStateSet               AtkStateSet;
Bill Haneman's avatar
Bill Haneman committed
463

464
465
/**
 * AtkPropertyValues:
466
467
 * @property_name: The name of the ATK property which has changed.
 * @old_value: NULL. This field is not used anymore.
468
469
 * @new_value: The new value of the named property.
 *
470
471
472
 * Note: @old_value field of #AtkPropertyValues will not contain a
 * valid value. This is a field defined with the purpose of contain
 * the previous value of the property, but is not used anymore.
473
474
 *
 **/
Bill Haneman's avatar
Bill Haneman committed
475
476
struct _AtkPropertyValues
{
477
  const gchar  *property_name;
Bill Haneman's avatar
Bill Haneman committed
478
479
480
481
  GValue old_value;
  GValue new_value;
};

482
typedef struct _AtkPropertyValues        AtkPropertyValues;
Bill Haneman's avatar
Bill Haneman committed
483

484
485
486
487
488
489
490
491
492
493
/**
 * AtkFunction:
 * @user_data: custom data defined by the user
 *
 * An AtkFunction is a function definition used for padding which has
 * been added to class and interface structures to allow for expansion
 * in the future.
 *
 * Returns: not used
 */
494
typedef gboolean (*AtkFunction)          (gpointer user_data);
Bill Haneman's avatar
Bill Haneman committed
495
496
497
498
499
500
501
502
503
504
505
506
/*
 * For most properties the old_value field of AtkPropertyValues will
 * not contain a valid value.
 *
 * Currently, the only property for which old_value is used is
 * accessible-state; for instance if there is a focus state the
 * property change handler will be called for the object which lost the focus
 * with the old_value containing an AtkState value corresponding to focused
 * and the property change handler will be called for the object which
 * received the focus with the new_value containing an AtkState value
 * corresponding to focused.
 */
507
508
509
510
511
512
513
514
515

/**
 * AtkPropertyChangeHandler:
 * @obj: atkobject which property changes
 * @vals: values changed
 *
 * An AtkPropertyChangeHandler is a function which is executed when an
 * AtkObject's property changes value. It is specified in a call to
 * atk_object_connect_property_change_handler().
516
517
 *
 * Deprecated: Since 2.12.
518
 */
519
typedef void (*AtkPropertyChangeHandler) (AtkObject* obj, AtkPropertyValues* vals);
Bill Haneman's avatar
Bill Haneman committed
520
521
522
523
524
525
526
527
528
529
530


struct _AtkObject
{
  GObject parent;

  gchar *description;
  gchar *name;
  AtkObject *accessible_parent;
  AtkRole role;
  AtkRelationSet *relation_set;
531
  AtkLayer layer;
Bill Haneman's avatar
Bill Haneman committed
532
533
};

534
535
536

/**
 * AtkObjectClass:
537
538
539
540
541
542
543
 * @connect_property_change_handler: specifies a function to be called
 *   when a property changes value. This virtual function is
 *   deprecated since 2.12 and it should not be overriden. Connect
 *   directly to property-change or notify signal instead.
 * @remove_property_change_handler: removes a property changed handler
 *   as returned by @connect_property_change_handler. This virtual
 *   function is deprecated sice 2.12 and it should not be overriden.
544
545
546
 * @focus_event: The signal handler which is executed when there is a
 *   focus event for an object. This virtual function is deprecated
 *   since 2.9.4 and it should not be overriden. Use
547
 *   the #AtkObject::state-change "focused" signal instead.
548
 */
Bill Haneman's avatar
Bill Haneman committed
549
550
551
552
553
554
555
struct _AtkObjectClass
{
  GObjectClass parent;

  /*
   * Gets the accessible name of the object
   */
556
  const gchar*             (* get_name)            (AtkObject                *accessible);
Bill Haneman's avatar
Bill Haneman committed
557
558
559
  /*
   * Gets the accessible description of the object
   */
560
  const gchar*             (* get_description)     (AtkObject                *accessible);
Bill Haneman's avatar
Bill Haneman committed
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
  /*
   * Gets the accessible parent of the object
   */
  AtkObject*               (*get_parent)           (AtkObject                *accessible);

  /*
   * Gets the number of accessible children of the object
   */
  gint                    (* get_n_children)       (AtkObject                *accessible);
  /*
   * Returns a reference to the specified accessible child of the object.
   * The accessible children are 0-based so the first accessible child is
   * at index 0, the second at index 1 and so on.
   */
  AtkObject*              (* ref_child)            (AtkObject                *accessible,
                                                    gint                      i);
  /*
   * Gets the 0-based index of this object in its parent; returns -1 if the
   * object does not have an accessible parent.
   */
  gint                    (* get_index_in_parent) (AtkObject                 *accessible);
  /*
   * Gets the RelationSet associated with the object
   */
585
  AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
Bill Haneman's avatar
Bill Haneman committed
586
587
588
589
  /*
   * Gets the role of the object
   */
  AtkRole                 (* get_role)            (AtkObject                 *accessible);
590
591
  AtkLayer                (* get_layer)           (AtkObject                 *accessible);
  gint                    (* get_mdi_zorder)      (AtkObject                 *accessible);
Bill Haneman's avatar
Bill Haneman committed
592
593
594
  /*
   * Gets the state set of the object
   */
595
  AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
Bill Haneman's avatar
Bill Haneman committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
  /*
   * Sets the accessible name of the object
   */
  void                    (* set_name)            (AtkObject                 *accessible,
                                                   const gchar               *name);
  /*
   * Sets the accessible description of the object
   */
  void                    (* set_description)     (AtkObject                 *accessible,
                                                   const gchar               *description);
  /*
   * Sets the accessible parent of the object
   */
  void                    (* set_parent)          (AtkObject                 *accessible,
                                                   AtkObject                 *parent);
  /*
   * Sets the accessible role of the object
   */
  void                    (* set_role)            (AtkObject                 *accessible,
                                                   AtkRole                   role);
  /*
   * Specifies a function to be called when a property changes value
   */
guint                     (* connect_property_change_handler)    (AtkObject
                 *accessible,
                                                                  AtkPropertyChangeHandler       *handler);
  /*
   * Removes a property change handler which was specified using
   * connect_property_change_handler
   */
void                      (* remove_property_change_handler)     (AtkObject
                *accessible,
                                                                  guint
                handler_id);
630
631
void                      (* initialize)                         (AtkObject                     *accessible,
                                                                  gpointer                      data);
Bill Haneman's avatar
Bill Haneman committed
632
633
634
635
636
  /*
   * The signal handler which is executed when there is a change in the
   * children of the object
   */
  void                    (* children_changed)    (AtkObject                  *accessible,
637
638
                                                   guint                      change_index,
                                                   gpointer                   changed_child);
639
640
641
642
  /*
   * The signal handler which is executed  when there is a focus event
   * for an object.
   */
643
  void                    (* focus_event)         (AtkObject                  *accessible,
644
                                                   gboolean                   focus_in);
645
646
647
648
  /*
   * The signal handler which is executed  when there is a property_change 
   * signal for an object.
   */
649
  void                    (* property_change)     (AtkObject                  *accessible,
650
                                                   AtkPropertyValues          *values);
651
652
653
654
  /*
   * The signal handler which is executed  when there is a state_change 
   * signal for an object.
   */
655
  void                    (* state_change)        (AtkObject                  *accessible,
656
                                                   const gchar                *name,
657
                                                   gboolean                   state_set);
658
659
660
661
662
  /*
   * The signal handler which is executed when there is a change in the
   * visible data for an object
   */
  void                    (*visible_data_changed) (AtkObject                  *accessible);
663

664
665
666
667
668
669
670
671
672
  /*
   * The signal handler which is executed when there is a change in the
   * 'active' child or children of the object, for instance when 
   * interior focus changes in a table or list.  This signal should be emitted
   * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
   */
  void                    (*active_descendant_changed) (AtkObject                  *accessible,
                                                        gpointer                   *child);

673
674
  /*    	
   * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs. 
675
   * Since ATK 1.12
676
677
   */
  AtkAttributeSet* 	  (*get_attributes)            (AtkObject                  *accessible);
678
679
680

  const gchar*            (*get_object_locale)         (AtkObject                  *accessible);

681
  AtkFunction             pad1;
Bill Haneman's avatar
Bill Haneman committed
682
};
683

684
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
685
686
GType            atk_object_get_type   (void);

687
688
689
690
691
692
693
/**
 * AtkImplementorIface:
 *
 * The AtkImplementor interface is implemented by objects for which
 * AtkObject peers may be obtained via calls to
 * iface->(ref_accessible)(implementor);
 */
694
struct _AtkImplementorIface
Bill Haneman's avatar
Bill Haneman committed
695
696
697
{
  GTypeInterface parent;

698
  AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
Bill Haneman's avatar
Bill Haneman committed
699
700
};

701
ATK_AVAILABLE_IN_ALL
702
GType atk_implementor_get_type (void);
703
ATK_AVAILABLE_IN_ALL
704
AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
Bill Haneman's avatar
Bill Haneman committed
705
706
707
708
709

/*
 * Properties directly supported by AtkObject
 */

710
ATK_AVAILABLE_IN_ALL
711
const gchar*            atk_object_get_name                       (AtkObject *accessible);
712
ATK_AVAILABLE_IN_ALL
713
const gchar*            atk_object_get_description                (AtkObject *accessible);
714
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
715
AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
716
ATK_AVAILABLE_IN_ALL
717
AtkObject*              atk_object_peek_parent                    (AtkObject *accessible);
718
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
719
gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
720
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
721
722
AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
                                                                   gint        i);
723
ATK_AVAILABLE_IN_ALL
724
AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
725
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
726
AtkRole                 atk_object_get_role                       (AtkObject *accessible);
727

728
ATK_DEPRECATED_FOR(atk_component_get_layer)
729
AtkLayer                atk_object_get_layer                      (AtkObject *accessible);
730
ATK_DEPRECATED_FOR(atk_component_get_mdi_zorder)
731
gint                    atk_object_get_mdi_zorder                 (AtkObject *accessible);
732

733
ATK_AVAILABLE_IN_ALL
734
AtkAttributeSet*        atk_object_get_attributes                 (AtkObject *accessible);
735
ATK_AVAILABLE_IN_ALL
736
AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
737
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
738
gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
739
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
740
741
void                    atk_object_set_name                       (AtkObject *accessible,
                                                                   const gchar *name);
742
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
743
744
void                    atk_object_set_description                (AtkObject *accessible,
                                                                   const gchar *description);
745
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
746
747
void                    atk_object_set_parent                     (AtkObject *accessible,
                                                                   AtkObject *parent);
748
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
749
750
751
752
void                    atk_object_set_role                       (AtkObject *accessible,
                                                                   AtkRole   role);


753
ATK_DEPRECATED_IN_2_12
Bill Haneman's avatar
Bill Haneman committed
754
755
guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
                                                                  AtkPropertyChangeHandler       *handler);
756
ATK_DEPRECATED_IN_2_12
757
758
void                 atk_object_remove_property_change_handler   (AtkObject                      *accessible,
                                                                  guint                          handler_id);
Bill Haneman's avatar
Bill Haneman committed
759

760
ATK_AVAILABLE_IN_ALL
761
762
763
void                 atk_object_notify_state_change              (AtkObject                      *accessible,
                                                                  AtkState                       state,
                                                                  gboolean                       value);
764
ATK_AVAILABLE_IN_ALL
765
766
void                 atk_object_initialize                       (AtkObject                     *accessible,
                                                                  gpointer                      data);
767
768

ATK_AVAILABLE_IN_ALL
769
const gchar*          atk_role_get_name      (AtkRole         role);
770
ATK_AVAILABLE_IN_ALL
771
772
773
AtkRole               atk_role_for_name      (const gchar     *name);


774
/* NEW in 1.1: convenience API */
775
ATK_AVAILABLE_IN_ALL
776
777
778
gboolean              atk_object_add_relationship              (AtkObject      *object,
								AtkRelationType relationship,
								AtkObject      *target);
779
ATK_AVAILABLE_IN_ALL
780
781
782
gboolean              atk_object_remove_relationship           (AtkObject      *object,
								AtkRelationType relationship,
								AtkObject      *target);
783
ATK_AVAILABLE_IN_ALL
784
const gchar*          atk_role_get_localized_name              (AtkRole     role);
785
ATK_DEPRECATED_IN_2_12
786
AtkRole               atk_role_register                        (const gchar *name);
787
ATK_AVAILABLE_IN_2_8
788
const gchar*          atk_object_get_object_locale             (AtkObject   *accessible);
789

Samuel Thibault's avatar
Samuel Thibault committed
790
791
792
793
794
795
796
ATK_AVAILABLE_IN_ALL
const gchar*          atk_object_get_accessible_id             (AtkObject   *accessible);

ATK_AVAILABLE_IN_ALL
void                  atk_object_set_accessible_id             (AtkObject   *accessible,
                                                                const gchar *name);

797
G_END_DECLS
Bill Haneman's avatar
Bill Haneman committed
798
799

#endif /* __ATK_OBJECT_H__ */