Xfce Foundation Classes

Main Page  | Index |  Namespace List  |  Alphabetical List  |  Class List  |  File List

libXFCui/xfc/atk/object.hh File Reference

An AtkObject C++ wrapper interface. More...

#include <xfc/glib/object.hh>
#include <xfc/atk/util.hh>
#include <atk/atkobject.h>
#include <xfc/atk/inline/object.inl>

Namespaces

• namespace Xfc
• namespace Xfc::Atk

Classes

• class Xfc::Atk::Object

  An AtkObject C++ wrapper class. More...
  

Role Methods

• Role role_register (const String &name)

  Registers the role specified by name.
  

• String role_get_name (Role role)

  Gets the description string describing the Role role.
  

• String role_get_localized_name (Role role)

  Gets the localized description string describing the Role role.
  

• Role role_for_name (const String &name)

  Get the Role type corresponding to a role name.
  

Enumerations

• enum Role {
    ROLE_INVALID = ATK_ROLE_INVALID,
    ROLE_ACCEL_LABEL = ATK_ROLE_ACCEL_LABEL,
    ROLE_ALERT = ATK_ROLE_ALERT,
    ROLE_ANIMATION = ATK_ROLE_ANIMATION,
    ROLE_ARROW = ATK_ROLE_ARROW,
    ROLE_CALENDAR = ATK_ROLE_CALENDAR,
    ROLE_CANVAS = ATK_ROLE_CANVAS,
    ROLE_CHECK_BOX = ATK_ROLE_CHECK_BOX,
    ROLE_CHECK_MENU_ITEM = ATK_ROLE_CHECK_MENU_ITEM,
    ROLE_COLOR_CHOOSER = ATK_ROLE_COLOR_CHOOSER,
    ROLE_COLUMN_HEADER = ATK_ROLE_COLUMN_HEADER,
    ROLE_COMBO_BOX = ATK_ROLE_COMBO_BOX,
    ROLE_DATE_EDITOR = ATK_ROLE_DATE_EDITOR,
    ROLE_DESKTOP_ICON = ATK_ROLE_DESKTOP_ICON,
    ROLE_DESKTOP_FRAME = ATK_ROLE_DESKTOP_FRAME,
    ROLE_DIAL = ATK_ROLE_DIAL,
    ROLE_DIALOG = ATK_ROLE_DIALOG,
    ROLE_DIRECTORY_PANE = ATK_ROLE_DIRECTORY_PANE,
    ROLE_DRAWING_AREA = ATK_ROLE_DRAWING_AREA,
    ROLE_FILE_CHOOSER = ATK_ROLE_FILE_CHOOSER,
    ROLE_FILLER = ATK_ROLE_FILLER,
    ROLE_FONT_CHOOSER = ATK_ROLE_FONT_CHOOSER,
    ROLE_FRAME = ATK_ROLE_FRAME,
    ROLE_GLASS_PANE = ATK_ROLE_GLASS_PANE,
    ROLE_HTML_CONTAINER = ATK_ROLE_HTML_CONTAINER,
    ROLE_ICON = ATK_ROLE_ICON,
    ROLE_IMAGE = ATK_ROLE_IMAGE,
    ROLE_INTERNAL_FRAME = ATK_ROLE_INTERNAL_FRAME,
    ROLE_LABEL = ATK_ROLE_LABEL,
    ROLE_LAYERED_PANE = ATK_ROLE_LAYERED_PANE,
    ROLE_LIST = ATK_ROLE_LIST,
    ROLE_LIST_ITEM = ATK_ROLE_LIST_ITEM,
    ROLE_MENU = ATK_ROLE_MENU,
    ROLE_MENU_BAR = ATK_ROLE_MENU_BAR,
    ROLE_MENU_ITEM = ATK_ROLE_MENU_ITEM,
    ROLE_OPTION_PANE = ATK_ROLE_OPTION_PANE,
    ROLE_PAGE_TAB = ATK_ROLE_PAGE_TAB,
    ROLE_PAGE_TAB_LIST = ATK_ROLE_PAGE_TAB_LIST,
    ROLE_PANEL = ATK_ROLE_PANEL,
    ROLE_PASSWORD_TEXT = ATK_ROLE_PASSWORD_TEXT,
    ROLE_POPUP_MENU = ATK_ROLE_POPUP_MENU,
    ROLE_PROGRESS_BAR = ATK_ROLE_PROGRESS_BAR,
    ROLE_PUSH_BUTTON = ATK_ROLE_PUSH_BUTTON,
    ROLE_RADIO_BUTTON = ATK_ROLE_RADIO_BUTTON,
    ROLE_RADIO_MENU_ITEM = ATK_ROLE_RADIO_MENU_ITEM,
    ROLE_ROOT_PANE = ATK_ROLE_ROOT_PANE,
    ROLE_ROW_HEADER = ATK_ROLE_ROW_HEADER,
    ROLE_SCROLL_BAR = ATK_ROLE_SCROLL_BAR,
    ROLE_SCROLL_PANE = ATK_ROLE_SCROLL_PANE,
    ROLE_SEPARATOR = ATK_ROLE_SEPARATOR,
    ROLE_SLIDER = ATK_ROLE_SLIDER,
    ROLE_SPLIT_PANE = ATK_ROLE_SPLIT_PANE,
    ROLE_SPIN_BUTTON = ATK_ROLE_SPIN_BUTTON,
    ROLE_STATUSBAR = ATK_ROLE_STATUSBAR,
    ROLE_TABLE = ATK_ROLE_TABLE,
    ROLE_TABLE_CELL = ATK_ROLE_TABLE_CELL,
    ROLE_TABLE_COLUMN_HEADER = ATK_ROLE_TABLE_COLUMN_HEADER,
    ROLE_TABLE_ROW_HEADER = ATK_ROLE_TABLE_ROW_HEADER,
    ROLE_TEAR_OFF_MENU_ITEM = ATK_ROLE_TEAR_OFF_MENU_ITEM,
    ROLE_TERMINAL = ATK_ROLE_TERMINAL,
    ROLE_TEXT = ATK_ROLE_TEXT,
    ROLE_TOGGLE_BUTTON = ATK_ROLE_TOGGLE_BUTTON,
    ROLE_TOOL_BAR = ATK_ROLE_TOOL_BAR,
    ROLE_TOOL_TIP = ATK_ROLE_TOOL_TIP,
    ROLE_TREE = ATK_ROLE_TREE,
    ROLE_TREE_TABLE = ATK_ROLE_TREE_TABLE,
    ROLE_UNKNOWN = ATK_ROLE_UNKNOWN,
    ROLE_VIEWPORT = ATK_ROLE_VIEWPORT,
    ROLE_WINDOW = ATK_ROLE_WINDOW,
    ROLE_HEADER = ATK_ROLE_HEADER,
    ROLE_FOOTER = ATK_ROLE_FOOTER,
    ROLE_PARAGRAPH = ATK_ROLE_PARAGRAPH,
    ROLE_RULER = ATK_ROLE_RULER,
    ROLE_APPLICATION = ATK_ROLE_APPLICATION,
    ROLE_AUTOCOMPLETE = ATK_ROLE_AUTOCOMPLETE,
    ROLE_EDITBAR = ATK_ROLE_EDITBAR,
    ROLE_LAST_DEFINED = ATK_ROLE_LAST_DEFINED
  }

  Describes the role of an object. More...
  

---

Detailed Description

An AtkObject C++ wrapper interface.

Provides Object, the base object class for the Accessibility Toolkit API.

---

Enumeration Type Documentation

enum Role

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

---

Function Documentation

Role role_for_name (  const String &  name  )

Get the Role type corresponding to a role name. Parameters: name  A string which is the (non-localized) name of an ATK role. Returns: The Role type corresponding to the specified name, or ROLE_INVALID if no matching role is found.

String role_get_localized_name (  Role  role  )

Gets the localized description string describing the Role role. Parameters: role  The Role whose localized name is required. Returns: A localized string describing the role.

String role_get_name (  Role  role  )

Gets the description string describing the Role role. Parameters: role  The Role whose name is required. Returns: A string describing the role.

Role role_register (  const String &  name  )

Registers the role specified by name. Parameters: name  A character string describing the new role. Returns: A Role for the new role.

---

Copyright © 2004-2005 The XFC Development Team

XFC 4.3