other-licenses/atk-1.0/atk/atkobject.h@97036ab72558
other-licenses/atk-1.0/atk/atkobject.h
Tue, 06 Jan 2015 21:39:09 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 06 Jan 2015 21:39:09 +0100
- branch
- TOR_BUG_9701
- changeset 8
- 97036ab72558
- permissions
- -rw-r--r--
Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.
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 */
20 #ifndef __ATK_OBJECT_H__
21 #define __ATK_OBJECT_H__
23 #ifdef __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
27 #include <glib-object.h>
28 #include <atk/atkstate.h>
29 #include <atk/atkrelationtype.h>
31 /*
32 * AtkObject represents the minimum information all accessible objects
33 * return. This information includes accessible name, accessible
34 * description, role and state of the object, as well information about
35 * its parent and children. It is also possible to obtain more specific
36 * accessibility information about a component if it supports one or more
37 * of the following interfaces:
38 */
41 /**
42 *AtkRole:
43 *@ATK_ROLE_INVALID: Invalid role
44 *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
45 *@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.
46 *@ATK_ROLE_ANIMATION: An object which is an animated image
47 *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
48 *@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
49 *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
50 *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
51 *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
52 *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
53 *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
54 *@ATK_ROLE_COMBO_BOX: A collapsible list of choices the user can select from
55 *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
56 *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
57 *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
58 *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
59 *@ATK_ROLE_DIALOG: A top level window with title bar and a border
60 *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
61 *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
62 *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
63 *@ATK_ROLE_FILLER: A object that fills up space in a user interface
64 *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
65 *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
66 *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
67 *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
68 *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
69 *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
70 *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
71 *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
72 *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
73 *@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
74 *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
75 *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
76 *@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
77 *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
78 *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
79 *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
80 *@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
81 *@ATK_ROLE_PANEL: A generic container that is often used to group objects
82 *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
83 *@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
84 *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
85 *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
86 *@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
87 *@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
88 *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
89 *@ATK_ROLE_ROW_HEADER: The header for a row of data
90 *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
91 *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
92 *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
93 *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
94 *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
95 *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
96 *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
97 *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
98 *@ATK_ROLE_TABLE_CELL: A cell in a table
99 *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
100 *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
101 *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
102 *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal. @Since: ATK-0.6
103 *@ATK_ROLE_TEXT: An object that presents text to the user
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 the term, or
196 * name, part of a term-description group in a description
197 * list. @Since: ATK-2.12
198 *@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the
199 * description, definition or value of a term-description group in a
200 * description list. The values within a group are alternatives,
201 * meaning that you can have several ATK_ROLE_DESCRIPTION_VALUE for a
202 * given ATK_ROLE_DESCRIPTION_TERM. @Since: ATK-2.12
203 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
204 *
205 * Describes the role of an object
206 *
207 * These are the built-in enumerated roles that UI components can have in
208 * ATK. Other roles may be added at runtime, so an AtkRole >=
209 * ATK_ROLE_LAST_DEFINED is not necessarily an error.
210 **/
211 typedef enum
212 {
213 ATK_ROLE_INVALID = 0,
214 ATK_ROLE_ACCEL_LABEL, /*<nick=accelerator-label>*/
215 ATK_ROLE_ALERT,
216 ATK_ROLE_ANIMATION,
217 ATK_ROLE_ARROW,
218 ATK_ROLE_CALENDAR,
219 ATK_ROLE_CANVAS,
220 ATK_ROLE_CHECK_BOX,
221 ATK_ROLE_CHECK_MENU_ITEM,
222 ATK_ROLE_COLOR_CHOOSER,
223 ATK_ROLE_COLUMN_HEADER,
224 ATK_ROLE_COMBO_BOX,
225 ATK_ROLE_DATE_EDITOR,
226 ATK_ROLE_DESKTOP_ICON,
227 ATK_ROLE_DESKTOP_FRAME,
228 ATK_ROLE_DIAL,
229 ATK_ROLE_DIALOG,
230 ATK_ROLE_DIRECTORY_PANE,
231 ATK_ROLE_DRAWING_AREA,
232 ATK_ROLE_FILE_CHOOSER,
233 ATK_ROLE_FILLER,
234 ATK_ROLE_FONT_CHOOSER,
235 ATK_ROLE_FRAME,
236 ATK_ROLE_GLASS_PANE,
237 ATK_ROLE_HTML_CONTAINER,
238 ATK_ROLE_ICON,
239 ATK_ROLE_IMAGE,
240 ATK_ROLE_INTERNAL_FRAME,
241 ATK_ROLE_LABEL,
242 ATK_ROLE_LAYERED_PANE,
243 ATK_ROLE_LIST,
244 ATK_ROLE_LIST_ITEM,
245 ATK_ROLE_MENU,
246 ATK_ROLE_MENU_BAR,
247 ATK_ROLE_MENU_ITEM,
248 ATK_ROLE_OPTION_PANE,
249 ATK_ROLE_PAGE_TAB,
250 ATK_ROLE_PAGE_TAB_LIST,
251 ATK_ROLE_PANEL,
252 ATK_ROLE_PASSWORD_TEXT,
253 ATK_ROLE_POPUP_MENU,
254 ATK_ROLE_PROGRESS_BAR,
255 ATK_ROLE_PUSH_BUTTON,
256 ATK_ROLE_RADIO_BUTTON,
257 ATK_ROLE_RADIO_MENU_ITEM,
258 ATK_ROLE_ROOT_PANE,
259 ATK_ROLE_ROW_HEADER,
260 ATK_ROLE_SCROLL_BAR,
261 ATK_ROLE_SCROLL_PANE,
262 ATK_ROLE_SEPARATOR,
263 ATK_ROLE_SLIDER,
264 ATK_ROLE_SPLIT_PANE,
265 ATK_ROLE_SPIN_BUTTON,
266 ATK_ROLE_STATUSBAR,
267 ATK_ROLE_TABLE,
268 ATK_ROLE_TABLE_CELL,
269 ATK_ROLE_TABLE_COLUMN_HEADER,
270 ATK_ROLE_TABLE_ROW_HEADER,
271 ATK_ROLE_TEAR_OFF_MENU_ITEM,
272 ATK_ROLE_TERMINAL,
273 ATK_ROLE_TEXT,
274 ATK_ROLE_TOGGLE_BUTTON,
275 ATK_ROLE_TOOL_BAR,
276 ATK_ROLE_TOOL_TIP,
277 ATK_ROLE_TREE,
278 ATK_ROLE_TREE_TABLE,
279 ATK_ROLE_UNKNOWN,
280 ATK_ROLE_VIEWPORT,
281 ATK_ROLE_WINDOW,
282 ATK_ROLE_HEADER,
283 ATK_ROLE_FOOTER,
284 ATK_ROLE_PARAGRAPH,
285 ATK_ROLE_RULER,
286 ATK_ROLE_APPLICATION,
287 ATK_ROLE_AUTOCOMPLETE,
288 ATK_ROLE_EDITBAR,
289 ATK_ROLE_EMBEDDED,
290 ATK_ROLE_ENTRY,
291 ATK_ROLE_CHART,
292 ATK_ROLE_CAPTION,
293 ATK_ROLE_DOCUMENT_FRAME,
294 ATK_ROLE_HEADING,
295 ATK_ROLE_PAGE,
296 ATK_ROLE_SECTION,
297 ATK_ROLE_REDUNDANT_OBJECT,
298 ATK_ROLE_FORM,
299 ATK_ROLE_LINK,
300 ATK_ROLE_INPUT_METHOD_WINDOW,
301 ATK_ROLE_TABLE_ROW,
302 ATK_ROLE_TREE_ITEM,
303 ATK_ROLE_DOCUMENT_SPREADSHEET,
304 ATK_ROLE_DOCUMENT_PRESENTATION,
305 ATK_ROLE_DOCUMENT_TEXT,
306 ATK_ROLE_DOCUMENT_WEB,
307 ATK_ROLE_DOCUMENT_EMAIL,
308 ATK_ROLE_COMMENT,
309 ATK_ROLE_LIST_BOX,
310 ATK_ROLE_GROUPING,
311 ATK_ROLE_IMAGE_MAP,
312 ATK_ROLE_NOTIFICATION,
313 ATK_ROLE_INFO_BAR,
314 ATK_ROLE_LEVEL_BAR,
315 ATK_ROLE_TITLE_BAR,
316 ATK_ROLE_BLOCK_QUOTE,
317 ATK_ROLE_AUDIO,
318 ATK_ROLE_VIDEO,
319 ATK_ROLE_DEFINITION,
320 ATK_ROLE_ARTICLE,
321 ATK_ROLE_LANDMARK,
322 ATK_ROLE_LOG,
323 ATK_ROLE_MARQUEE,
324 ATK_ROLE_MATH,
325 ATK_ROLE_RATING,
326 ATK_ROLE_TIMER,
327 ATK_ROLE_DESCRIPTION_LIST,
328 ATK_ROLE_DESCRIPTION_TERM,
329 ATK_ROLE_DESCRIPTION_VALUE,
330 ATK_ROLE_LAST_DEFINED
331 } AtkRole;
333 AtkRole atk_role_register (const gchar *name);
335 /**
336 *AtkLayer:
337 *@ATK_LAYER_INVALID: The object does not have a layer
338 *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
339 *@ATK_LAYER_CANVAS: This layer is used for Canvas components
340 *@ATK_LAYER_WIDGET: This layer is normally used for components
341 *@ATK_LAYER_MDI: This layer is used for layered components
342 *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
343 *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
344 *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
345 *
346 * Describes the layer of a component
347 *
348 * These enumerated "layer values" are used when determining which UI
349 * rendering layer a component is drawn into, which can help in making
350 * determinations of when components occlude one another.
351 **/
352 typedef enum
353 {
354 ATK_LAYER_INVALID,
355 ATK_LAYER_BACKGROUND,
356 ATK_LAYER_CANVAS,
357 ATK_LAYER_WIDGET,
358 ATK_LAYER_MDI,
359 ATK_LAYER_POPUP,
360 ATK_LAYER_OVERLAY,
361 ATK_LAYER_WINDOW
362 } AtkLayer;
364 /**
365 * AtkAttributeSet:
366 *
367 * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
368 * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
369 * and atk_editable_text_set_run_attributes()
370 **/
371 typedef GSList AtkAttributeSet;
373 /**
374 * AtkAttribute:
375 * @name: The attribute name. Call atk_text_attr_get_name()
376 * @value: the value of the attribute, represented as a string.
377 * Call atk_text_attr_get_value() for those which are strings.
378 * For values which are numbers, the string representation of the number
379 * is in value.
380 *
381 * A string name/value pair representing a text attribute.
382 **/
383 typedef struct _AtkAttribute AtkAttribute;
385 struct _AtkAttribute {
386 gchar* name;
387 gchar* value;
388 };
390 #define ATK_TYPE_OBJECT (atk_object_get_type ())
391 #define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
392 #define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
393 #define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
394 #define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
395 #define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
397 #define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
398 #define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
399 #define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
400 #define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
403 typedef struct _AtkImplementor AtkImplementor; /* dummy typedef */
404 typedef struct _AtkImplementorIface AtkImplementorIface;
407 typedef struct _AtkObject AtkObject;
408 typedef struct _AtkObjectClass AtkObjectClass;
409 typedef struct _AtkRelationSet AtkRelationSet;
410 typedef struct _AtkStateSet AtkStateSet;
412 /**
413 * AtkPropertyValues:
414 * @property_name: The name of the ATK property which is being presented or which has been changed.
415 * @old_value: The old property value, NULL; in some contexts this value is undefined (see note below).
416 * @new_value: The new value of the named property.
417 *
418 * @note: For most properties the old_value field of AtkPropertyValues will
419 * not contain a valid value.
420 *
421 * Currently, the only property for which old_value is used is
422 * accessible-state; for instance if there is a focus state the
423 * property change handler will be called for the object which lost the focus
424 * with the old_value containing an AtkState value corresponding to focused
425 * and the property change handler will be called for the object which
426 * received the focus with the new_value containing an AtkState value
427 * corresponding to focused.
428 *
429 **/
430 struct _AtkPropertyValues
431 {
432 const gchar *property_name;
433 GValue old_value;
434 GValue new_value;
435 };
437 typedef struct _AtkPropertyValues AtkPropertyValues;
439 typedef gboolean (*AtkFunction) (gpointer data);
440 /*
441 * For most properties the old_value field of AtkPropertyValues will
442 * not contain a valid value.
443 *
444 * Currently, the only property for which old_value is used is
445 * accessible-state; for instance if there is a focus state the
446 * property change handler will be called for the object which lost the focus
447 * with the old_value containing an AtkState value corresponding to focused
448 * and the property change handler will be called for the object which
449 * received the focus with the new_value containing an AtkState value
450 * corresponding to focused.
451 */
452 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
455 struct _AtkObject
456 {
457 GObject parent;
459 gchar *description;
460 gchar *name;
461 AtkObject *accessible_parent;
462 AtkRole role;
463 AtkRelationSet *relation_set;
464 AtkLayer layer;
465 };
467 struct _AtkObjectClass
468 {
469 GObjectClass parent;
471 /*
472 * Gets the accessible name of the object
473 */
474 G_CONST_RETURN gchar* (* get_name) (AtkObject *accessible);
475 /*
476 * Gets the accessible description of the object
477 */
478 G_CONST_RETURN gchar* (* get_description) (AtkObject *accessible);
479 /*
480 * Gets the accessible parent of the object
481 */
482 AtkObject* (*get_parent) (AtkObject *accessible);
484 /*
485 * Gets the number of accessible children of the object
486 */
487 gint (* get_n_children) (AtkObject *accessible);
488 /*
489 * Returns a reference to the specified accessible child of the object.
490 * The accessible children are 0-based so the first accessible child is
491 * at index 0, the second at index 1 and so on.
492 */
493 AtkObject* (* ref_child) (AtkObject *accessible,
494 gint i);
495 /*
496 * Gets the 0-based index of this object in its parent; returns -1 if the
497 * object does not have an accessible parent.
498 */
499 gint (* get_index_in_parent) (AtkObject *accessible);
500 /*
501 * Gets the RelationSet associated with the object
502 */
503 AtkRelationSet* (* ref_relation_set) (AtkObject *accessible);
504 /*
505 * Gets the role of the object
506 */
507 AtkRole (* get_role) (AtkObject *accessible);
508 AtkLayer (* get_layer) (AtkObject *accessible);
509 gint (* get_mdi_zorder) (AtkObject *accessible);
510 /*
511 * Gets the state set of the object
512 */
513 AtkStateSet* (* ref_state_set) (AtkObject *accessible);
514 /*
515 * Sets the accessible name of the object
516 */
517 void (* set_name) (AtkObject *accessible,
518 const gchar *name);
519 /*
520 * Sets the accessible description of the object
521 */
522 void (* set_description) (AtkObject *accessible,
523 const gchar *description);
524 /*
525 * Sets the accessible parent of the object
526 */
527 void (* set_parent) (AtkObject *accessible,
528 AtkObject *parent);
529 /*
530 * Sets the accessible role of the object
531 */
532 void (* set_role) (AtkObject *accessible,
533 AtkRole role);
534 /*
535 * Specifies a function to be called when a property changes value
536 */
537 guint (* connect_property_change_handler) (AtkObject
538 *accessible,
539 AtkPropertyChangeHandler *handler);
540 /*
541 * Removes a property change handler which was specified using
542 * connect_property_change_handler
543 */
544 void (* remove_property_change_handler) (AtkObject
545 *accessible,
546 guint
547 handler_id);
548 void (* initialize) (AtkObject *accessible,
549 gpointer data);
550 /*
551 * The signal handler which is executed when there is a change in the
552 * children of the object
553 */
554 void (* children_changed) (AtkObject *accessible,
555 guint change_index,
556 gpointer changed_child);
557 /*
558 * The signal handler which is executed when there is a focus event
559 * for an object.
560 */
561 void (* focus_event) (AtkObject *accessible,
562 gboolean focus_in);
563 /*
564 * The signal handler which is executed when there is a property_change
565 * signal for an object.
566 */
567 void (* property_change) (AtkObject *accessible,
568 AtkPropertyValues *values);
569 /*
570 * The signal handler which is executed when there is a state_change
571 * signal for an object.
572 */
573 void (* state_change) (AtkObject *accessible,
574 const gchar *name,
575 gboolean state_set);
576 /*
577 * The signal handler which is executed when there is a change in the
578 * visible data for an object
579 */
580 void (*visible_data_changed) (AtkObject *accessible);
582 /*
583 * The signal handler which is executed when there is a change in the
584 * 'active' child or children of the object, for instance when
585 * interior focus changes in a table or list. This signal should be emitted
586 * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
587 */
588 void (*active_descendant_changed) (AtkObject *accessible,
589 gpointer *child);
591 /*
592 * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
593 * Since ATK 1.12
594 */
595 AtkAttributeSet* (*get_attributes) (AtkObject *accessible);
597 const gchar* (*get_object_locale) (AtkObject *accessible);
599 AtkFunction pad1;
600 };
602 GType atk_object_get_type (void);
604 struct _AtkImplementorIface
605 {
606 GTypeInterface parent;
608 AtkObject* (*ref_accessible) (AtkImplementor *implementor);
609 };
610 GType atk_implementor_get_type (void);
612 /*
613 * This method uses the ref_accessible method in AtkImplementorIface,
614 * if the object's class implements AtkImplementorIface.
615 * Otherwise it returns %NULL.
616 *
617 * IMPORTANT:
618 * Note also that because this method may return flyweight objects,
619 * it increments the returned AtkObject's reference count.
620 * Therefore it is the responsibility of the calling
621 * program to unreference the object when no longer needed.
622 * (c.f. gtk_widget_get_accessible() where this is not the case).
623 */
624 AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor);
626 /*
627 * Properties directly supported by AtkObject
628 */
630 G_CONST_RETURN gchar* atk_object_get_name (AtkObject *accessible);
631 G_CONST_RETURN gchar* atk_object_get_description (AtkObject *accessible);
632 AtkObject* atk_object_get_parent (AtkObject *accessible);
633 gint atk_object_get_n_accessible_children (AtkObject *accessible);
634 AtkObject* atk_object_ref_accessible_child (AtkObject *accessible,
635 gint i);
636 AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);
637 AtkRole atk_object_get_role (AtkObject *accessible);
638 AtkLayer atk_object_get_layer (AtkObject *accessible);
639 gint atk_object_get_mdi_zorder (AtkObject *accessible);
640 AtkAttributeSet* atk_object_get_attributes (AtkObject *accessible);
641 AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
642 gint atk_object_get_index_in_parent (AtkObject *accessible);
643 void atk_object_set_name (AtkObject *accessible,
644 const gchar *name);
645 void atk_object_set_description (AtkObject *accessible,
646 const gchar *description);
647 void atk_object_set_parent (AtkObject *accessible,
648 AtkObject *parent);
649 void atk_object_set_role (AtkObject *accessible,
650 AtkRole role);
653 guint atk_object_connect_property_change_handler (AtkObject *accessible,
654 AtkPropertyChangeHandler *handler);
655 void atk_object_remove_property_change_handler (AtkObject *accessible,
656 guint handler_id);
658 void atk_object_notify_state_change (AtkObject *accessible,
659 AtkState state,
660 gboolean value);
661 void atk_object_initialize (AtkObject *accessible,
662 gpointer data);
664 G_CONST_RETURN gchar* atk_role_get_name (AtkRole role);
665 AtkRole atk_role_for_name (const gchar *name);
668 /* NEW in 1.1: convenience API */
669 gboolean atk_object_add_relationship (AtkObject *object,
670 AtkRelationType relationship,
671 AtkObject *target);
672 gboolean atk_object_remove_relationship (AtkObject *object,
673 AtkRelationType relationship,
674 AtkObject *target);
675 G_CONST_RETURN gchar* atk_role_get_localized_name (AtkRole role);
677 /* */
680 /*
681 * Note: the properties which are registered with the GType
682 * property registry, for type ATK_TYPE_OBJECT, are as follows:
683 *
684 * "accessible-name"
685 * "accessible-description"
686 * "accessible-parent"
687 * "accessible-role"
688 * "accessible-value"
689 * "accessible-component-layer"
690 * "accessible-component-zorder"
691 * "accessible-table-caption"
692 * "accessible-table-column-description"
693 * "accessible-table-column-header"
694 * "accessible-table-row-description"
695 * "accessible-table-row-header"
696 * "accessible-table-summary"
697 * "accessible-model"
698 *
699 * accessibility property change listeners should use the
700 * normal GObject property interfaces and "property-change"
701 * signal handler semantics to interpret the property change
702 * information relayed from AtkObject.
703 * (AtkObject instances will connect to the "notify"
704 * signal in their host objects, and relay the signals when appropriate).
705 */
707 /* For other signals, see related interfaces
708 *
709 * AtkActionIface,
710 * AtkComponentIface,
711 * AtkHypertextIface,
712 * AtkImageIface,
713 * AtkSelectionIface,
714 * AtkTableIface,
715 * AtkTextIface,
716 * AtkValueIface.
717 *
718 * The usage model for obtaining these interface instances is:
719 * ATK_<interfacename>_GET_IFACE(GObject *accessible),
720 * where accessible, though specified as a GObject, is
721 * the AtkObject instance being queried.
722 * More usually, the interface will be used via a cast to the
723 * interface's corresponding "type":
724 *
725 * AtkText textImpl = ATK_TEXT(accessible);
726 * if (textImpl)
727 * {
728 * cpos = atk_text_get_caret_position(textImpl);
729 * }
730 *
731 * If it's known in advance that accessible implements AtkTextIface,
732 * this is shortened to:
733 *
734 * cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
735 */
737 #ifdef __cplusplus
738 }
739 #endif /* __cplusplus */
742 #endif /* __ATK_OBJECT_H__ */
