X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=cspi%2Fspi-roletypes.h;h=2453509e6fb37f6b03c070a5fb9bb0280a0627f1;hb=bd703dfccbb700770f4629e5b5a8af45c3a8dfc3;hp=dc67504220de9071fbf256f71969aac29ffe3ef7;hpb=44cda12c55b26bc02ecc77b4cf07f03093f14a4c;p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git diff --git a/cspi/spi-roletypes.h b/cspi/spi-roletypes.h index dc67504..2453509 100644 --- a/cspi/spi-roletypes.h +++ b/cspi/spi-roletypes.h @@ -1,33 +1,71 @@ +/* + * AT-SPI - Assistive Technology Service Provider Interface + * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap) + * + * Copyright 2001, 2002 Sun Microsystems Inc., + * Copyright 2001, 2002 Ximian, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with this library; if not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + #ifndef _SPI_ROLETYPES_H_ #define _SPI_ROLETYPES_H_ +#ifdef __cplusplus +extern "C" { +#endif + /** * AccessibleRole: * @SPI_ROLE_INVALID: role is not legal, something is wrong with this object + * @SPI_ROLE_ACCEL_LABEL: object is a label indicating keyboard + * accelerators for the parent * @SPI_ROLE_ALERT: Object is used to alert the user about something + * @SPI_ROLE_ANIMATION: Object contains a dynamic or moving image + * @SPI_ROLE_ARROW: Object is a 2d directional indicator + * @SPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged into + * a 2d list * @SPI_ROLE_CANVAS: Object that can be drawn into and is used to trap events * @SPI_ROLE_CHECK_BOX: Object representd a choice that can be checked or unchecked * and provides a separate indicator for the current state. + * @SPI_ROLE_CHECK_MENU_ITEM: Object is a menu item that behaves like a CHECK_BOX * @SPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color. * @SPI_ROLE_COLUMN_HEADER: The header for a column of data * @SPI_ROLE_COMBO_BOX: A list of choices the user can select from - * @SPI_ROLE_SPI_DESKTOP_ICON: An inconifed internal frame within a SPI_DESKTOP_PANE - * @SPI_ROLE_SPI_DESKTOP_FRAME: A pane that supports internal frames and + * @SPI_ROLE_DATE_EDITOR: Allows entry of a date + * @SPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE + * @SPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and * iconified versions of those internal frames. + * @SPI_ROLE_DIAL: A rotating/rotatable valuator * @SPI_ROLE_DIALOG: A top level window with title bar and a border * @SPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate * through and select the contents of a directory. + * @SPI_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements * @SPI_ROLE_FILE_CHOOSER: A specialized dialog that displays the files in the * directory and lets the user select a file, browse a different * directory, or specify a filename. * @SPI_ROLE_FILLER: A object that fills up space in a user interface - * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this. + * @SPI_ROLE_FONT_CHOOSER: Allows selection of a display font * @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc. * @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all * panes beneath it * @SPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children * represent the document content. * @SPI_ROLE_ICON: A small fixed size picture, typically used to decorate components. + * @SPI_ROLE_IMAGE: An image, typically static * @SPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane. * @SPI_ROLE_LABEL: An object used to present an icon or short string in an interface * @SPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers @@ -55,6 +93,8 @@ * the application to do something. * @SPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the * same group to become uncghecked when this one is checked. + * @SPI_ROLE_RADIO_MENU_ITEM: A specialized menu item that behaves like a + * radio button. * @SPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its * children. * @SPI_ROLE_ROW_HEADER: The header for a row of data @@ -65,44 +105,85 @@ * @SPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and * logical separation of the contents in a menu. * @SPI_ROLE_SLIDER: An object that allows the user to select from a bounded range. + * @SPI_ROLE_SPIN_BUTTON: An object which allows selection from a set of choices and + * displays the current choice. * @SPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time. + * @SPI_ROLE_STATUS_BAR: An object the display qualitative status information. c.f. PROGRESS_BAR * @SPI_ROLE_TABLE: An object used to rpesent information in terms of rows and columns. * @SPI_ROLE_TABLE_CELL: An object which is a descendant of a table, * with a row/column location. A cell may span multiple rows and columns. * @SPI_ROLE_TABLE_COLUMN_HEADER: An object which serves to describe a column in a table. * @SPI_ROLE_TABLE_ROW_HEADER: An object which serves to label or describe a row in a table. + * @SPI_ROLE_TEAROFF_MENU_ITEM: A menu item which allows the menu to be removed from + * a menubar and placed in its own window + * @SPI_ROLE_TERMINAL: An object that emulates a teletype or terminal * @SPI_ROLE_TEXT: An object that presents text to the user * @SPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, * but does not provide a separate indicator for the current state. * @SPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons * @SPI_ROLE_TOOL_TIP: An object that provides information about another object - * @SPI_ROLE_TREE: An object used to repsent hierarchical information to the user. + * @SPI_ROLE_TREE: An object used to represent hierarchical information to the user + * @SPI_ROLE_TREE_TABLE: An object which represents both hierarchical and tabular information * @SPI_ROLE_UNKNOWN: The object contains some SpiAccessible information, but its role is * not known. * @SPI_ROLE_VIEWPORT: An object usually used in a scroll pane, which restricts the visual * area into which its contents are presented. * @SPI_ROLE_WINDOW: A top level window with no title or border. + * @SPI_ROLE_EXTENDED: This object's role is not included in the standard role list and + * should be queried by name. + * @SPI_ROLE_HEADER: An object that serves as a document header. + * @SPI_ROLE_FOOTER: An object that serves as a document footer. + * @SPI_ROLE_PARAGRAPH: An object which is contains a paragraph of text content. + * @SPI_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects + * which it controls (should have CONTROLLER_FOR relation to such). + * @SPI_ROLE_APPLICATION: An object which corresponds to a desktop application, + * which may have children of @SPI_ROLE_FRAME or other type. + * @SPI_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. + * @SPI_ROLE_EDITBAR: The object is an editable text object in a toolbar + * @SPI_ROLE_EMBEDDED: The object is an embedded component container. + * This role is a "grouping" hint that the contained + * objects share a context which is different from the + * container in which this accessible is embedded. + * Uses: document embedding, "panel applets", etc. + * @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration. + * + * Describes the role of an object + * + * These are the built-in enumerated roles that UI components can have. + * Other roles may be added at runtime, so an AccessibleRole >= + * SPI_ROLE_LAST_DEFINED is not necessarily an error. **/ typedef enum { SPI_ROLE_INVALID, + SPI_ROLE_ACCEL_LABEL, SPI_ROLE_ALERT, + SPI_ROLE_ANIMATION, + SPI_ROLE_ARROW, + SPI_ROLE_CALENDAR, SPI_ROLE_CANVAS, SPI_ROLE_CHECK_BOX, + SPI_ROLE_CHECK_MENU_ITEM, SPI_ROLE_COLOR_CHOOSER, SPI_ROLE_COLUMN_HEADER, SPI_ROLE_COMBO_BOX, - SPI_ROLE_SPI_DESKTOP_ICON, - SPI_ROLE_SPI_DESKTOP_FRAME, + SPI_ROLE_DATE_EDITOR, + SPI_ROLE_DESKTOP_ICON, + SPI_ROLE_DESKTOP_FRAME, + SPI_ROLE_DIAL, SPI_ROLE_DIALOG, SPI_ROLE_DIRECTORY_PANE, + SPI_ROLE_DRAWING_AREA, SPI_ROLE_FILE_CHOOSER, SPI_ROLE_FILLER, - SPI_ROLE_FOCUS_TRAVERSABLE, + SPI_ROLE_FONT_CHOOSER, SPI_ROLE_FRAME, SPI_ROLE_GLASS_PANE, SPI_ROLE_HTML_CONTAINER, SPI_ROLE_ICON, + SPI_ROLE_IMAGE, SPI_ROLE_INTERNAL_FRAME, SPI_ROLE_LABEL, SPI_ROLE_LAYERED_PANE, @@ -120,28 +201,47 @@ typedef enum SPI_ROLE_PROGRESS_BAR, SPI_ROLE_PUSH_BUTTON, SPI_ROLE_RADIO_BUTTON, + SPI_ROLE_RADIO_MENU_ITEM, SPI_ROLE_ROOT_PANE, SPI_ROLE_ROW_HEADER, SPI_ROLE_SCROLL_BAR, SPI_ROLE_SCROLL_PANE, SPI_ROLE_SEPARATOR, SPI_ROLE_SLIDER, + SPI_ROLE_SPIN_BUTTON, SPI_ROLE_SPLIT_PANE, + SPI_ROLE_STATUS_BAR, SPI_ROLE_TABLE, SPI_ROLE_TABLE_CELL, SPI_ROLE_TABLE_COLUMN_HEADER, SPI_ROLE_TABLE_ROW_HEADER, + SPI_ROLE_TEAROFF_MENU_ITEM, + SPI_ROLE_TERMINAL, SPI_ROLE_TEXT, SPI_ROLE_TOGGLE_BUTTON, SPI_ROLE_TOOL_BAR, SPI_ROLE_TOOL_TIP, SPI_ROLE_TREE, + SPI_ROLE_TREE_TABLE, SPI_ROLE_UNKNOWN, SPI_ROLE_VIEWPORT, SPI_ROLE_WINDOW, + SPI_ROLE_EXTENDED, + SPI_ROLE_HEADER, + SPI_ROLE_FOOTER, + SPI_ROLE_PARAGRAPH, + SPI_ROLE_RULER, + SPI_ROLE_APPLICATION, + SPI_ROLE_AUTOCOMPLETE, + SPI_ROLE_EDITBAR, + SPI_ROLE_EMBEDDED, SPI_ROLE_LAST_DEFINED } AccessibleRole; char* AccessibleRole_getName (AccessibleRole role); +#ifdef __cplusplus +} +#endif + #endif