Object Roles

[This is preliminary documentation and subject to change.]

The following values (defined in oleacc.h) describe the role of objects within an application.

ROLE_SYSTEM_ALERT
This is an alert object. This role should be used only for objects that embody an alert but are not associated with another object such as a graphic, text, or sound.
ROLE_SYSTEM_APPLICATION
This object appears to the user as a main window for an application.
ROLE_SYSTEM_BORDER
This object is a window border; because of implementation constraints, the entire border is represented by a single object, rather than by separate objects for each side.
ROLE_SYSTEM_BUTTONDROPDOWN
This object is a button that drops down a list of items.
ROLE_SYSTEM_BUTTONDROPDOWNGRID
This object is a button that drops down a grid.
ROLE_SYSTEM_BUTTONMENU
This object is a button that drops down a menu.
ROLE_SYSTEM_CARET
This is the system object for the caret.
ROLE_SYSTEM_CELL
This object is a cell within a table.
ROLE_SYSTEM_CHARACTER
This object is a social interaction character or agent.
ROLE_SYSTEM_CHART
This object is a graphical image used to represent data.
ROLE_SYSTEM_CHECKBUTTON
This object appears to the user to function as a check box control; that is, an option that can be turned on or off independently of other options.
ROLE_SYSTEM_CLIENT
This object is a window's client area.
ROLE_SYSTEM_COLUMN
This object is a column of cells within a table.
ROLE_SYSTEM_COLUMNHEADER
This object appears to the user to function as a column header, providing a visual label for a column in a table, and might allow the user to select or adjust values for the entire column.
ROLE_SYSTEM_COMBOBOX
This object appears to the user to function as a combo box; that is, a text box with an associated list box, which can be dropped, or not.
ROLE_SYSTEM_CURSOR
This is the system object for the mouse pointer.
ROLE_SYSTEM_DIAL
This object appears to the user as a dial or knob. This can be a read-only object as well, showing a value like a speedometer.
ROLE_SYSTEM_DIALOG
This object appears to the user to function as a dialog box or message box.
ROLE_SYSTEM_DOCUMENT
This object appears to the user as a document window. A document window is always contained within an application window. This applies only to multiple-document interface (MDI) windows and refers to the object that contains the MDI title bar, and so on.
ROLE_SYSTEM_DROPLIST
This object appears to the user to function as a drop-down list box; that is, it shows one item and allows the user to display and select another from a list of alternative values.
ROLE_SYSTEM_GRAPHIC
This object appears to the user as a picture.
ROLE_SYSTEM_GRIP
This object is a mouse pointer target that, when activated, causes something to happen for as long as the target is activated. For example, in Windows 95, the user can click and drag around a sizing grip in the lower-right corner of each window, thus resizing the window.
ROLE_SYSTEM_GROUPING
This object logically groups other objects. There might or might not be a parent-child relationship between the grouping object and the objects it contains.
ROLE_SYSTEM_HELP
This is an object that displays Help in the form of a ToolTip, quick tip or Help balloon.
ROLE_SYSTEM_HOTKEYFIELD
This object appears to the user to function as a hot-key field; that is, it allows the user to enter a combination or sequence of keystrokes, which are then described by the hot-key field.
ROLE_SYSTEM_LINK
This object is a link to something else. This object might look like text or a graphic, but acts like a button.
ROLE_SYSTEM_LIST
This object appears to the user to function as a list box, allowing the user to choose between one or more choices.
ROLE_SYSTEM_LISTITEM
This object functions as an item in a list box or the list portion of a combo box, drop-down list box, or drop-down combo box.
ROLE_SYSTEM_MENUBAR
This is the menu "bar" usually located under the title bar.
ROLE_SYSTEM_MENUITEM
This object appears to the user to function as a menu item; that is, an entry in a menu that the user can choose to carry out a command, select an option, or display another menu. (Functionally, a menu item can be equivalent to a push button, radio button, check box, or menu.)
ROLE_SYSTEM_MENUPOPUP
This object appears to the user to function as a menu; that is, a window that can appear or disappear depending on some user action, and which displays a list of choices.
ROLE_SYSTEM_OUTLINE
This object appears to the user to function as an outline or tree structure, possibly allowing the user to expand and collapse branches.
ROLE_SYSTEM_OUTLINEITEM
This object is an item in an outline or tree.
ROLE_SYSTEM_PAGETAB
This object appears to the user to function as a page tab. Normally the only child of a pagetab control is a ROLE_SYSTEM_GROUPING object that contains the contents of the associated page.
ROLE_SYSTEM_PANE
This object appears to the user to act as a pane within a frame or document window. These objects are areas of a window that have separate contents from other areas of the window. Additionally, users can navigate between panes and within the contents of the current pane, but cannot magically navigate between items in different panes. Thus, panes represent a level of grouping lower than frame windows or documents, but above individual controls. Typically the user navigates between panes by pressing TAB, f6, or ctrl+tab, depending on the context.
ROLE_SYSTEM_PROGRESSBAR
This object appears to the user to function as a progress bar, dynamically showing the user the percent complete of an operation in progress. This control usually takes no user input.
ROLE_SYSTEM_PUSHBUTTON
This object appears to the user to function as a push button control.
ROLE_SYSTEM_RADIOBUTTON
This object appears to the user to function as an option button (also called a radio button); that is, one of a group of mutually exclusive options. All objects sharing a single parent that have this attribute are assumed to be part of single mutually exclusive group; You can use ROLE_SYSTEM_GROUPING objects to divide them into separate groups when necessary.
ROLE_SYSTEM_ROW
This object is a row of cells within a table.
ROLE_SYSTEM_ROWHEADER
This object appears to the user to function as a row header, providing a visual label for a table row, and might allow the user to select or adjust values for the entire row.
ROLE_SYSTEM_SCROLLBAR
This object is a vertical or horizontal scroll bar, either part of the client area or used in a control.
ROLE_SYSTEM_SEPARATOR
This is any object used to visually divide a space into two regions, such as a separator menu item or a bar dividing split panes within a window.
ROLE_SYSTEM_SLIDER
This object appears to the user to function as a slider, allowing the user to adjust a setting in given increments between given minimum and maximum values.
ROLE_SYSTEM_SOUND
This object is a system sound, associated with various system events.
ROLE_SYSTEM_SPINBUTTON
This object appears to the user to function as a spin box; that is, a control that allows the user to select next and previous (or "higher" and "lower") values from a list of appropriate values. The value can be displayed in a separate control ("buddy control") associated with the spin box.
ROLE_SYSTEM_STATICTEXT
This object appears to the user as static text. You cannot modify or select static text.
ROLE_SYSTEM_STATUSBAR
This object appears to the user to function as a status bar; that is, an area that displays information about the current operation, state of the application, or selected object. The status bar can have multiple fields, and can show different sets of one or more values.
ROLE_SYSTEM_TABLE
This object is a table containing rows and columns of cells, and optionally row headers and column headers.
ROLE_SYSTEM_TEXT
This object appears to the user as text that can be selected. It can be editable or read-only.
ROLE_SYSTEM_TITLEBAR
This object is a title or caption bar for the application.
ROLE_SYSTEM_TOOLBAR
This object appears to the user to function as a toolbar; that is, a grouping of controls that remains visible on the screen or within a window.
ROLE_SYSTEM_WINDOW
This object is the window frame, which usually consists of child objects such as a title bar, client, and so on.