PHP-GTK
Thursday, July 24, 2014 
download | documentation | applications | faq | changelog | resources 


search for in the  


previousAtkRelation
AtkStatenext

Last updated: Sun, 12 May 2013
view this page in English

AtkRole

Describes the role of an object.

These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= Atk::ROLE_LAST_DEFINED is not necessarily an error.

Value

Symbolic name

Description

  0Atk::ROLE_INVALID Invalid role
  1Atk::ROLE_ACCEL_LABEL A label which represents an accelerator
  2Atk::ROLE_ALERT An object which is an alert to the user
  3Atk::ROLE_ANIMATION An object which is an animated image
  4Atk::ROLE_ARROW An arrow in one of the four cardinal directions
  5Atk::ROLE_CALENDAR An object that displays a calendar and allows the user to select a date
  6Atk::ROLE_CANVAS An object that can be drawn into and is used to trap events
  7Atk::ROLE_CHECK_BOX A choice that can be checked or unchecked and provides a separate indicator for the current state
  8Atk::ROLE_CHECK_MENU_ITEM A menu item with a check box
  9Atk::ROLE_COLOR_CHOOSER A specialized dialog that lets the user choose a color
  10Atk::ROLE_COLUMN_HEADER The header for a column of data
  11Atk::ROLE_COMBO_BOX A list of choices the user can select from
  12Atk::ROLE_DATE_EDITOR An object whose purpose is to allow a user to edit a date
  13Atk::ROLE_DESKTOP_ICON An inconifed internal frame within a DESKTOP_PANE
  14Atk::ROLE_DESKTOP_FRAME A pane that supports internal frames and iconified versions of those internal frames
  15Atk::ROLE_DIAL An object whose purpose is to allow a user to set a value
  16Atk::ROLE_DIALOG A top level window with title bar and a border
  17Atk::ROLE_DIRECTORY_PANE A pane that allows the user to navigate through and select the contents of a directory
  18Atk::ROLE_DRAWING_AREA An object used for drawing custom user interface elements
  19Atk::ROLE_FILE_CHOOSER A specialized dialog that lets the user choose a file
  20Atk::ROLE_FILLER A object that fills up space in a user interface
  21Atk::ROLE_FONT_CHOOSER A specialized dialog that lets the user choose a font
  22Atk::ROLE_FRAME A top level window with a title bar, border, menubar, etc.
  23Atk::ROLE_GLASS_PANE A pane that is guaranteed to be painted on top of all panes beneath it
  24Atk::ROLE_HTML_CONTAINER A document container for HTML, whose children represent the document content
  25Atk::ROLE_ICON A small fixed size picture, typically used to decorate components
  26Atk::ROLE_IMAGE An object whose primary purpose is to display an image
  27Atk::ROLE_INTERNAL_FRAME A frame-like object that is clipped by a desktop pane
  28Atk::ROLE_LABEL An object used to present an icon or short string in an interface
  29Atk::ROLE_LAYERED_PANE A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
  30Atk::ROLE_LIST An object that presents a list of objects to the user and allows the user to select one or more of them
  31Atk::ROLE_LIST_ITEM An object that represents an element of a list
  32Atk::ROLE_MENU An object usually found inside a menu bar that contains a list of actions the user can choose from
  33Atk::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
  34Atk::ROLE_MENU_ITEM An object usually contained in a menu that presents an action the user can choose
  35Atk::ROLE_OPTION_PANE A specialized pane whose primary use is inside a DIALOG
  36Atk::ROLE_PAGE_TAB An object that is a child of a page tab list
  37Atk::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
  38Atk::ROLE_PANEL A generic container that is often used to group objects
  39Atk::ROLE_PASSWORD_TEXT A text object uses for passwords, or other places where the text content is not shown visibly to the user
  40Atk::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
  41Atk::ROLE_PROGRESS_BAR An object used to indicate how much of a task has been completed
  42Atk::ROLE_PUSH_BUTTON An object the user can manipulate to tell the application to do something
  43Atk::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
  44Atk::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
  45Atk::ROLE_ROOT_PANE A specialized pane that has a glass pane and a layered pane as its children
  46Atk::ROLE_ROW_HEADER The header for a row of data
  47Atk::ROLE_SCROLL_BAR An object usually used to allow a user to incrementally view a large amount of data.
  48Atk::ROLE_SCROLL_PANE An object that allows a user to incrementally view a large amount of information
  49Atk::ROLE_SEPARATOR An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
  50Atk::ROLE_SLIDER An object that allows the user to select from a bounded range
  51Atk::ROLE_SPLIT_PANE A specialized panel that presents two other panels at the same time
  52Atk::ROLE_SPIN_BUTTON An object used to get an integer or floating point number from the user
  53Atk::ROLE_STATUSBAR An object which reports messages of minor importance to the user
  54Atk::ROLE_TABLE An object used to represent information in terms of rows and columns
  55Atk::ROLE_TABLE_CELL A cell in a table
  56Atk::ROLE_TABLE_COLUMN_HEADER The header for a column of a table
  57Atk::ROLE_TABLE_ROW_HEADER The header for a row of a table
  58Atk::ROLE_TEAR_OFF_MENU_ITEM A menu item used to tear off and reattach its menu
  59Atk::ROLE_TERMINAL An object that represents an accessible terminal
  60Atk::ROLE_TEXT An object that presents text to the user
  61Atk::ROLE_TOGGLE_BUTTON A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state
  62Atk::ROLE_TOOL_BAR A bar or palette usually composed of push buttons or toggle buttons
  63Atk::ROLE_TOOL_TIP An object that provides information about another object
  64Atk::ROLE_TREE An object used to represent hierarchical information to the user
  65Atk::ROLE_TREE_TABLE An object capable of expanding and collapsing rows as well as showing multiple columns of data
  66Atk::ROLE_UNKNOWN The object contains some Accessible information, but its role is not known
  67Atk::ROLE_VIEWPORT An object usually used in a scroll pane
  68Atk::ROLE_WINDOW A top level window with no title or border.
  69Atk::ROLE_HEADER An object that serves as a document header.
  70Atk::ROLE_FOOTER An object that serves as a document footer.
  71Atk::ROLE_PARAGRAPH An object which is contains a paragraph of text content.
  72Atk::ROLE_RULER An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).
  73Atk::ROLE_APPLICATION The object is an application object, which may contain Atk::ROLE_FRAME objects or other types of accessibles.
  74Atk::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.
  75Atk::ROLE_EDITBAR The object is an editable text object in a toolbar
  76Atk::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.
  77Atk::ROLE_LAST_DEFINED not a valid role, used for finding end of enumeration

User Contributed Notes
atk.enum.role.php
add a note about notes
There are no user contributed notes for this page.


previousAtkRelation
AtkStatenext

Last updated: Sun, 12 May 2013
view this page in English


credits 

PHP  Copyright © 2001-2014 The PHP Group
 All rights reserved.
Last updated: Sun May 12 20:50:55 2013 CEST