GNOME.org
Enumerations
atkmm Enums and Flags

Enumerations

enum  Atk::CoordType {

  Atk::CoordType::SCREEN,

  Atk::CoordType::WINDOW,

  Atk::CoordType::PARENT

}
 Specifies how xy coordinates are to be interpreted. More...

 
enum  Atk::Layer {

  Atk::Layer::INVALID,

  Atk::Layer::BACKGROUND,

  Atk::Layer::CANVAS,

  Atk::Layer::WIDGET,

  Atk::Layer::MDI,

  Atk::Layer::POPUP,

  Atk::Layer::OVERLAY,

  Atk::Layer::WINDOW

}
 Describes the layer of a component. More...

 
enum  Atk::Role {

  Atk::Role::INVALID,

  Atk::Role::ACCEL_LABEL,

  Atk::Role::ALERT,

  Atk::Role::ANIMATION,

  Atk::Role::ARROW,

  Atk::Role::CALENDAR,

  Atk::Role::CANVAS,

  Atk::Role::CHECK_BOX,

  Atk::Role::CHECK_MENU_ITEM,

  Atk::Role::COLOR_CHOOSER,

  Atk::Role::COLUMN_HEADER,

  Atk::Role::COMBO_BOX,

  Atk::Role::DATE_EDITOR,

  Atk::Role::DESKTOP_ICON,

  Atk::Role::DESKTOP_FRAME,

  Atk::Role::DIAL,

  Atk::Role::DIALOG,

  Atk::Role::DIRECTORY_PANE,

  Atk::Role::DRAWING_AREA,

  Atk::Role::FILE_CHOOSER,

  Atk::Role::FILLER,

  Atk::Role::FONT_CHOOSER,

  Atk::Role::FRAME,

  Atk::Role::GLASS_PANE,

  Atk::Role::HTML_CONTAINER,

  Atk::Role::ICON,

  Atk::Role::IMAGE,

  Atk::Role::INTERNAL_FRAME,

  Atk::Role::LABEL,

  Atk::Role::LAYERED_PANE,

  Atk::Role::LIST,

  Atk::Role::LIST_ITEM,

  Atk::Role::MENU,

  Atk::Role::MENU_BAR,

  Atk::Role::MENU_ITEM,

  Atk::Role::OPTION_PANE,

  Atk::Role::PAGE_TAB,

  Atk::Role::PAGE_TAB_LIST,

  Atk::Role::PANEL,

  Atk::Role::PASSWORD_TEXT,

  Atk::Role::POPUP_MENU,

  Atk::Role::PROGRESS_BAR,

  Atk::Role::PUSH_BUTTON,

  Atk::Role::RADIO_BUTTON,

  Atk::Role::RADIO_MENU_ITEM,

  Atk::Role::ROOT_PANE,

  Atk::Role::ROW_HEADER,

  Atk::Role::SCROLL_BAR,

  Atk::Role::SCROLL_PANE,

  Atk::Role::SEPARATOR,

  Atk::Role::SLIDER,

  Atk::Role::SPLIT_PANE,

  Atk::Role::SPIN_BUTTON,

  Atk::Role::STATUSBAR,

  Atk::Role::TABLE,

  Atk::Role::TABLE_CELL,

  Atk::Role::TABLE_COLUMN_HEADER,

  Atk::Role::TABLE_ROW_HEADER,

  Atk::Role::TEAR_OFF_MENU_ITEM,

  Atk::Role::TERMINAL,

  Atk::Role::TEXT,

  Atk::Role::TOGGLE_BUTTON,

  Atk::Role::TOOL_BAR,

  Atk::Role::TOOL_TIP,

  Atk::Role::TREE,

  Atk::Role::TREE_TABLE,

  Atk::Role::UNKNOWN,

  Atk::Role::VIEWPORT,

  Atk::Role::WINDOW,

  Atk::Role::HEADER,

  Atk::Role::FOOTER,

  Atk::Role::PARAGRAPH,

  Atk::Role::RULER,

  Atk::Role::APPLICATION,

  Atk::Role::AUTOCOMPLETE,

  Atk::Role::EDITBAR,

  Atk::Role::EMBEDDED,

  Atk::Role::ENTRY,

  Atk::Role::CHART,

  Atk::Role::CAPTION,

  Atk::Role::DOCUMENT_FRAME,

  Atk::Role::HEADING,

  Atk::Role::PAGE,

  Atk::Role::SECTION,

  Atk::Role::REDUNDANT_OBJECT,

  Atk::Role::FORM,

  Atk::Role::LINK,

  Atk::Role::INPUT_METHOD_WINDOW,

  Atk::Role::TABLE_ROW,

  Atk::Role::TREE_ITEM,

  Atk::Role::DOCUMENT_SPREADSHEET,

  Atk::Role::DOCUMENT_PRESENTATION,

  Atk::Role::DOCUMENT_TEXT,

  Atk::Role::DOCUMENT_WEB,

  Atk::Role::DOCUMENT_EMAIL,

  Atk::Role::COMMENT,

  Atk::Role::LIST_BOX,

  Atk::Role::GROUPING,

  Atk::Role::IMAGE_MAP,

  Atk::Role::NOTIFICATION,

  Atk::Role::INFO_BAR,

  Atk::Role::LEVEL_BAR,

  Atk::Role::TITLE_BAR,

  Atk::Role::BLOCK_QUOTE,

  Atk::Role::AUDIO,

  Atk::Role::VIDEO,

  Atk::Role::DEFINITION,

  Atk::Role::ARTICLE,

  Atk::Role::LANDMARK,

  Atk::Role::LOG,

  Atk::Role::MARQUEE,

  Atk::Role::MATH,

  Atk::Role::RATING,

  Atk::Role::TIMER,

  Atk::Role::DESCRIPTION_LIST,

  Atk::Role::DESCRIPTION_TERM,

  Atk::Role::DESCRIPTION_VALUE,

  Atk::Role::STATIC,

  Atk::Role::MATH_FRACTION,

  Atk::Role::MATH_ROOT,

  Atk::Role::SUBSCRIPT,

  Atk::Role::SUPERSCRIPT,

  Atk::Role::FOOTNOTE,

  Atk::Role::CONTENT_DELETION,

  Atk::Role::CONTENT_INSERTION,

  Atk::Role::MARK,

  Atk::Role::SUGGESTION,

  Atk::Role::LAST_DEFINED

}
 Describes the role of an object. More...

 
enum  Atk::Relation::Type {

  Atk::Relation::Type::NONE,

  Atk::Relation::Type::CONTROLLED_BY,

  Atk::Relation::Type::CONTROLLER_FOR,

  Atk::Relation::Type::LABEL_FOR,

  Atk::Relation::Type::LABELLED_BY,

  Atk::Relation::Type::MEMBER_OF,

  Atk::Relation::Type::NODE_CHILD_OF,

  Atk::Relation::Type::FLOWS_TO,

  Atk::Relation::Type::FLOWS_FROM,

  Atk::Relation::Type::SUBWINDOW_OF,

  Atk::Relation::Type::EMBEDS,

  Atk::Relation::Type::EMBEDDED_BY,

  Atk::Relation::Type::POPUP_FOR,

  Atk::Relation::Type::PARENT_WINDOW_OF,

  Atk::Relation::Type::DESCRIBED_BY,

  Atk::Relation::Type::DESCRIPTION_FOR,

  Atk::Relation::Type::NODE_PARENT_OF,

  Atk::Relation::Type::DETAILS,

  Atk::Relation::Type::DETAILS_FOR,

  Atk::Relation::Type::ERROR_MESSAGE,

  Atk::Relation::Type::ERROR_FOR,

  Atk::Relation::Type::LAST_DEFINED

}
 Describes the type of the relation. More...

 
enum  Atk::StateType {

  Atk::StateType::INVALID,

  Atk::StateType::ACTIVE,

  Atk::StateType::ARMED,

  Atk::StateType::BUSY,

  Atk::StateType::CHECKED,

  Atk::StateType::DEFUNCT,

  Atk::StateType::EDITABLE,

  Atk::StateType::ENABLED,

  Atk::StateType::EXPANDABLE,

  Atk::StateType::EXPANDED,

  Atk::StateType::FOCUSABLE,

  Atk::StateType::FOCUSED,

  Atk::StateType::HORIZONTAL,

  Atk::StateType::ICONIFIED,

  Atk::StateType::MODAL,

  Atk::StateType::MULTI_LINE,

  Atk::StateType::MULTISELECTABLE,

  Atk::StateType::OPAQUE,

  Atk::StateType::PRESSED,

  Atk::StateType::RESIZABLE,

  Atk::StateType::SELECTABLE,

  Atk::StateType::SELECTED,

  Atk::StateType::SENSITIVE,

  Atk::StateType::SHOWING,

  Atk::StateType::SINGLE_LINE,

  Atk::StateType::STALE,

  Atk::StateType::TRANSIENT,

  Atk::StateType::VERTICAL,

  Atk::StateType::VISIBLE,

  Atk::StateType::MANAGES_DESCENDANTS,

  Atk::StateType::INDETERMINATE,

  Atk::StateType::TRUNCATED,

  Atk::StateType::REQUIRED,

  Atk::StateType::INVALID_ENTRY,

  Atk::StateType::SUPPORTS_AUTOCOMPLETION,

  Atk::StateType::SELECTABLE_TEXT,

  Atk::StateType::DEFAULT,

  Atk::StateType::ANIMATED,

  Atk::StateType::VISITED,

  Atk::StateType::CHECKABLE,

  Atk::StateType::HAS_POPUP,

  Atk::StateType::HAS_TOOLTIP,

  Atk::StateType::READ_ONLY,

  Atk::StateType::LAST_DEFINED

}
 The possible types of states of an object. More...

 
enum  Atk::BuiltinTextAttribute {

  Atk::BuiltinTextAttribute::INVALID,

  Atk::BuiltinTextAttribute::LEFT_MARGIN,

  Atk::BuiltinTextAttribute::RIGHT_MARGIN,

  Atk::BuiltinTextAttribute::INDENT,

  Atk::BuiltinTextAttribute::INVISIBLE,

  Atk::BuiltinTextAttribute::EDITABLE,

  Atk::BuiltinTextAttribute::PIXELS_ABOVE_LINES,

  Atk::BuiltinTextAttribute::PIXELS_BELOW_LINES,

  Atk::BuiltinTextAttribute::PIXELS_INSIDE_WRAP,

  Atk::BuiltinTextAttribute::BG_FULL_HEIGHT,

  Atk::BuiltinTextAttribute::RISE,

  Atk::BuiltinTextAttribute::UNDERLINE,

  Atk::BuiltinTextAttribute::STRIKETHROUGH,

  Atk::BuiltinTextAttribute::SIZE,

  Atk::BuiltinTextAttribute::SCALE,

  Atk::BuiltinTextAttribute::WEIGHT,

  Atk::BuiltinTextAttribute::LANGUAGE,

  Atk::BuiltinTextAttribute::FAMILY_NAME,

  Atk::BuiltinTextAttribute::BG_COLOR,

  Atk::BuiltinTextAttribute::FG_COLOR,

  Atk::BuiltinTextAttribute::BG_STIPPLE,

  Atk::BuiltinTextAttribute::FG_STIPPLE,

  Atk::BuiltinTextAttribute::WRAP_MODE,

  Atk::BuiltinTextAttribute::DIRECTION,

  Atk::BuiltinTextAttribute::JUSTIFICATION,

  Atk::BuiltinTextAttribute::STRETCH,

  Atk::BuiltinTextAttribute::VARIANT,

  Atk::BuiltinTextAttribute::STYLE,

  Atk::BuiltinTextAttribute::TEXT_POSITION,

  Atk::BuiltinTextAttribute::LAST_DEFINED

}
 Describes the text attributes supported. More...

 
enum  Atk::Text::ClipType {

  Atk::Text::ClipType::NONE,

  Atk::Text::ClipType::MIN,

  Atk::Text::ClipType::MAX,

  Atk::Text::ClipType::BOTH

}
 Describes the type of clipping required. More...

 
enum  Atk::Text::Granularity {

  Atk::Text::Granularity::CHAR,

  Atk::Text::Granularity::WORD,

  Atk::Text::Granularity::SENTENCE,

  Atk::Text::Granularity::LINE,

  Atk::Text::Granularity::PARAGRAPH

}
 Text granularity types used for specifying the granularity of the region of text we are interested in. More...

 

Detailed Description

Enumeration Type Documentation

enum Atk::BuiltinTextAttribute
strong

Describes the text attributes supported.

Enumerator
INVALID 
LEFT_MARGIN 

The pixel width of the left margin.

RIGHT_MARGIN 

The pixel width of the right margin.

INDENT 

The number of pixels that the text is indented.

INVISIBLE 

Either "true" or "false" indicating whether text is visible or not.

EDITABLE 
PIXELS_ABOVE_LINES 

Pixels of blank space to leave above each newline-terminated line.

PIXELS_BELOW_LINES 

Pixels of blank space to leave below each newline-terminated line.

PIXELS_INSIDE_WRAP 

Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).

BG_FULL_HEIGHT 

"true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.

RISE 

Number of pixels that the characters are risen above the baseline.

See also ATK_TEXT_ATTR_TEXT_POSITION.

UNDERLINE 

"none", "single", "double", "low", or "error".

STRIKETHROUGH 

"true" or "false" whether the text is strikethrough.

SIZE 

The size of the characters in points.

eg: 10.

SCALE 

The scale of the characters.

The value is a string representation of a double.

WEIGHT 

The weight of the characters.

LANGUAGE 

The language used.

FAMILY_NAME 

The font family name.

BG_COLOR 

The background color.

The value is an RGB value of the format "%u,%u,%u".

FG_COLOR 

The foreground color.

The value is an RGB value of the format "%u,%u,%u".

BG_STIPPLE 

"true" if a Gdk::Bitmap is set for stippling the background color.

FG_STIPPLE 

"true" if a Gdk::Bitmap is set for stippling the foreground color.

WRAP_MODE 

The wrap mode of the text, if any.

Values are "none", "char", "word", or "word_char".

DIRECTION 

The direction of the text, if set.

Values are "none", "ltr" or "rtl".

JUSTIFICATION 

The justification of the text, if set.

Values are "left", "right", "center" or "fill".

STRETCH 

The stretch of the text, if set.

Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded".

VARIANT 

The capitalization variant of the text, if set.

Values are "normal" or "small_caps".

STYLE 

The slant style of the text, if set.

Values are "normal", "oblique" or "italic".

TEXT_POSITION 

The vertical position with respect to the baseline.

Values are "baseline", "super", or "sub". Note that a super or sub text attribute refers to position with respect to the baseline of the prior character.

LAST_DEFINED 
enum Atk::Text::ClipType
strong

Describes the type of clipping required.

Enumerator
NONE 

No clipping to be done.

MIN 

Text clipped by min coordinate is omitted.

MAX 

Text clipped by max coordinate is omitted.

BOTH 

Only text fully within mix/max bound is retained.

enum Atk::CoordType
strong

Specifies how xy coordinates are to be interpreted.

Used by functions such as Atk::Component::get_position() and Atk::Text::get_character_extents()

Enumerator
SCREEN 

Specifies xy coordinates relative to the screen.

WINDOW 

Specifies xy coordinates relative to the widget's top-level window.

A top level window with no title or border.

This layer is used for toplevel windows.

PARENT 

Specifies xy coordinates relative to the widget's immediate parent.

Since atkmm 2.30:
enum Atk::Text::Granularity
strong

Text granularity types used for specifying the granularity of the region of text we are interested in.

Enumerator
CHAR 

Granularity is defined by the boundaries between characters (including non-printing characters).

WORD 

Granularity is defined by the boundaries of a word, starting at the beginning of the current word and finishing at the beginning of the following one, if present.

SENTENCE 

Granularity is defined by the boundaries of a sentence, starting at the beginning of the current sentence and finishing at the beginning of the following one, if present.

LINE 

Granularity is defined by the boundaries of a line, starting at the beginning of the current line and finishing at the beginning of the following one, if present.

PARAGRAPH 

Granularity is defined by the boundaries of a paragraph, starting at the beginning of the current paragraph and finishing at the beginning of the following one, if present.

enum Atk::Layer
strong

Describes the layer of a component.

These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another.

Enumerator
INVALID 

The object does not have a layer.

Invalid attribute, like bad spelling or grammar.

Indicates an invalid state - probably an error condition.

Invalid role.

BACKGROUND 

This layer is reserved for the desktop background.

CANVAS 

This layer is used for Canvas components.

An object that can be drawn into and is used to trap events.

WIDGET 

This layer is normally used for components.

MDI 

This layer is used for layered components.

POPUP 

This layer is used for popup components, such as menus.

OVERLAY 

This layer is reserved for future use.

WINDOW 
enum Atk::Role
strong

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.

Enumerator
INVALID 
ACCEL_LABEL 

A label which represents an accelerator.

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.

ANIMATION 

An object which is an animated image.

ARROW 

An arrow in one of the four cardinal directions.

CALENDAR 

An object that displays a calendar and allows the user to select a date.

CANVAS 
CHECK_BOX 

A choice that can be checked or unchecked and provides a separate indicator for the current state.

CHECK_MENU_ITEM 

A menu item with a check box.

COLOR_CHOOSER 

A specialized dialog that lets the user choose a color.

COLUMN_HEADER 

The header for a column of data.

COMBO_BOX 

A collapsible list of choices the user can select from.

DATE_EDITOR 

An object whose purpose is to allow a user to edit a date.

DESKTOP_ICON 

An inconifed internal frame within a DESKTOP_PANE.

DESKTOP_FRAME 

A pane that supports internal frames and iconified versions of those internal frames.

DIAL 

An object whose purpose is to allow a user to set a value.

DIALOG 

A top level window with title bar and a border.

DIRECTORY_PANE 

A pane that allows the user to navigate through and select the contents of a directory.

DRAWING_AREA 

An object used for drawing custom user interface elements.

FILE_CHOOSER 

A specialized dialog that lets the user choose a file.

FILLER 

A object that fills up space in a user interface.

FONT_CHOOSER 

A specialized dialog that lets the user choose a font.

FRAME 

A top level window with a title bar, border, menubar, etc.

GLASS_PANE 

A pane that is guaranteed to be painted on top of all panes beneath it.

HTML_CONTAINER 

A document container for HTML, whose children represent the document content.

ICON 

A small fixed size picture, typically used to decorate components.

IMAGE 

An object whose primary purpose is to display an image.

INTERNAL_FRAME 

A frame-like object that is clipped by a desktop pane.

LABEL 

An object used to present an icon or short string in an interface.

LAYERED_PANE 

A specialized pane that allows its children to be drawn in layers, providing a form of stacking order.

LIST 

An object that presents a list of objects to the user and allows the user to select one or more of them.

LIST_ITEM 

An object that represents an element of a list.

MENU 

An object usually found inside a menu bar that contains a list of actions the user can choose from.

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.

MENU_ITEM 

An object usually contained in a menu that presents an action the user can choose.

OPTION_PANE 

A specialized pane whose primary use is inside a DIALOG.

PAGE_TAB 

An object that is a child of a page tab list.

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.

PANEL 

A generic container that is often used to group objects.

PASSWORD_TEXT 

A text object uses for passwords, or other places where the text content is not shown visibly to the user.

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.

PROGRESS_BAR 

An object used to indicate how much of a task has been completed.

PUSH_BUTTON 

An object the user can manipulate to tell the application to do something.

RADIO_BUTTON 

A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked.

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.

ROOT_PANE 

A specialized pane that has a glass pane and a layered pane as its children.

ROW_HEADER 

The header for a row of data.

SCROLL_BAR 

An object usually used to allow a user to incrementally view a large amount of data.

SCROLL_PANE 

An object that allows a user to incrementally view a large amount of information.

SEPARATOR 

An object usually contained in a menu to provide a visible and logical separation of the contents in a menu.

SLIDER 

An object that allows the user to select from a bounded range.

SPLIT_PANE 

A specialized panel that presents two other panels at the same time.

SPIN_BUTTON 

An object used to get an integer or floating point number from the user.

STATUSBAR 

An object which reports messages of minor importance to the user.

TABLE 

An object used to represent information in terms of rows and columns.

TABLE_CELL 

A cell in a table.

TABLE_COLUMN_HEADER 

The header for a column of a table.

TABLE_ROW_HEADER 

The header for a row of a table.

TEAR_OFF_MENU_ITEM 

A menu item used to tear off and reattach its menu.

TERMINAL 

An object that represents an accessible terminal.

(Since: 0.6).

TEXT 

An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input.

Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For widgets whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see ATK_ROLE_STATIC.

TOGGLE_BUTTON 

A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state.

TOOL_BAR 

A bar or palette usually composed of push buttons or toggle buttons.

TOOL_TIP 

An object that provides information about another object.

TREE 

An object used to represent hierarchical information to the user.

TREE_TABLE 

An object capable of expanding and collapsing rows as well as showing multiple columns of data.

(Since: 0.7).

UNKNOWN 

The object contains some Accessible information, but its role is not known.

VIEWPORT 

An object usually used in a scroll pane.

WINDOW 
HEADER 

An object that serves as a document header.

(Since: 1.1.1).

FOOTER 

An object that serves as a document footer.

(Since: 1.1.1).

PARAGRAPH 

An object which is contains a paragraph of text content.

(Since: 1.1.1).

RULER 

An object which describes margins and tab stops, etc.

for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1).

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: 1.1.4).

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: 1.3).

EDITBAR 

The object is an editable text object in a toolbar.

(Since: 1.5).

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: 1.7.2).

ENTRY 

The object is a component whose textual content may be entered or modified by the user, provided ATK_STATE_EDITABLE is present.

(Since: 1.11).

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: 1.11).

CAPTION 

The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.

(Since: 1.11).

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: 1.11).

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.

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: 1.11).

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: 1.11).

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: 1.11).

FORM 

The object is a container for form controls, for instance as part of a web form or user-input form within a document.

This role is primarily a tag/convenience for clients when navigating complex documents, it is not expected that ordinary GUI containers will always have ATK_ROLE_FORM. (Since: 1.12.0).

LINK 

The object is a hypertext anchor, i.e.

a "link" in a hypertext document. Such objects are distinct from 'inline' content which may also use the Hypertext/Hyperlink interfaces to indicate the range/location within a text object where an inline or embedded object lies. (Since: 1.12.1).

INPUT_METHOD_WINDOW 

The object is a window or similar viewport which is used to allow composition or input of a 'complex character', in other words it is an "input method window." (Since: 1.12.1).

TABLE_ROW 

A row in a table.

(Since: 2.1.0).

TREE_ITEM 

An object that represents an element of a tree.

(Since: 2.1.0).

DOCUMENT_SPREADSHEET 

A document frame which contains a spreadsheet.

(Since: 2.1.0).

DOCUMENT_PRESENTATION 

A document frame which contains a presentation or slide content.

(Since: 2.1.0).

DOCUMENT_TEXT 

A document frame which contains textual content, such as found in a word processing application.

(Since: 2.1.0).

DOCUMENT_WEB 

A document frame which contains HTML or other markup suitable for display in a web browser.

(Since: 2.1.0).

DOCUMENT_EMAIL 

A document frame which contains email content to be displayed or composed either in plain text or HTML.

(Since: 2.1.0).

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: 2.1.0).

LIST_BOX 

A non-collapsible list of choices the user can select from.

(Since: 2.1.0).

GROUPING 

A group of related widgets.

This group typically has a label. (Since: 2.1.0).

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: 2.1.0).

NOTIFICATION 

A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application.

(Since: 2.1.0).

INFO_BAR 

An object designed to present a message to the user within an existing window.

(Since: 2.1.0).

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: 2.7.3).

TITLE_BAR 

A bar that serves as the title of a window or a dialog.

(Since: 2.12).

BLOCK_QUOTE 

An object which contains a text section that is quoted from another source.

(Since: 2.12).

AUDIO 

An object which represents an audio element.

(Since: 2.12).

VIDEO 

An object which represents a video element.

(Since: 2.12).

DEFINITION 

A definition of a term or concept.

(Since: 2.12).

ARTICLE 

A section of a page that consists of a composition that forms an independent part of a document, page, or site.

Examples: A blog entry, a news story, a forum post. (Since: 2.12).

LANDMARK 

A region of a web page intended as a navigational landmark.

This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document. (Since: 2.12).

LOG 

A text widget or container holding log content, such as chat history and error logs.

In this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. (Since: 2.12).

MARQUEE 

A container where non-essential information changes frequently.

Common usages of marquee include stock tickers and ad banners. The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of important content changes. (Since: 2.12).

MATH 

A text widget or container that holds a mathematical expression.

(Since: 2.12).

RATING 

A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player.

Objects of this role should also implement AtkValue. (Since: 2.12).

TIMER 

An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point.

(Since: 2.12).

DESCRIPTION_LIST 

An object that represents a list of term-value groups.

A term-value group represents a individual description and consist of one or more names (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be more than one group with the same term name. (Since: 2.12).

DESCRIPTION_TERM 

An object that represents a term or phrase with a corresponding definition.

(Since: 2.12).

DESCRIPTION_VALUE 

An object that represents the description, definition or value of a term.

(Since: 2.12).

STATIC 

A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user.

Examples in which Atk::Role::STATIC is appropriate include the message displayed in a message box and an image used as an alternative means to display text. Atk::Role::STATIC should not be applied to widgets which are traditionally interactive, objects which display a significant amount of content, or any object which has an accessible relation pointing to another object. Implementors should expose the displayed information through the accessible name of the object. If doing so seems inappropriate, it may indicate that a different role should be used. For labels which describe another widget, see Atk::Role::LABEL. For text views, see Atk::Role::TEXT. For generic containers, see Atk::Role::PANEL. For objects whose role is not known by the implementor, see Atk::Role::UNKNOWN. (Since: 2.16).

MATH_FRACTION 

An object that represents a mathematical fraction.

(Since: 2.16).

MATH_ROOT 

An object that represents a mathematical expression displayed with a radical.

(Since: 2.16).

SUBSCRIPT 

An object that contains text that is displayed as a subscript.

(Since: 2.16).

SUPERSCRIPT 

An object that contains text that is displayed as a superscript.

(Since: 2.16).

FOOTNOTE 

An object that contains the text of a footnote.

(Since: 2.26).

CONTENT_DELETION 

Content previously deleted or proposed to be deleted, e.g.

in revision history or a content view providing suggestions from reviewers. (Since: 2.34).

CONTENT_INSERTION 

Content previously inserted or proposed to be inserted, e.g.

in revision history or a content view providing suggestions from reviewers. (Since: 2.34).

MARK 

A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose.

If the marked content has an associated section in the document elaborating on the reason for the mark, then Atk::Relation::Type::DETAILS should be used on the mark to point to that associated section. In addition, the reciprocal relation Atk::Relation::Type::DETAILS_FOR should be used on the associated content section to point back to the mark. (Since: 2.36).

SUGGESTION 

A container for content that is called out as a proposed change from the current version of the document, such as by a reviewer of the content.

This role should include either Atk::Role::CONTENT_DELETION and/or Atk::Role::CONTENT_INSERTION children, in any order, to indicate what the actual change is. (Since: 2.36).

LAST_DEFINED 

Not a valid role, used for finding end of the enumeration.

Not a valid text attribute, used for finding end of enumeration.

Not a valid state, used for finding end of enumeration.

enum Atk::StateType
strong

The possible types of states of an object.

Enumerator
INVALID 
ACTIVE 

Indicates a window is currently the active window, or an object is the active subelement within a container or table.

ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container.

ARMED 

Indicates that the object is 'armed', i.e.

will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code.

BUSY 

Indicates the current object is busy, i.e.

onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.

CHECKED 

Indicates this object is currently checked, for instance a checkbox is 'non-empty'.

DEFUNCT 

Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed).

EDITABLE 

Indicates that this object can contain text, and that the user can change the textual contents of this object by editing those contents directly.

Either "true" or "false" indicating whether text is editable or not.

For an object which is expected to be editable due to its type, but which cannot be edited due to the application or platform preventing the user from doing so, that object's Atk::StateSet should lack ATK_STATE_EDITABLE and should contain ATK_STATE_READ_ONLY.

ENABLED 

Indicates that this object is enabled, i.e.

that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE.

EXPANDABLE 

Indicates this object allows progressive disclosure of its children.

EXPANDED 

Indicates this object its expanded - see ATK_STATE_EXPANDABLE above.

FOCUSABLE 

Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus.

FOCUSED 

Indicates this object currently has the keyboard focus.

HORIZONTAL 

Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR.

For objects where vertical/horizontal orientation is especially meaningful.

ICONIFIED 

Indicates this object is minimized and is represented only by an icon.

MODAL 

Indicates something must be done with this object before the user can interact with an object in a different window.

MULTI_LINE 

Indicates this (text) object can contain multiple lines of text.

MULTISELECTABLE 

Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.

OPAQUE 

Indicates this object paints every pixel within its rectangular region.

PRESSED 

Indicates this object is currently pressed.

RESIZABLE 

Indicates the size of this object is not fixed.

SELECTABLE 

Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected.

SELECTED 

Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected.

SENSITIVE 

Indicates this object is sensitive, e.g.

to user interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, but may be found in the absence of STATE_ENABLED if the current visible state of the control is "disconnected" from the application state. In such cases, direct user interaction can often result in the object gaining STATE_SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. see STATE_ENABLED, STATE_INDETERMINATE.

SHOWING 

Indicates this object, the object's parent, the object's parent's parent, and so on, are all 'shown' to the end-user, i.e.

subject to "exposure" if blocking or obscuring objects do not interpose between this object and the top of the window stack.

SINGLE_LINE 

Indicates this (text) object can contain only a single line of text.

STALE 

Indicates that the information returned for this object may no longer be synchronized with the application state.

This is implied if the object has STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that the index associated with this object has changed since the user accessed the object (in lieu of "index-in-parent-changed" events).

TRANSIENT 

Indicates this object is transient, i.e.

a snapshot which may not emit events when its state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no notification given when the cached data becomes obsolete.

VERTICAL 

Indicates the orientation of this object is vertical.

VISIBLE 

Indicates this object is visible, e.g.

has been explicitly marked for exposure to the user. note: Atk::StateType::VISIBLE is no guarantee that the object is actually unobscured on the screen, only that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the field of view, or having an ancestor container that has not yet made visible. A widget is potentially onscreen if it has both Atk::StateType::VISIBLE and Atk::StateType::SHOWING. The absence of Atk::StateType::VISIBLE and Atk::StateType::SHOWING is semantically equivalent to saying that an object is 'hidden'. See also Atk::StateType::TRUNCATED, which applies if an object with Atk::StateType::VISIBLE and Atk::StateType::SHOWING set lies within a viewport which means that its contents are clipped, e.g. a truncated spreadsheet cell or an image within a scrolling viewport. Mostly useful for screen-review and magnification algorithms.

MANAGES_DESCENDANTS 

Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e.

are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. that the children should not, and need not, be enumerated by the client. Objects implementing this state are expected to provide relevant state notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children.

INDETERMINATE 

Indicates that the value, or some other quantifiable property, of this AtkObject cannot be fully determined.

In the case of a large data set in which the total number of items in that set is unknown (e.g. 1 of 999+), implementors should expose the currently-known set size (999) along with this state. In the case of a check box, this state should be used to indicate that the check box is a tri-state check box which is currently neither checked nor unchecked.

TRUNCATED 

Indicates that an object is truncated, e.g.

a text value in a speradsheet cell.

REQUIRED 

Indicates that explicit user interaction with an object is required by the user interface, e.g.

a required field in a "web-form" interface.

INVALID_ENTRY 

Indicates that the object has encountered an error condition due to failure of input validation.

For instance, a form control may acquire this state in response to invalid or malformed user input.

SUPPORTS_AUTOCOMPLETION 

Indicates that the object in question implements some form of ¨typeahead¨ or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become selected.

Subsequent character input may narrow the selection further as long as one or more sub-elements match the string. This state is normally only useful and encountered on objects that implement Selection. In some cases the typeahead behavior may result in full or partial ¨completion¨ of the data in the input field, in which case these input events may trigger text-changed events from the AtkText interface. This state supplants ATK_ROLE_AUTOCOMPLETE.

SELECTABLE_TEXT 

Indicates that the object in question supports text selection.

It should only be exposed on objects which implement the Text interface, in order to distinguish this state from ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.

DEFAULT 

Indicates that the object is the "default" active component, i.e.

the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button.

ANIMATED 

Indicates that the object changes its appearance dynamically as an inherent part of its presentation.

This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. note: some applications, notably content viewers, may not be able to detect all kinds of animated content. Therefore the absence of this state should not be taken as definitive evidence that the object's visual representation is static; this state is advisory.

VISITED 

Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".

CHECKABLE 

Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell.

Since: ATK-2.12.

HAS_POPUP 

Indicates that the object has a popup context menu or sub-level menu which may or may not be showing.

This means that activation renders conditional content. Note that ordinary tooltips are not considered popups in this context. Since: ATK-2.12.

HAS_TOOLTIP 

Indicates this object has a tooltip.

Since: ATK-2.16.

READ_ONLY 

Indicates that a widget which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user.

Note that this state should only be applied to widget types whose value is normally directly user modifiable, such as check boxes, radio buttons, spin buttons, text input fields, and combo boxes, as a means to convey that the expected interaction with that widget is not possible. When the expected interaction with a widget does not include modification by the user, as is the case with labels and containers, ATK_STATE_READ_ONLY should not be applied. See also ATK_STATE_EDITABLE. Since: ATK-2-16.

LAST_DEFINED 
enum Atk::Relation::Type
strong

Describes the type of the relation.

Enumerator
NONE 

Not used, represens "no relationship" or an error condition.

CONTROLLED_BY 

Indicates an object controlled by one or more target objects.

CONTROLLER_FOR 

Indicates an object is an controller for one or more target objects.

LABEL_FOR 

Indicates an object is a label for one or more target objects.

LABELLED_BY 

Indicates an object is labelled by one or more target objects.

MEMBER_OF 

Indicates an object is a member of a group of one or more target objects.

NODE_CHILD_OF 

Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.

FLOWS_TO 

Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow).

FLOWS_FROM 

Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow).

SUBWINDOW_OF 

Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component.

EMBEDS 

Indicates that the object visually embeds another object's content, i.e.

this object's content flows around another's content.

EMBEDDED_BY 

Reciprocal of Atk::Relation::Type::EMBEDS, indicates that this object's content is visualy embedded in another object.

POPUP_FOR 

Indicates that an object is a popup for another object.

PARENT_WINDOW_OF 

Indicates that an object is a parent window of another object.

DESCRIBED_BY 

Reciprocal of Atk::Relation::Type::DESCRIPTION_FOR.

Indicates that one or more target objects provide descriptive information about this object. This relation type is most appropriate for information that is not essential as its presentation may be user-configurable and/or limited to an on-demand mechanism such as an assistive technology command. For brief, essential information such as can be found in a widget's on-screen label, use Atk::Relation::Type::LABELLED_BY. For an on-screen error message, use Atk::Relation::Type::ERROR_MESSAGE. For lengthy extended descriptive information contained in an on-screen object, consider using Atk::Relation::Type::DETAILS as assistive technologies may provide a means for the user to navigate to objects containing detailed descriptions so that their content can be more closely reviewed.

DESCRIPTION_FOR 

Reciprocal of Atk::Relation::Type::DESCRIBED_BY.

Indicates that this object provides descriptive information about the target object(s). See also Atk::Relation::Type::DETAILS_FOR and Atk::Relation::Type::ERROR_FOR.

NODE_PARENT_OF 

Indicates an object is a cell in a treetable and is expanded to display other cells in the same column.

DETAILS 

Reciprocal of Atk::Relation::Type::DETAILS_FOR.

Indicates that this object has a detailed or extended description, the contents of which can be found in the target object(s). This relation type is most appropriate for information that is sufficiently lengthy as to make navigation to the container of that information desirable. For less verbose information suitable for announcement only, see Atk::Relation::Type::DESCRIBED_BY. If the detailed information describes an error condition, Atk::Relation::Type::ERROR_FOR should be used instead. Since: ATK-2.26.

DETAILS_FOR 

Reciprocal of Atk::Relation::Type::DETAILS.

Indicates that this object provides a detailed or extended description about the target object(s). See also Atk::Relation::Type::DESCRIPTION_FOR and Atk::Relation::Type::ERROR_FOR. Since: ATK-2.26.

ERROR_MESSAGE 

Reciprocal of Atk::Relation::Type::ERROR_FOR.

Indicates that this object has one or more errors, the nature of which is described in the contents of the target object(s). Objects that have this relation type should also contain Atk::StateType::INVALID_ENTRY in their Atk::StateSet. Since: ATK-2.26.

ERROR_FOR 

Reciprocal of Atk::Relation::Type::ERROR_MESSAGE.

Indicates that this object contains an error message describing an invalid condition in the target object(s). Since: ATK_2.26.

LAST_DEFINED 

Not used, this value indicates the end of the enumeration.

Generated on Sat Dec 19 2020 09:14:21 for atkmm by   doxygen 1.8.11