1/* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20#ifndef __ATK_OBJECT_H__
21#define __ATK_OBJECT_H__
22
23#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
24#error "Only <atk/atk.h> can be included directly."
25#endif
26
27#include <glib-object.h>
28
29#include <atk/atkversion.h>
30#include <atk/atkstate.h>
31#include <atk/atkrelationtype.h>
32
33G_BEGIN_DECLS
34
35/**
36 *AtkRole:
37 *@ATK_ROLE_INVALID: Invalid role
38 *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
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 *@ATK_ROLE_ANIMATION: An object which is an animated image
41 *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
42 *@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
43 *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
44 *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
45 *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
46 *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
47 *@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 *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
50 *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
51 *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
52 *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
53 *@ATK_ROLE_DIALOG: A top level window with title bar and a border
54 *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
55 *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
56 *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
57 *@ATK_ROLE_FILLER: A object that fills up space in a user interface
58 *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
59 *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
60 *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
61 *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
62 *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
63 *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
64 *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
65 *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
66 *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
67 *@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
68 *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
69 *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
70 *@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
71 *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
72 *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
73 *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
74 *@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
75 *@ATK_ROLE_PANEL: A generic container that is often used to group objects
76 *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
77 *@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
78 *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
79 *@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 *@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
82 *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
83 *@ATK_ROLE_ROW_HEADER: The header for a row of data
84 *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
85 *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
86 *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
87 *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
88 *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
89 *@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 *@ATK_ROLE_TABLE_CELL: A cell in a table
93 *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
94 *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
95 *@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: ATK-0.6
97 *@ATK_ROLE_TEXT: An interactive widget that supports multiple lines of text and
98 * optionally accepts user input, but whose purpose is not to solicit user input.
99 * Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor
100 * but inappropriate for an input field in a dialog box or web form. For widgets
101 * whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and
102 * ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of
103 * 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 *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
106 *@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: ATK-0.7
109 *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
110 *@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 *@ATK_ROLE_HEADER: An object that serves as a document header. @Since: ATK-1.1.1
113 *@ATK_ROLE_FOOTER: An object that serves as a document footer. @Since: ATK-1.1.1
114 *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content. @Since: ATK-1.1.1
115 *@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: ATK-1.1.1
116 *@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: ATK-1.1.4
117 *@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: ATK-1.3
118 *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar. @Since: ATK-1.5
119 *@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: ATK-1.7.2
120 *@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: ATK-1.11
121 *@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: ATK-1.11
122 *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. @Since: ATK-1.11
123 *@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: ATK-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 *@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: ATK-1.11
126 *@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: ATK-1.11
127 *@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: ATK-1.11
128 *@ATK_ROLE_FORM: The object is a container for form controls, for instance as part of a
129 * web form or user-input form within a document. This role is primarily a tag/convenience for
130 * clients when navigating complex documents, it is not expected that ordinary GUI containers will
131 * always have ATK_ROLE_FORM. @Since: ATK-1.12.0
132 *@ATK_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
133 * hypertext document. Such objects are distinct from 'inline'
134 * content which may also use the Hypertext/Hyperlink interfaces
135 * to indicate the range/location within a text object where
136 * an inline or embedded object lies. @Since: ATK-1.12.1
137 *@ATK_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
138 * which is used to allow composition or input of a 'complex character',
139 * in other words it is an "input method window." @Since: ATK-1.12.1
140 *@ATK_ROLE_TABLE_ROW: A row in a table. @Since: ATK-2.1.0
141 *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree. @Since: ATK-2.1.0
142 *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet. @Since: ATK-2.1.0
143 *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content. @Since: ATK-2.1.0
144 *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application. @Since: ATK-2.1.0
145 *@ATK_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other markup suitable for display in a web browser. @Since: ATK-2.1.0
146 *@ATK_ROLE_DOCUMENT_EMAIL: A document frame which contains email content to be displayed or composed either in plain text or HTML. @Since: ATK-2.1.0
147 *@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: ATK-2.1.0
148 *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. @Since: ATK-2.1.0
149 *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. @Since: ATK-2.1.0
150 *@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: ATK-2.1.0
151 *@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: ATK-2.1.0
152 *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. @Since: ATK-2.1.0
153 *@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: ATK-2.7.3
154 *@ATK_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
155 * dialog. @Since: ATK-2.12
156 *@ATK_ROLE_BLOCK_QUOTE: An object which contains a text section
157 * that is quoted from another source. @Since: ATK-2.12
158 *@ATK_ROLE_AUDIO: An object which represents an audio element. @Since: ATK-2.12
159 *@ATK_ROLE_VIDEO: An object which represents a video element. @Since: ATK-2.12
160 *@ATK_ROLE_DEFINITION: A definition of a term or concept. @Since: ATK-2.12
161 *@ATK_ROLE_ARTICLE: A section of a page that consists of a
162 * composition that forms an independent part of a document, page, or
163 * site. Examples: A blog entry, a news story, a forum post. @Since:
164 * ATK-2.12
165 *@ATK_ROLE_LANDMARK: A region of a web page intended as a
166 * navigational landmark. This is designed to allow Assistive
167 * Technologies to provide quick navigation among key regions within a
168 * document. @Since: ATK-2.12
169 *@ATK_ROLE_LOG: A text widget or container holding log content, such
170 * as chat history and error logs. In this role there is a
171 * relationship between the arrival of new items in the log and the
172 * reading order. The log contains a meaningful sequence and new
173 * information is added only to the end of the log, not at arbitrary
174 * points. @Since: ATK-2.12
175 *@ATK_ROLE_MARQUEE: A container where non-essential information
176 * changes frequently. Common usages of marquee include stock tickers
177 * and ad banners. The primary difference between a marquee and a log
178 * is that logs usually have a meaningful order or sequence of
179 * important content changes. @Since: ATK-2.12
180 *@ATK_ROLE_MATH: A text widget or container that holds a mathematical
181 * expression. @Since: ATK-2.12
182 *@ATK_ROLE_RATING: A widget whose purpose is to display a rating,
183 * such as the number of stars associated with a song in a media
184 * player. Objects of this role should also implement
185 * AtkValue. @Since: ATK-2.12
186 *@ATK_ROLE_TIMER: An object containing a numerical counter which
187 * indicates an amount of elapsed time from a start point, or the time
188 * remaining until an end point. @Since: ATK-2.12
189 *@ATK_ROLE_DESCRIPTION_LIST: An object that represents a list of
190 * term-value groups. A term-value group represents a individual
191 * description and consist of one or more names
192 * (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
193 * (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be
194 * more than one group with the same term name. @Since: ATK-2.12
195 *@ATK_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase
196 * with a corresponding definition. @Since: ATK-2.12
197 *@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the
198 * description, definition or value of a term. @Since: ATK-2.12
199 *@ATK_ROLE_STATIC: A generic non-container object whose purpose is to display a
200 * brief amount of information to the user and whose role is known by the
201 * implementor but lacks semantic value for the user. Examples in which
202 * ATK_ROLE_STATIC is appropriate include the message displayed in a message box
203 * and an image used as an alternative means to display text. ATK_ROLE_STATIC
204 * should not be applied to widgets which are traditionally interactive, objects
205 * which display a significant amount of content, or any object which has an
206 * accessible relation pointing to another object. Implementors should expose the
207 * displayed information through the accessible name of the object. If doing so seems
208 * inappropriate, it may indicate that a different role should be used. For
209 * labels which describe another widget, see ATK_ROLE_LABEL. For text views, see
210 * ATK_ROLE_TEXT. For generic containers, see ATK_ROLE_PANEL. For objects whose
211 * role is not known by the implementor, see ATK_ROLE_UNKNOWN. @Since: ATK-2.16.
212 *@ATK_ROLE_MATH_FRACTION: An object that represents a mathematical fraction.
213 * @Since: ATK-2.16.
214 *@ATK_ROLE_MATH_ROOT: An object that represents a mathematical expression
215 * displayed with a radical. @Since: ATK-2.16.
216 *@ATK_ROLE_SUBSCRIPT: An object that contains text that is displayed as a
217 * subscript. @Since: ATK-2.16.
218 *@ATK_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a
219 * superscript. @Since: ATK-2.16.
220 *@ATK_ROLE_FOOTNOTE: An object that contains the text of a footnote. @Since: ATK-2.26.
221 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
222 *
223 * Describes the role of an object
224 *
225 * These are the built-in enumerated roles that UI components can have in
226 * ATK. Other roles may be added at runtime, so an AtkRole >=
227 * ATK_ROLE_LAST_DEFINED is not necessarily an error.
228 **/
229typedef enum
230{
231 ATK_ROLE_INVALID = 0,
232 ATK_ROLE_ACCEL_LABEL, /*<nick=accelerator-label>*/
233 ATK_ROLE_ALERT,
234 ATK_ROLE_ANIMATION,
235 ATK_ROLE_ARROW,
236 ATK_ROLE_CALENDAR,
237 ATK_ROLE_CANVAS,
238 ATK_ROLE_CHECK_BOX,
239 ATK_ROLE_CHECK_MENU_ITEM,
240 ATK_ROLE_COLOR_CHOOSER,
241 ATK_ROLE_COLUMN_HEADER,
242 ATK_ROLE_COMBO_BOX,
243 ATK_ROLE_DATE_EDITOR,
244 ATK_ROLE_DESKTOP_ICON,
245 ATK_ROLE_DESKTOP_FRAME,
246 ATK_ROLE_DIAL,
247 ATK_ROLE_DIALOG,
248 ATK_ROLE_DIRECTORY_PANE,
249 ATK_ROLE_DRAWING_AREA,
250 ATK_ROLE_FILE_CHOOSER,
251 ATK_ROLE_FILLER,
252 ATK_ROLE_FONT_CHOOSER,
253 ATK_ROLE_FRAME,
254 ATK_ROLE_GLASS_PANE,
255 ATK_ROLE_HTML_CONTAINER,
256 ATK_ROLE_ICON,
257 ATK_ROLE_IMAGE,
258 ATK_ROLE_INTERNAL_FRAME,
259 ATK_ROLE_LABEL,
260 ATK_ROLE_LAYERED_PANE,
261 ATK_ROLE_LIST,
262 ATK_ROLE_LIST_ITEM,
263 ATK_ROLE_MENU,
264 ATK_ROLE_MENU_BAR,
265 ATK_ROLE_MENU_ITEM,
266 ATK_ROLE_OPTION_PANE,
267 ATK_ROLE_PAGE_TAB,
268 ATK_ROLE_PAGE_TAB_LIST,
269 ATK_ROLE_PANEL,
270 ATK_ROLE_PASSWORD_TEXT,
271 ATK_ROLE_POPUP_MENU,
272 ATK_ROLE_PROGRESS_BAR,
273 ATK_ROLE_PUSH_BUTTON,
274 ATK_ROLE_RADIO_BUTTON,
275 ATK_ROLE_RADIO_MENU_ITEM,
276 ATK_ROLE_ROOT_PANE,
277 ATK_ROLE_ROW_HEADER,
278 ATK_ROLE_SCROLL_BAR,
279 ATK_ROLE_SCROLL_PANE,
280 ATK_ROLE_SEPARATOR,
281 ATK_ROLE_SLIDER,
282 ATK_ROLE_SPLIT_PANE,
283 ATK_ROLE_SPIN_BUTTON,
284 ATK_ROLE_STATUSBAR,
285 ATK_ROLE_TABLE,
286 ATK_ROLE_TABLE_CELL,
287 ATK_ROLE_TABLE_COLUMN_HEADER,
288 ATK_ROLE_TABLE_ROW_HEADER,
289 ATK_ROLE_TEAR_OFF_MENU_ITEM,
290 ATK_ROLE_TERMINAL,
291 ATK_ROLE_TEXT,
292 ATK_ROLE_TOGGLE_BUTTON,
293 ATK_ROLE_TOOL_BAR,
294 ATK_ROLE_TOOL_TIP,
295 ATK_ROLE_TREE,
296 ATK_ROLE_TREE_TABLE,
297 ATK_ROLE_UNKNOWN,
298 ATK_ROLE_VIEWPORT,
299 ATK_ROLE_WINDOW,
300 ATK_ROLE_HEADER,
301 ATK_ROLE_FOOTER,
302 ATK_ROLE_PARAGRAPH,
303 ATK_ROLE_RULER,
304 ATK_ROLE_APPLICATION,
305 ATK_ROLE_AUTOCOMPLETE,
306 ATK_ROLE_EDITBAR, /*<nick=edit-bar>*/
307 ATK_ROLE_EMBEDDED,
308 ATK_ROLE_ENTRY,
309 ATK_ROLE_CHART,
310 ATK_ROLE_CAPTION,
311 ATK_ROLE_DOCUMENT_FRAME,
312 ATK_ROLE_HEADING,
313 ATK_ROLE_PAGE,
314 ATK_ROLE_SECTION,
315 ATK_ROLE_REDUNDANT_OBJECT,
316 ATK_ROLE_FORM,
317 ATK_ROLE_LINK,
318 ATK_ROLE_INPUT_METHOD_WINDOW,
319 ATK_ROLE_TABLE_ROW,
320 ATK_ROLE_TREE_ITEM,
321 ATK_ROLE_DOCUMENT_SPREADSHEET,
322 ATK_ROLE_DOCUMENT_PRESENTATION,
323 ATK_ROLE_DOCUMENT_TEXT,
324 ATK_ROLE_DOCUMENT_WEB,
325 ATK_ROLE_DOCUMENT_EMAIL,
326 ATK_ROLE_COMMENT,
327 ATK_ROLE_LIST_BOX,
328 ATK_ROLE_GROUPING,
329 ATK_ROLE_IMAGE_MAP,
330 ATK_ROLE_NOTIFICATION,
331 ATK_ROLE_INFO_BAR,
332 ATK_ROLE_LEVEL_BAR,
333 ATK_ROLE_TITLE_BAR,
334 ATK_ROLE_BLOCK_QUOTE,
335 ATK_ROLE_AUDIO,
336 ATK_ROLE_VIDEO,
337 ATK_ROLE_DEFINITION,
338 ATK_ROLE_ARTICLE,
339 ATK_ROLE_LANDMARK,
340 ATK_ROLE_LOG,
341 ATK_ROLE_MARQUEE,
342 ATK_ROLE_MATH,
343 ATK_ROLE_RATING,
344 ATK_ROLE_TIMER,
345 ATK_ROLE_DESCRIPTION_LIST,
346 ATK_ROLE_DESCRIPTION_TERM,
347 ATK_ROLE_DESCRIPTION_VALUE,
348 ATK_ROLE_STATIC,
349 ATK_ROLE_MATH_FRACTION,
350 ATK_ROLE_MATH_ROOT,
351 ATK_ROLE_SUBSCRIPT,
352 ATK_ROLE_SUPERSCRIPT,
353 ATK_ROLE_FOOTNOTE,
354 ATK_ROLE_LAST_DEFINED
355} AtkRole;
356
357/**
358 *AtkLayer:
359 *@ATK_LAYER_INVALID: The object does not have a layer
360 *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
361 *@ATK_LAYER_CANVAS: This layer is used for Canvas components
362 *@ATK_LAYER_WIDGET: This layer is normally used for components
363 *@ATK_LAYER_MDI: This layer is used for layered components
364 *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
365 *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
366 *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
367 *
368 * Describes the layer of a component
369 *
370 * These enumerated "layer values" are used when determining which UI
371 * rendering layer a component is drawn into, which can help in making
372 * determinations of when components occlude one another.
373 **/
374typedef enum
375{
376 ATK_LAYER_INVALID,
377 ATK_LAYER_BACKGROUND,
378 ATK_LAYER_CANVAS,
379 ATK_LAYER_WIDGET,
380 ATK_LAYER_MDI,
381 ATK_LAYER_POPUP,
382 ATK_LAYER_OVERLAY,
383 ATK_LAYER_WINDOW
384} AtkLayer;
385
386/**
387 * AtkAttributeSet:
388 *
389 * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
390 * used by atk_text_get_run_attributes(),
391 * atk_text_get_default_attributes(),
392 * atk_editable_text_set_run_attributes(),
393 * atk_document_get_attributes() and atk_object_get_attributes()
394 **/
395typedef GSList AtkAttributeSet;
396
397/**
398 * AtkAttribute:
399 * @name: The attribute name.
400 * @value: the value of the attribute, represented as a string.
401 *
402 * AtkAttribute is a string name/value pair representing a generic
403 * attribute. This can be used to expose additional information from
404 * an accessible object as a whole (see atk_object_get_attributes())
405 * or an document (see atk_document_get_attributes()). In the case of
406 * text attributes (see atk_text_get_default_attributes()),
407 * #AtkTextAttribute enum defines all the possible text attribute
408 * names. You can use atk_text_attribute_get_name() to get the string
409 * name from the enum value. See also atk_text_attribute_for_name()
410 * and atk_text_attribute_get_value() for more information.
411 *
412 * A string name/value pair representing a generic attribute.
413 **/
414typedef struct _AtkAttribute AtkAttribute;
415
416struct _AtkAttribute {
417 gchar* name;
418 gchar* value;
419};
420
421#define ATK_TYPE_OBJECT (atk_object_get_type ())
422#define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
423#define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
424#define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
425#define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
426#define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
427
428#define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
429#define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
430#define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
431#define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
432
433
434typedef struct _AtkImplementor AtkImplementor; /* dummy typedef */
435typedef struct _AtkImplementorIface AtkImplementorIface;
436
437
438typedef struct _AtkObject AtkObject;
439typedef struct _AtkObjectClass AtkObjectClass;
440typedef struct _AtkRelationSet AtkRelationSet;
441typedef struct _AtkStateSet AtkStateSet;
442
443/**
444 * AtkPropertyValues:
445 * @property_name: The name of the ATK property which has changed.
446 * @old_value: NULL. This field is not used anymore.
447 * @new_value: The new value of the named property.
448 *
449 * Note: @old_value field of #AtkPropertyValues will not contain a
450 * valid value. This is a field defined with the purpose of contain
451 * the previous value of the property, but is not used anymore.
452 *
453 **/
454struct _AtkPropertyValues
455{
456 const gchar *property_name;
457 GValue old_value;
458 GValue new_value;
459};
460
461typedef struct _AtkPropertyValues AtkPropertyValues;
462
463/**
464 * AtkFunction:
465 * @user_data: custom data defined by the user
466 *
467 * An AtkFunction is a function definition used for padding which has
468 * been added to class and interface structures to allow for expansion
469 * in the future.
470 *
471 * Returns: not used
472 */
473typedef gboolean (*AtkFunction) (gpointer user_data);
474/*
475 * For most properties the old_value field of AtkPropertyValues will
476 * not contain a valid value.
477 *
478 * Currently, the only property for which old_value is used is
479 * accessible-state; for instance if there is a focus state the
480 * property change handler will be called for the object which lost the focus
481 * with the old_value containing an AtkState value corresponding to focused
482 * and the property change handler will be called for the object which
483 * received the focus with the new_value containing an AtkState value
484 * corresponding to focused.
485 */
486
487/**
488 * AtkPropertyChangeHandler:
489 * @obj: atkobject which property changes
490 * @vals: values changed
491 *
492 * An AtkPropertyChangeHandler is a function which is executed when an
493 * AtkObject's property changes value. It is specified in a call to
494 * atk_object_connect_property_change_handler().
495 *
496 * Deprecated: Since 2.12.
497 */
498typedef void (*AtkPropertyChangeHandler) (AtkObject* obj, AtkPropertyValues* vals);
499
500
501struct _AtkObject
502{
503 GObject parent;
504
505 gchar *description;
506 gchar *name;
507 AtkObject *accessible_parent;
508 AtkRole role;
509 AtkRelationSet *relation_set;
510 AtkLayer layer;
511};
512
513
514/**
515 * AtkObjectClass:
516 * @connect_property_change_handler: specifies a function to be called
517 * when a property changes value. This virtual function is
518 * deprecated since 2.12 and it should not be overriden. Connect
519 * directly to property-change or notify signal instead.
520 * @remove_property_change_handler: removes a property changed handler
521 * as returned by @connect_property_change_handler. This virtual
522 * function is deprecated sice 2.12 and it should not be overriden.
523 * @focus_event: The signal handler which is executed when there is a
524 * focus event for an object. This virtual function is deprecated
525 * since 2.9.4 and it should not be overriden. Use
526 * the #AtkObject::state-change "focused" signal instead.
527 */
528struct _AtkObjectClass
529{
530 GObjectClass parent;
531
532 /*
533 * Gets the accessible name of the object
534 */
535 const gchar* (* get_name) (AtkObject *accessible);
536 /*
537 * Gets the accessible description of the object
538 */
539 const gchar* (* get_description) (AtkObject *accessible);
540 /*
541 * Gets the accessible parent of the object
542 */
543 AtkObject* (*get_parent) (AtkObject *accessible);
544
545 /*
546 * Gets the number of accessible children of the object
547 */
548 gint (* get_n_children) (AtkObject *accessible);
549 /*
550 * Returns a reference to the specified accessible child of the object.
551 * The accessible children are 0-based so the first accessible child is
552 * at index 0, the second at index 1 and so on.
553 */
554 AtkObject* (* ref_child) (AtkObject *accessible,
555 gint i);
556 /*
557 * Gets the 0-based index of this object in its parent; returns -1 if the
558 * object does not have an accessible parent.
559 */
560 gint (* get_index_in_parent) (AtkObject *accessible);
561 /*
562 * Gets the RelationSet associated with the object
563 */
564 AtkRelationSet* (* ref_relation_set) (AtkObject *accessible);
565 /*
566 * Gets the role of the object
567 */
568 AtkRole (* get_role) (AtkObject *accessible);
569 AtkLayer (* get_layer) (AtkObject *accessible);
570 gint (* get_mdi_zorder) (AtkObject *accessible);
571 /*
572 * Gets the state set of the object
573 */
574 AtkStateSet* (* ref_state_set) (AtkObject *accessible);
575 /*
576 * Sets the accessible name of the object
577 */
578 void (* set_name) (AtkObject *accessible,
579 const gchar *name);
580 /*
581 * Sets the accessible description of the object
582 */
583 void (* set_description) (AtkObject *accessible,
584 const gchar *description);
585 /*
586 * Sets the accessible parent of the object
587 */
588 void (* set_parent) (AtkObject *accessible,
589 AtkObject *parent);
590 /*
591 * Sets the accessible role of the object
592 */
593 void (* set_role) (AtkObject *accessible,
594 AtkRole role);
595 /*
596 * Specifies a function to be called when a property changes value
597 */
598guint (* connect_property_change_handler) (AtkObject
599 *accessible,
600 AtkPropertyChangeHandler *handler);
601 /*
602 * Removes a property change handler which was specified using
603 * connect_property_change_handler
604 */
605void (* remove_property_change_handler) (AtkObject
606 *accessible,
607 guint
608 handler_id);
609void (* initialize) (AtkObject *accessible,
610 gpointer data);
611 /*
612 * The signal handler which is executed when there is a change in the
613 * children of the object
614 */
615 void (* children_changed) (AtkObject *accessible,
616 guint change_index,
617 gpointer changed_child);
618 /*
619 * The signal handler which is executed when there is a focus event
620 * for an object.
621 */
622 void (* focus_event) (AtkObject *accessible,
623 gboolean focus_in);
624 /*
625 * The signal handler which is executed when there is a property_change
626 * signal for an object.
627 */
628 void (* property_change) (AtkObject *accessible,
629 AtkPropertyValues *values);
630 /*
631 * The signal handler which is executed when there is a state_change
632 * signal for an object.
633 */
634 void (* state_change) (AtkObject *accessible,
635 const gchar *name,
636 gboolean state_set);
637 /*
638 * The signal handler which is executed when there is a change in the
639 * visible data for an object
640 */
641 void (*visible_data_changed) (AtkObject *accessible);
642
643 /*
644 * The signal handler which is executed when there is a change in the
645 * 'active' child or children of the object, for instance when
646 * interior focus changes in a table or list. This signal should be emitted
647 * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
648 */
649 void (*active_descendant_changed) (AtkObject *accessible,
650 gpointer *child);
651
652 /*
653 * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
654 * Since ATK 1.12
655 */
656 AtkAttributeSet* (*get_attributes) (AtkObject *accessible);
657
658 const gchar* (*get_object_locale) (AtkObject *accessible);
659
660 AtkFunction pad1;
661};
662
663ATK_AVAILABLE_IN_ALL
664GType atk_object_get_type (void);
665
666/**
667 * AtkImplementorIface:
668 *
669 * The AtkImplementor interface is implemented by objects for which
670 * AtkObject peers may be obtained via calls to
671 * iface->(ref_accessible)(implementor);
672 */
673struct _AtkImplementorIface
674{
675 GTypeInterface parent;
676
677 AtkObject* (*ref_accessible) (AtkImplementor *implementor);
678};
679
680ATK_AVAILABLE_IN_ALL
681GType atk_implementor_get_type (void);
682ATK_AVAILABLE_IN_ALL
683AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor);
684
685/*
686 * Properties directly supported by AtkObject
687 */
688
689ATK_AVAILABLE_IN_ALL
690const gchar* atk_object_get_name (AtkObject *accessible);
691ATK_AVAILABLE_IN_ALL
692const gchar* atk_object_get_description (AtkObject *accessible);
693ATK_AVAILABLE_IN_ALL
694AtkObject* atk_object_get_parent (AtkObject *accessible);
695ATK_AVAILABLE_IN_ALL
696AtkObject* atk_object_peek_parent (AtkObject *accessible);
697ATK_AVAILABLE_IN_ALL
698gint atk_object_get_n_accessible_children (AtkObject *accessible);
699ATK_AVAILABLE_IN_ALL
700AtkObject* atk_object_ref_accessible_child (AtkObject *accessible,
701 gint i);
702ATK_AVAILABLE_IN_ALL
703AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);
704ATK_AVAILABLE_IN_ALL
705AtkRole atk_object_get_role (AtkObject *accessible);
706
707ATK_DEPRECATED_FOR(atk_component_get_layer)
708AtkLayer atk_object_get_layer (AtkObject *accessible);
709ATK_DEPRECATED_FOR(atk_component_get_mdi_zorder)
710gint atk_object_get_mdi_zorder (AtkObject *accessible);
711
712ATK_AVAILABLE_IN_ALL
713AtkAttributeSet* atk_object_get_attributes (AtkObject *accessible);
714ATK_AVAILABLE_IN_ALL
715AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
716ATK_AVAILABLE_IN_ALL
717gint atk_object_get_index_in_parent (AtkObject *accessible);
718ATK_AVAILABLE_IN_ALL
719void atk_object_set_name (AtkObject *accessible,
720 const gchar *name);
721ATK_AVAILABLE_IN_ALL
722void atk_object_set_description (AtkObject *accessible,
723 const gchar *description);
724ATK_AVAILABLE_IN_ALL
725void atk_object_set_parent (AtkObject *accessible,
726 AtkObject *parent);
727ATK_AVAILABLE_IN_ALL
728void atk_object_set_role (AtkObject *accessible,
729 AtkRole role);
730
731
732ATK_DEPRECATED_IN_2_12
733guint atk_object_connect_property_change_handler (AtkObject *accessible,
734 AtkPropertyChangeHandler *handler);
735ATK_DEPRECATED_IN_2_12
736void atk_object_remove_property_change_handler (AtkObject *accessible,
737 guint handler_id);
738
739ATK_AVAILABLE_IN_ALL
740void atk_object_notify_state_change (AtkObject *accessible,
741 AtkState state,
742 gboolean value);
743ATK_AVAILABLE_IN_ALL
744void atk_object_initialize (AtkObject *accessible,
745 gpointer data);
746
747ATK_AVAILABLE_IN_ALL
748const gchar* atk_role_get_name (AtkRole role);
749ATK_AVAILABLE_IN_ALL
750AtkRole atk_role_for_name (const gchar *name);
751
752
753/* NEW in 1.1: convenience API */
754ATK_AVAILABLE_IN_ALL
755gboolean atk_object_add_relationship (AtkObject *object,
756 AtkRelationType relationship,
757 AtkObject *target);
758ATK_AVAILABLE_IN_ALL
759gboolean atk_object_remove_relationship (AtkObject *object,
760 AtkRelationType relationship,
761 AtkObject *target);
762ATK_AVAILABLE_IN_ALL
763const gchar* atk_role_get_localized_name (AtkRole role);
764ATK_DEPRECATED_IN_2_12
765AtkRole atk_role_register (const gchar *name);
766ATK_AVAILABLE_IN_2_8
767const gchar* atk_object_get_object_locale (AtkObject *accessible);
768
769G_END_DECLS
770
771#endif /* __ATK_OBJECT_H__ */
772