atkmm  2.25.4
Enumerations
atkmm Enums and Flags

Enumerations

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::LAST_DEFINED
}
 
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
}
 
enum  Atk::CoordType {
  Atk::CoordType::SCREEN,
  Atk::CoordType::WINDOW
}
 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::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::LAST_DEFINED
}
 Describes the type of the relation. 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::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

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.

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".

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.

This layer is used for toplevel windows.

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.

BACKGROUND 

This layer is reserved for the desktop background.

CANVAS 

This layer is used for Canvas components.

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
Enumerator
INVALID 
ACCEL_LABEL 
ALERT 
ANIMATION 
ARROW 
CALENDAR 
CANVAS 
CHECK_BOX 
CHECK_MENU_ITEM 
COLOR_CHOOSER 
COLUMN_HEADER 
COMBO_BOX 
DATE_EDITOR 
DESKTOP_ICON 
DESKTOP_FRAME 
DIAL 
DIALOG 
DIRECTORY_PANE 
DRAWING_AREA 
FILE_CHOOSER 
FILLER 
FONT_CHOOSER 
FRAME 
GLASS_PANE 
HTML_CONTAINER 
ICON 
IMAGE 
INTERNAL_FRAME 
LABEL 
LAYERED_PANE 
LIST 
LIST_ITEM 
MENU 
MENU_BAR 
MENU_ITEM 
OPTION_PANE 
PAGE_TAB 
PAGE_TAB_LIST 
PANEL 
PASSWORD_TEXT 
POPUP_MENU 
PROGRESS_BAR 
PUSH_BUTTON 
RADIO_BUTTON 
RADIO_MENU_ITEM 
ROOT_PANE 
ROW_HEADER 
SCROLL_BAR 
SCROLL_PANE 
SEPARATOR 
SLIDER 
SPLIT_PANE 
SPIN_BUTTON 
STATUSBAR 
TABLE 
TABLE_CELL 
TABLE_COLUMN_HEADER 
TABLE_ROW_HEADER 
TEAR_OFF_MENU_ITEM 
TERMINAL 
TEXT 
TOGGLE_BUTTON 
TOOL_BAR 
TOOL_TIP 
TREE 
TREE_TABLE 
UNKNOWN 
VIEWPORT 
WINDOW 
HEADER 
FOOTER 
PARAGRAPH 
RULER 
APPLICATION 
AUTOCOMPLETE 
EDITBAR 
EMBEDDED 
ENTRY 
CHART 
CAPTION 
DOCUMENT_FRAME 
HEADING 
PAGE 
SECTION 
REDUNDANT_OBJECT 
FORM 
LINK 
INPUT_METHOD_WINDOW 
TABLE_ROW 
TREE_ITEM 
DOCUMENT_SPREADSHEET 
DOCUMENT_PRESENTATION 
DOCUMENT_TEXT 
DOCUMENT_WEB 
DOCUMENT_EMAIL 
COMMENT 
LIST_BOX 
GROUPING 
IMAGE_MAP 
NOTIFICATION 
INFO_BAR 
LEVEL_BAR 
TITLE_BAR 
BLOCK_QUOTE 
AUDIO 
VIDEO 
DEFINITION 
ARTICLE 
LANDMARK 
LOG 
MARQUEE 
MATH 
RATING 
TIMER 
DESCRIPTION_LIST 
DESCRIPTION_TERM 
DESCRIPTION_VALUE 
STATIC 
MATH_FRACTION 
MATH_ROOT 
SUBSCRIPT 
SUPERSCRIPT 
LAST_DEFINED 

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

enum Atk::StateType
strong
Enumerator
INVALID 
ACTIVE 
ARMED 
BUSY 
CHECKED 
DEFUNCT 
EDITABLE 

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

ENABLED 
EXPANDABLE 
EXPANDED 
FOCUSABLE 
FOCUSED 
HORIZONTAL 
ICONIFIED 
MODAL 
MULTI_LINE 
MULTISELECTABLE 
OPAQUE 
PRESSED 
RESIZABLE 
SELECTABLE 
SELECTED 
SENSITIVE 
SHOWING 
SINGLE_LINE 
STALE 
TRANSIENT 
VERTICAL 
VISIBLE 
MANAGES_DESCENDANTS 
INDETERMINATE 
TRUNCATED 
REQUIRED 
INVALID_ENTRY 
SUPPORTS_AUTOCOMPLETION 
SELECTABLE_TEXT 
DEFAULT 
ANIMATED 
VISITED 
CHECKABLE 
HAS_POPUP 
HAS_TOOLTIP 
READ_ONLY 
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 

Inverse of Atk::RelationType::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 

Indicates that another object provides descriptive information about this object; more verbose than ATK_RELATION_LABELLED_BY.

DESCRIPTION_FOR 

Indicates that an object provides descriptive information about another object; more verbose than ATK_RELATION_LABEL_FOR.

NODE_PARENT_OF 

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

LAST_DEFINED 

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