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: 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: 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: 1.1.1)
113 *@ATK_ROLE_FOOTER: An object that serves as a document footer. (Since: 1.1.1)
114 *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content. (Since: 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: 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: 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: 1.3)
118 *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar. (Since: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 1.12.1)
140 *@ATK_ROLE_TABLE_ROW: A row in a table. (Since: 2.1.0)
141 *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree. (Since: 2.1.0)
142 *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet. (Since: 2.1.0)
143 *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content. (Since: 2.1.0)
144 *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application. (Since: 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: 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: 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: 2.1.0)
148 *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. (Since: 2.1.0)
149 *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. (Since: 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: 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: 2.1.0)
152 *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. (Since: 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: 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 * that is quoted from another source. (Since: 2.12)
158 *@ATK_ROLE_AUDIO: An object which represents an audio element. (Since: 2.12)
159 *@ATK_ROLE_VIDEO: An object which represents a video element. (Since: 2.12)
160 *@ATK_ROLE_DEFINITION: A definition of a term or concept. (Since: 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: 2.12)
164 *@ATK_ROLE_LANDMARK: A region of a web page intended as a
165 * navigational landmark. This is designed to allow Assistive
166 * Technologies to provide quick navigation among key regions within a
167 * document. (Since: 2.12)
168 *@ATK_ROLE_LOG: A text widget or container holding log content, such
169 * as chat history and error logs. In this role there is a
170 * relationship between the arrival of new items in the log and the
171 * reading order. The log contains a meaningful sequence and new
172 * information is added only to the end of the log, not at arbitrary
173 * points. (Since: 2.12)
174 *@ATK_ROLE_MARQUEE: A container where non-essential information
175 * changes frequently. Common usages of marquee include stock tickers
176 * and ad banners. The primary difference between a marquee and a log
177 * 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 *@ATK_ROLE_RATING: A widget whose purpose is to display a rating,
182 * such as the number of stars associated with a song in a media
183 * player. Objects of this role should also implement
184 * AtkValue. (Since: 2.12)
185 *@ATK_ROLE_TIMER: An object containing a numerical counter which
186 * indicates an amount of elapsed time from a start point, or the time
187 * remaining until an end point. (Since: 2.12)
188 *@ATK_ROLE_DESCRIPTION_LIST: An object that represents a list of
189 * term-value groups. A term-value group represents a individual
190 * description and consist of one or more names
191 * (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
192 * (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 *@ATK_ROLE_STATIC: A generic non-container object whose purpose is to display a
199 * brief amount of information to the user and whose role is known by the
200 * implementor but lacks semantic value for the user. Examples in which
201 * %ATK_ROLE_STATIC is appropriate include the message displayed in a message box
202 * and an image used as an alternative means to display text. %ATK_ROLE_STATIC
203 * should not be applied to widgets which are traditionally interactive, objects
204 * which display a significant amount of content, or any object which has an
205 * accessible relation pointing to another object. Implementors should expose the
206 * displayed information through the accessible name of the object. If doing so seems
207 * inappropriate, it may indicate that a different role should be used. For
208 * labels which describe another widget, see %ATK_ROLE_LABEL. For text views, see
209 * %ATK_ROLE_TEXT. For generic containers, see %ATK_ROLE_PANEL. For objects whose
210 * 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 * superscript. (Since: 2.16)
219 *@ATK_ROLE_FOOTNOTE: An object that contains the text of a footnote. (Since: 2.26)
220 *@ATK_ROLE_CONTENT_DELETION: Content previously deleted or proposed to be
221 * deleted, e.g. in revision history or a content view providing suggestions
222 * from reviewers. (Since: 2.34)
223 *@ATK_ROLE_CONTENT_INSERTION: Content previously inserted or proposed to be
224 * inserted, e.g. in revision history or a content view providing suggestions
225 * from reviewers. (Since: 2.34)
226 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
227 *
228 * Describes the role of an object
229 *
230 * These are the built-in enumerated roles that UI components can have
231 * in ATK. Other roles may be added at runtime, so an AtkRole >=
232 * %ATK_ROLE_LAST_DEFINED is not necessarily an error.
233 */
234typedef enum
235{
236 ATK_ROLE_INVALID = 0,
237 ATK_ROLE_ACCEL_LABEL, /*<nick=accelerator-label>*/
238 ATK_ROLE_ALERT,
239 ATK_ROLE_ANIMATION,
240 ATK_ROLE_ARROW,
241 ATK_ROLE_CALENDAR,
242 ATK_ROLE_CANVAS,
243 ATK_ROLE_CHECK_BOX,
244 ATK_ROLE_CHECK_MENU_ITEM,
245 ATK_ROLE_COLOR_CHOOSER,
246 ATK_ROLE_COLUMN_HEADER,
247 ATK_ROLE_COMBO_BOX,
248 ATK_ROLE_DATE_EDITOR,
249 ATK_ROLE_DESKTOP_ICON,
250 ATK_ROLE_DESKTOP_FRAME,
251 ATK_ROLE_DIAL,
252 ATK_ROLE_DIALOG,
253 ATK_ROLE_DIRECTORY_PANE,
254 ATK_ROLE_DRAWING_AREA,
255 ATK_ROLE_FILE_CHOOSER,
256 ATK_ROLE_FILLER,
257 ATK_ROLE_FONT_CHOOSER,
258 ATK_ROLE_FRAME,
259 ATK_ROLE_GLASS_PANE,
260 ATK_ROLE_HTML_CONTAINER,
261 ATK_ROLE_ICON,
262 ATK_ROLE_IMAGE,
263 ATK_ROLE_INTERNAL_FRAME,
264 ATK_ROLE_LABEL,
265 ATK_ROLE_LAYERED_PANE,
266 ATK_ROLE_LIST,
267 ATK_ROLE_LIST_ITEM,
268 ATK_ROLE_MENU,
269 ATK_ROLE_MENU_BAR,
270 ATK_ROLE_MENU_ITEM,
271 ATK_ROLE_OPTION_PANE,
272 ATK_ROLE_PAGE_TAB,
273 ATK_ROLE_PAGE_TAB_LIST,
274 ATK_ROLE_PANEL,
275 ATK_ROLE_PASSWORD_TEXT,
276 ATK_ROLE_POPUP_MENU,
277 ATK_ROLE_PROGRESS_BAR,
278 ATK_ROLE_PUSH_BUTTON,
279 ATK_ROLE_RADIO_BUTTON,
280 ATK_ROLE_RADIO_MENU_ITEM,
281 ATK_ROLE_ROOT_PANE,
282 ATK_ROLE_ROW_HEADER,
283 ATK_ROLE_SCROLL_BAR,
284 ATK_ROLE_SCROLL_PANE,
285 ATK_ROLE_SEPARATOR,
286 ATK_ROLE_SLIDER,
287 ATK_ROLE_SPLIT_PANE,
288 ATK_ROLE_SPIN_BUTTON,
289 ATK_ROLE_STATUSBAR,
290 ATK_ROLE_TABLE,
291 ATK_ROLE_TABLE_CELL,
292 ATK_ROLE_TABLE_COLUMN_HEADER,
293 ATK_ROLE_TABLE_ROW_HEADER,
294 ATK_ROLE_TEAR_OFF_MENU_ITEM,
295 ATK_ROLE_TERMINAL,
296 ATK_ROLE_TEXT,
297 ATK_ROLE_TOGGLE_BUTTON,
298 ATK_ROLE_TOOL_BAR,
299 ATK_ROLE_TOOL_TIP,
300 ATK_ROLE_TREE,
301 ATK_ROLE_TREE_TABLE,
302 ATK_ROLE_UNKNOWN,
303 ATK_ROLE_VIEWPORT,
304 ATK_ROLE_WINDOW,
305 ATK_ROLE_HEADER,
306 ATK_ROLE_FOOTER,
307 ATK_ROLE_PARAGRAPH,
308 ATK_ROLE_RULER,
309 ATK_ROLE_APPLICATION,
310 ATK_ROLE_AUTOCOMPLETE,
311 ATK_ROLE_EDITBAR, /*<nick=edit-bar>*/
312 ATK_ROLE_EMBEDDED,
313 ATK_ROLE_ENTRY,
314 ATK_ROLE_CHART,
315 ATK_ROLE_CAPTION,
316 ATK_ROLE_DOCUMENT_FRAME,
317 ATK_ROLE_HEADING,
318 ATK_ROLE_PAGE,
319 ATK_ROLE_SECTION,
320 ATK_ROLE_REDUNDANT_OBJECT,
321 ATK_ROLE_FORM,
322 ATK_ROLE_LINK,
323 ATK_ROLE_INPUT_METHOD_WINDOW,
324 ATK_ROLE_TABLE_ROW,
325 ATK_ROLE_TREE_ITEM,
326 ATK_ROLE_DOCUMENT_SPREADSHEET,
327 ATK_ROLE_DOCUMENT_PRESENTATION,
328 ATK_ROLE_DOCUMENT_TEXT,
329 ATK_ROLE_DOCUMENT_WEB,
330 ATK_ROLE_DOCUMENT_EMAIL,
331 ATK_ROLE_COMMENT,
332 ATK_ROLE_LIST_BOX,
333 ATK_ROLE_GROUPING,
334 ATK_ROLE_IMAGE_MAP,
335 ATK_ROLE_NOTIFICATION,
336 ATK_ROLE_INFO_BAR,
337 ATK_ROLE_LEVEL_BAR,
338 ATK_ROLE_TITLE_BAR,
339 ATK_ROLE_BLOCK_QUOTE,
340 ATK_ROLE_AUDIO,
341 ATK_ROLE_VIDEO,
342 ATK_ROLE_DEFINITION,
343 ATK_ROLE_ARTICLE,
344 ATK_ROLE_LANDMARK,
345 ATK_ROLE_LOG,
346 ATK_ROLE_MARQUEE,
347 ATK_ROLE_MATH,
348 ATK_ROLE_RATING,
349 ATK_ROLE_TIMER,
350 ATK_ROLE_DESCRIPTION_LIST,
351 ATK_ROLE_DESCRIPTION_TERM,
352 ATK_ROLE_DESCRIPTION_VALUE,
353 ATK_ROLE_STATIC,
354 ATK_ROLE_MATH_FRACTION,
355 ATK_ROLE_MATH_ROOT,
356 ATK_ROLE_SUBSCRIPT,
357 ATK_ROLE_SUPERSCRIPT,
358 ATK_ROLE_FOOTNOTE,
359 ATK_ROLE_CONTENT_DELETION,
360 ATK_ROLE_CONTENT_INSERTION,
361 ATK_ROLE_LAST_DEFINED
362} AtkRole;
363
364/**
365 *AtkLayer:
366 *@ATK_LAYER_INVALID: The object does not have a layer
367 *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
368 *@ATK_LAYER_CANVAS: This layer is used for Canvas components
369 *@ATK_LAYER_WIDGET: This layer is normally used for components
370 *@ATK_LAYER_MDI: This layer is used for layered components
371 *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
372 *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
373 *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
374 *
375 * Describes the layer of a component
376 *
377 * These enumerated "layer values" are used when determining which UI
378 * rendering layer a component is drawn into, which can help in making
379 * determinations of when components occlude one another.
380 **/
381typedef enum
382{
383 ATK_LAYER_INVALID,
384 ATK_LAYER_BACKGROUND,
385 ATK_LAYER_CANVAS,
386 ATK_LAYER_WIDGET,
387 ATK_LAYER_MDI,
388 ATK_LAYER_POPUP,
389 ATK_LAYER_OVERLAY,
390 ATK_LAYER_WINDOW
391} AtkLayer;
392
393/**
394 * AtkAttributeSet:
395 *
396 * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
397 * used by atk_text_get_run_attributes(),
398 * atk_text_get_default_attributes(),
399 * atk_editable_text_set_run_attributes(),
400 * atk_document_get_attributes() and atk_object_get_attributes()
401 **/
402typedef GSList AtkAttributeSet;
403
404/**
405 * AtkAttribute:
406 * @name: The attribute name.
407 * @value: the value of the attribute, represented as a string.
408 *
409 * AtkAttribute is a string name/value pair representing a generic
410 * attribute. This can be used to expose additional information from
411 * an accessible object as a whole (see atk_object_get_attributes())
412 * or an document (see atk_document_get_attributes()). In the case of
413 * text attributes (see atk_text_get_default_attributes()),
414 * #AtkTextAttribute enum defines all the possible text attribute
415 * names. You can use atk_text_attribute_get_name() to get the string
416 * name from the enum value. See also atk_text_attribute_for_name()
417 * and atk_text_attribute_get_value() for more information.
418 *
419 * A string name/value pair representing a generic attribute.
420 **/
421typedef struct _AtkAttribute AtkAttribute;
422
423struct _AtkAttribute {
424 gchar* name;
425 gchar* value;
426};
427
428#define ATK_TYPE_OBJECT (atk_object_get_type ())
429#define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
430#define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
431#define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
432#define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
433#define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
434
435#define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
436#define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
437#define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
438#define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
439
440
441typedef struct _AtkImplementor AtkImplementor; /* dummy typedef */
442typedef struct _AtkImplementorIface AtkImplementorIface;
443
444
445typedef struct _AtkObject AtkObject;
446typedef struct _AtkObjectClass AtkObjectClass;
447typedef struct _AtkRelationSet AtkRelationSet;
448typedef struct _AtkStateSet AtkStateSet;
449
450/**
451 * AtkPropertyValues:
452 * @property_name: The name of the ATK property which has changed.
453 * @old_value: NULL. This field is not used anymore.
454 * @new_value: The new value of the named property.
455 *
456 * Note: @old_value field of #AtkPropertyValues will not contain a
457 * valid value. This is a field defined with the purpose of contain
458 * the previous value of the property, but is not used anymore.
459 *
460 **/
461struct _AtkPropertyValues
462{
463 const gchar *property_name;
464 GValue old_value;
465 GValue new_value;
466};
467
468typedef struct _AtkPropertyValues AtkPropertyValues;
469
470/**
471 * AtkFunction:
472 * @user_data: custom data defined by the user
473 *
474 * An AtkFunction is a function definition used for padding which has
475 * been added to class and interface structures to allow for expansion
476 * in the future.
477 *
478 * Returns: not used
479 */
480typedef gboolean (*AtkFunction) (gpointer user_data);
481/*
482 * For most properties the old_value field of AtkPropertyValues will
483 * not contain a valid value.
484 *
485 * Currently, the only property for which old_value is used is
486 * accessible-state; for instance if there is a focus state the
487 * property change handler will be called for the object which lost the focus
488 * with the old_value containing an AtkState value corresponding to focused
489 * and the property change handler will be called for the object which
490 * received the focus with the new_value containing an AtkState value
491 * corresponding to focused.
492 */
493
494/**
495 * AtkPropertyChangeHandler:
496 * @obj: atkobject which property changes
497 * @vals: values changed
498 *
499 * An AtkPropertyChangeHandler is a function which is executed when an
500 * AtkObject's property changes value. It is specified in a call to
501 * atk_object_connect_property_change_handler().
502 *
503 * Deprecated: Since 2.12.
504 */
505typedef void (*AtkPropertyChangeHandler) (AtkObject* obj, AtkPropertyValues* vals);
506
507
508struct _AtkObject
509{
510 GObject parent;
511
512 gchar *description;
513 gchar *name;
514 AtkObject *accessible_parent;
515 AtkRole role;
516 AtkRelationSet *relation_set;
517 AtkLayer layer;
518};
519
520
521/**
522 * AtkObjectClass:
523 * @connect_property_change_handler: specifies a function to be called
524 * when a property changes value. This virtual function is
525 * deprecated since 2.12 and it should not be overriden. Connect
526 * directly to property-change or notify signal instead.
527 * @remove_property_change_handler: removes a property changed handler
528 * as returned by @connect_property_change_handler. This virtual
529 * function is deprecated sice 2.12 and it should not be overriden.
530 * @focus_event: The signal handler which is executed when there is a
531 * focus event for an object. This virtual function is deprecated
532 * since 2.9.4 and it should not be overriden. Use
533 * the #AtkObject::state-change "focused" signal instead.
534 */
535struct _AtkObjectClass
536{
537 GObjectClass parent;
538
539 /*
540 * Gets the accessible name of the object
541 */
542 const gchar* (* get_name) (AtkObject *accessible);
543 /*
544 * Gets the accessible description of the object
545 */
546 const gchar* (* get_description) (AtkObject *accessible);
547 /*
548 * Gets the accessible parent of the object
549 */
550 AtkObject* (*get_parent) (AtkObject *accessible);
551
552 /*
553 * Gets the number of accessible children of the object
554 */
555 gint (* get_n_children) (AtkObject *accessible);
556 /*
557 * Returns a reference to the specified accessible child of the object.
558 * The accessible children are 0-based so the first accessible child is
559 * at index 0, the second at index 1 and so on.
560 */
561 AtkObject* (* ref_child) (AtkObject *accessible,
562 gint i);
563 /*
564 * Gets the 0-based index of this object in its parent; returns -1 if the
565 * object does not have an accessible parent.
566 */
567 gint (* get_index_in_parent) (AtkObject *accessible);
568 /*
569 * Gets the RelationSet associated with the object
570 */
571 AtkRelationSet* (* ref_relation_set) (AtkObject *accessible);
572 /*
573 * Gets the role of the object
574 */
575 AtkRole (* get_role) (AtkObject *accessible);
576 AtkLayer (* get_layer) (AtkObject *accessible);
577 gint (* get_mdi_zorder) (AtkObject *accessible);
578 /*
579 * Gets the state set of the object
580 */
581 AtkStateSet* (* ref_state_set) (AtkObject *accessible);
582 /*
583 * Sets the accessible name of the object
584 */
585 void (* set_name) (AtkObject *accessible,
586 const gchar *name);
587 /*
588 * Sets the accessible description of the object
589 */
590 void (* set_description) (AtkObject *accessible,
591 const gchar *description);
592 /*
593 * Sets the accessible parent of the object
594 */
595 void (* set_parent) (AtkObject *accessible,
596 AtkObject *parent);
597 /*
598 * Sets the accessible role of the object
599 */
600 void (* set_role) (AtkObject *accessible,
601 AtkRole role);
602 /*
603 * Specifies a function to be called when a property changes value
604 */
605guint (* connect_property_change_handler) (AtkObject
606 *accessible,
607 AtkPropertyChangeHandler *handler);
608 /*
609 * Removes a property change handler which was specified using
610 * connect_property_change_handler
611 */
612void (* remove_property_change_handler) (AtkObject
613 *accessible,
614 guint
615 handler_id);
616void (* initialize) (AtkObject *accessible,
617 gpointer data);
618 /*
619 * The signal handler which is executed when there is a change in the
620 * children of the object
621 */
622 void (* children_changed) (AtkObject *accessible,
623 guint change_index,
624 gpointer changed_child);
625 /*
626 * The signal handler which is executed when there is a focus event
627 * for an object.
628 */
629 void (* focus_event) (AtkObject *accessible,
630 gboolean focus_in);
631 /*
632 * The signal handler which is executed when there is a property_change
633 * signal for an object.
634 */
635 void (* property_change) (AtkObject *accessible,
636 AtkPropertyValues *values);
637 /*
638 * The signal handler which is executed when there is a state_change
639 * signal for an object.
640 */
641 void (* state_change) (AtkObject *accessible,
642 const gchar *name,
643 gboolean state_set);
644 /*
645 * The signal handler which is executed when there is a change in the
646 * visible data for an object
647 */
648 void (*visible_data_changed) (AtkObject *accessible);
649
650 /*
651 * The signal handler which is executed when there is a change in the
652 * 'active' child or children of the object, for instance when
653 * interior focus changes in a table or list. This signal should be emitted
654 * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
655 */
656 void (*active_descendant_changed) (AtkObject *accessible,
657 gpointer *child);
658
659 /*
660 * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
661 * Since ATK 1.12
662 */
663 AtkAttributeSet* (*get_attributes) (AtkObject *accessible);
664
665 const gchar* (*get_object_locale) (AtkObject *accessible);
666
667 AtkFunction pad1;
668};
669
670ATK_AVAILABLE_IN_ALL
671GType atk_object_get_type (void);
672
673/**
674 * AtkImplementorIface:
675 *
676 * The AtkImplementor interface is implemented by objects for which
677 * AtkObject peers may be obtained via calls to
678 * iface->(ref_accessible)(implementor);
679 */
680struct _AtkImplementorIface
681{
682 GTypeInterface parent;
683
684 AtkObject* (*ref_accessible) (AtkImplementor *implementor);
685};
686
687ATK_AVAILABLE_IN_ALL
688GType atk_implementor_get_type (void);
689ATK_AVAILABLE_IN_ALL
690AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor);
691
692/*
693 * Properties directly supported by AtkObject
694 */
695
696ATK_AVAILABLE_IN_ALL
697const gchar* atk_object_get_name (AtkObject *accessible);
698ATK_AVAILABLE_IN_ALL
699const gchar* atk_object_get_description (AtkObject *accessible);
700ATK_AVAILABLE_IN_ALL
701AtkObject* atk_object_get_parent (AtkObject *accessible);
702ATK_AVAILABLE_IN_ALL
703AtkObject* atk_object_peek_parent (AtkObject *accessible);
704ATK_AVAILABLE_IN_ALL
705gint atk_object_get_n_accessible_children (AtkObject *accessible);
706ATK_AVAILABLE_IN_ALL
707AtkObject* atk_object_ref_accessible_child (AtkObject *accessible,
708 gint i);
709ATK_AVAILABLE_IN_ALL
710AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);
711ATK_AVAILABLE_IN_ALL
712AtkRole atk_object_get_role (AtkObject *accessible);
713
714ATK_DEPRECATED_FOR(atk_component_get_layer)
715AtkLayer atk_object_get_layer (AtkObject *accessible);
716ATK_DEPRECATED_FOR(atk_component_get_mdi_zorder)
717gint atk_object_get_mdi_zorder (AtkObject *accessible);
718
719ATK_AVAILABLE_IN_ALL
720AtkAttributeSet* atk_object_get_attributes (AtkObject *accessible);
721ATK_AVAILABLE_IN_ALL
722AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
723ATK_AVAILABLE_IN_ALL
724gint atk_object_get_index_in_parent (AtkObject *accessible);
725ATK_AVAILABLE_IN_ALL
726void atk_object_set_name (AtkObject *accessible,
727 const gchar *name);
728ATK_AVAILABLE_IN_ALL
729void atk_object_set_description (AtkObject *accessible,
730 const gchar *description);
731ATK_AVAILABLE_IN_ALL
732void atk_object_set_parent (AtkObject *accessible,
733 AtkObject *parent);
734ATK_AVAILABLE_IN_ALL
735void atk_object_set_role (AtkObject *accessible,
736 AtkRole role);
737
738
739ATK_DEPRECATED_IN_2_12
740guint atk_object_connect_property_change_handler (AtkObject *accessible,
741 AtkPropertyChangeHandler *handler);
742ATK_DEPRECATED_IN_2_12
743void atk_object_remove_property_change_handler (AtkObject *accessible,
744 guint handler_id);
745
746ATK_AVAILABLE_IN_ALL
747void atk_object_notify_state_change (AtkObject *accessible,
748 AtkState state,
749 gboolean value);
750ATK_AVAILABLE_IN_ALL
751void atk_object_initialize (AtkObject *accessible,
752 gpointer data);
753
754ATK_AVAILABLE_IN_ALL
755const gchar* atk_role_get_name (AtkRole role);
756ATK_AVAILABLE_IN_ALL
757AtkRole atk_role_for_name (const gchar *name);
758
759
760/* NEW in 1.1: convenience API */
761ATK_AVAILABLE_IN_ALL
762gboolean atk_object_add_relationship (AtkObject *object,
763 AtkRelationType relationship,
764 AtkObject *target);
765ATK_AVAILABLE_IN_ALL
766gboolean atk_object_remove_relationship (AtkObject *object,
767 AtkRelationType relationship,
768 AtkObject *target);
769ATK_AVAILABLE_IN_ALL
770const gchar* atk_role_get_localized_name (AtkRole role);
771ATK_DEPRECATED_IN_2_12
772AtkRole atk_role_register (const gchar *name);
773ATK_AVAILABLE_IN_2_8
774const gchar* atk_object_get_object_locale (AtkObject *accessible);
775
776ATK_AVAILABLE_IN_ALL
777const gchar* atk_object_get_accessible_id (AtkObject *accessible);
778
779ATK_AVAILABLE_IN_ALL
780void atk_object_set_accessible_id (AtkObject *accessible,
781 const gchar *name);
782
783G_END_DECLS
784
785#endif /* __ATK_OBJECT_H__ */
786