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::STATE_INVALID,
Atk::STATE_ACTIVE,
Atk::STATE_ARMED,
Atk::STATE_BUSY,
Atk::STATE_CHECKED,
Atk::STATE_DEFUNCT,
Atk::STATE_EDITABLE,
Atk::STATE_ENABLED,
Atk::STATE_EXPANDABLE,
Atk::STATE_EXPANDED,
Atk::STATE_FOCUSABLE,
Atk::STATE_FOCUSED,
Atk::STATE_HORIZONTAL,
Atk::STATE_ICONIFIED,
Atk::STATE_MODAL,
Atk::STATE_MULTI_LINE,
Atk::STATE_MULTISELECTABLE,
Atk::STATE_OPAQUE,
Atk::STATE_PRESSED,
Atk::STATE_RESIZABLE,
Atk::STATE_SELECTABLE,
Atk::STATE_SELECTED,
Atk::STATE_SENSITIVE,
Atk::STATE_SHOWING,
Atk::STATE_SINGLE_LINE,
Atk::STATE_STALE,
Atk::STATE_TRANSIENT,
Atk::STATE_VERTICAL,
Atk::STATE_VISIBLE,
Atk::STATE_MANAGES_DESCENDANTS,
Atk::STATE_INDETERMINATE,
Atk::STATE_TRUNCATED,
Atk::STATE_REQUIRED,
Atk::STATE_INVALID_ENTRY,
Atk::STATE_SUPPORTS_AUTOCOMPLETION,
Atk::STATE_SELECTABLE_TEXT,
Atk::STATE_DEFAULT,
Atk::STATE_ANIMATED,
Atk::STATE_VISITED,
Atk::STATE_CHECKABLE,
Atk::STATE_HAS_POPUP,
Atk::STATE_HAS_TOOLTIP,
Atk::STATE_READ_ONLY,
Atk::STATE_LAST_DEFINED
}

enum | Atk::CoordType { Atk::XY_SCREEN, Atk::XY_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::RelationType {
Atk::RELATION_NULL,
Atk::RELATION_CONTROLLED_BY,
Atk::RELATION_CONTROLLER_FOR,
Atk::RELATION_LABEL_FOR,
Atk::RELATION_LABELLED_BY,
Atk::RELATION_MEMBER_OF,
Atk::RELATION_NODE_CHILD_OF,
Atk::RELATION_FLOWS_TO,
Atk::RELATION_FLOWS_FROM,
Atk::RELATION_SUBWINDOW_OF,
Atk::RELATION_EMBEDS,
Atk::RELATION_EMBEDDED_BY,
Atk::RELATION_POPUP_FOR,
Atk::RELATION_PARENT_WINDOW_OF,
Atk::RELATION_DESCRIBED_BY,
Atk::RELATION_DESCRIPTION_FOR,
Atk::RELATION_NODE_PARENT_OF,
Atk::RELATION_LAST_DEFINED
}

| Describes the type of the relation. More...

enum

Atk::BuiltinTextAttribute {
Atk::TEXT_ATTR_INVALID,
Atk::TEXT_ATTR_LEFT_MARGIN,
Atk::TEXT_ATTR_RIGHT_MARGIN,
Atk::TEXT_ATTR_INDENT,
Atk::TEXT_ATTR_INVISIBLE,
Atk::TEXT_ATTR_EDITABLE,
Atk::TEXT_ATTR_PIXELS_ABOVE_LINES,
Atk::TEXT_ATTR_PIXELS_BELOW_LINES,
Atk::TEXT_ATTR_PIXELS_INSIDE_WRAP,
Atk::TEXT_ATTR_BG_FULL_HEIGHT,
Atk::TEXT_ATTR_RISE,
Atk::TEXT_ATTR_UNDERLINE,
Atk::TEXT_ATTR_STRIKETHROUGH,
Atk::TEXT_ATTR_SIZE,
Atk::TEXT_ATTR_SCALE,
Atk::TEXT_ATTR_WEIGHT,
Atk::TEXT_ATTR_LANGUAGE,
Atk::TEXT_ATTR_FAMILY_NAME,
Atk::TEXT_ATTR_BG_COLOR,
Atk::TEXT_ATTR_FG_COLOR,
Atk::TEXT_ATTR_BG_STIPPLE,
Atk::TEXT_ATTR_FG_STIPPLE,
Atk::TEXT_ATTR_WRAP_MODE,
Atk::TEXT_ATTR_DIRECTION,
Atk::TEXT_ATTR_JUSTIFICATION,
Atk::TEXT_ATTR_STRETCH,
Atk::TEXT_ATTR_VARIANT,
Atk::TEXT_ATTR_STYLE,
Atk::TEXT_ATTR_LAST_DEFINED
}

| Describes the text attributes supported. More...
enum | Atk::TextBoundary { Atk::TEXT_BOUNDARY_CHAR, Atk::TEXT_BOUNDARY_WORD_START, Atk::TEXT_BOUNDARY_WORD_END, Atk::TEXT_BOUNDARY_SENTENCE_START, Atk::TEXT_BOUNDARY_SENTENCE_END, Atk::TEXT_BOUNDARY_LINE_START, Atk::TEXT_BOUNDARY_LINE_END }
| Text boundary types used for specifying boundaries for regions of text. More...
enum | Atk::TextClipType { Atk::TEXT_CLIP_NONE, Atk::TEXT_CLIP_MIN, Atk::TEXT_CLIP_MAX, Atk::TEXT_CLIP_BOTH }
| Describes the type of clipping required. More...
enum | Atk::TextGranularity { 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

## BuiltinTextAttribute

enum Atk::BuiltinTextAttribute

Describes the text attributes supported.

Enumerator
TEXT_ATTR_INVALID | Invalid attribute, like bad spelling or grammar.
TEXT_ATTR_LEFT_MARGIN | The pixel width of the left margin.
TEXT_ATTR_RIGHT_MARGIN | The pixel width of the right margin.
TEXT_ATTR_INDENT | The number of pixels that the text is indented.
TEXT_ATTR_INVISIBLE | Either "true" or "false" indicating whether text is visible or not.
TEXT_ATTR_EDITABLE | Either "true" or "false" indicating whether text is editable or not.
TEXT_ATTR_PIXELS_ABOVE_LINES | Pixels of blank space to leave above each newline-terminated line.
TEXT_ATTR_PIXELS_BELOW_LINES | Pixels of blank space to leave below each newline-terminated line.
TEXT_ATTR_PIXELS_INSIDE_WRAP | Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
TEXT_ATTR_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.
TEXT_ATTR_RISE | Number of pixels that the characters are risen above the baseline.
TEXT_ATTR_UNDERLINE | "none", "single", "double", "low", or "error".
TEXT_ATTR_STRIKETHROUGH | "true" or "false" whether the text is strikethrough.
TEXT_ATTR_SIZE | The size of the characters in points. eg: 10.
TEXT_ATTR_SCALE | The scale of the characters. The value is a string representation of a double.
TEXT_ATTR_WEIGHT | The weight of the characters.
TEXT_ATTR_LANGUAGE | The language used.
TEXT_ATTR_FAMILY_NAME | The font family name.
TEXT_ATTR_BG_COLOR | The background color. The value is an RGB value of the format "%u,%u,%u".
TEXT_ATTR_FG_COLOR | The foreground color. The value is an RGB value of the format "%u,%u,%u".
TEXT_ATTR_BG_STIPPLE | "true" if a Gdk::Bitmap is set for stippling the background color.
TEXT_ATTR_FG_STIPPLE | "true" if a Gdk::Bitmap is set for stippling the foreground color.
TEXT_ATTR_WRAP_MODE | The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char".
TEXT_ATTR_DIRECTION | The direction of the text, if set. Values are "none", "ltr" or "rtl".
TEXT_ATTR_JUSTIFICATION | The justification of the text, if set. Values are "left", "right", "center" or "fill".
TEXT_ATTR_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".
TEXT_ATTR_VARIANT | The capitalization variant of the text, if set. Values are "normal" or "small_caps".
TEXT_ATTR_STYLE | The slant style of the text, if set. Values are "normal", "oblique" or "italic".
TEXT_ATTR_LAST_DEFINED | Not a valid text attribute, used for finding end of enumeration.

## CoordType

enum Atk::CoordType

Specifies how xy coordinates are to be interpreted.

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

Enumerator
XY_SCREEN | Specifies xy coordinates relative to the screen.
XY_WINDOW | Specifies xy coordinates relative to the widget's top-level window.

## Layer

enum Atk::Layer

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
LAYER_INVALID | The object does not have a layer.
LAYER_BACKGROUND | This layer is reserved for the desktop background.
LAYER_CANVAS | This layer is used for Canvas components.
LAYER_WIDGET | This layer is normally used for components.
LAYER_MDI | This layer is used for layered components.
LAYER_POPUP | This layer is used for popup components, such as menus.
LAYER_OVERLAY | This layer is reserved for future use.
LAYER_WINDOW | This layer is used for toplevel windows.

## RelationType

enum Atk::RelationType

Describes the type of the relation.

Enumerator
RELATION_NULL | Not used, represens "no relationship" or an error condition.
RELATION_CONTROLLED_BY | Indicates an object controlled by one or more target objects.
RELATION_CONTROLLER_FOR | Indicates an object is an controller for one or more target objects.
RELATION_LABEL_FOR | Indicates an object is a label for one or more target objects.
RELATION_LABELLED_BY | Indicates an object is labelled by one or more target objects.
RELATION_MEMBER_OF | Indicates an object is a member of a group of one or more target objects.
RELATION_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.
RELATION_FLOWS_TO | Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow).
RELATION_FLOWS_FROM | Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow).
RELATION_SUBWINDOW_OF | Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component.
RELATION_EMBEDS | Indicates that the object visually embeds another object's content, i.e. this object's content flows around another's content.
RELATION_EMBEDDED_BY | Inverse of Atk::RELATION_EMBEDS, indicates that this object's content is visualy embedded in another object.
RELATION_POPUP_FOR | Indicates that an object is a popup for another object.
RELATION_PARENT_WINDOW_OF | Indicates that an object is a parent window of another object.
RELATION_DESCRIBED_BY | Indicates that another object provides descriptive information about this object; more verbose than ATK_RELATION_LABELLED_BY.
RELATION_DESCRIPTION_FOR | Indicates that an object provides descriptive information about another object; more verbose than ATK_RELATION_LABEL_FOR.
RELATION_NODE_PARENT_OF | Indicates an object is a cell in a treetable and is expanded to display other cells in the same column.
RELATION_LAST_DEFINED | Not used, this value indicates the end of the enumeration.

## Role

enum Atk::Role

Enumerator
ROLE_INVALID |
ROLE_ACCEL_LABEL |
ROLE_ALERT |
ROLE_ANIMATION |
ROLE_ARROW |
ROLE_CALENDAR |
ROLE_CANVAS |
ROLE_CHECK_BOX |
ROLE_CHECK_MENU_ITEM |
ROLE_COLOR_CHOOSER |
ROLE_COLUMN_HEADER |
ROLE_COMBO_BOX |
ROLE_DATE_EDITOR |
ROLE_DESKTOP_ICON |
ROLE_DESKTOP_FRAME |
ROLE_DIAL |
ROLE_DIALOG |
ROLE_DIRECTORY_PANE |
ROLE_DRAWING_AREA |
ROLE_FILE_CHOOSER |
ROLE_FILLER |
ROLE_FONT_CHOOSER |
ROLE_FRAME |
ROLE_GLASS_PANE |
ROLE_HTML_CONTAINER |
ROLE_ICON |
ROLE_IMAGE |
ROLE_INTERNAL_FRAME |
ROLE_LABEL |
ROLE_LAYERED_PANE |
ROLE_LIST |
ROLE_LIST_ITEM |
ROLE_MENU |
ROLE_MENU_BAR |
ROLE_MENU_ITEM |
ROLE_OPTION_PANE |
ROLE_PAGE_TAB |
ROLE_PAGE_TAB_LIST |
ROLE_PANEL |
ROLE_PASSWORD_TEXT |
ROLE_POPUP_MENU |
ROLE_PROGRESS_BAR |
ROLE_PUSH_BUTTON |
ROLE_RADIO_BUTTON |
ROLE_RADIO_MENU_ITEM |
ROLE_ROOT_PANE |
ROLE_ROW_HEADER |
ROLE_SCROLL_BAR |
ROLE_SCROLL_PANE |
ROLE_SEPARATOR |
ROLE_SLIDER |
ROLE_SPLIT_PANE |
ROLE_SPIN_BUTTON |
ROLE_STATUSBAR |
ROLE_TABLE |
ROLE_TABLE_CELL |
ROLE_TABLE_COLUMN_HEADER |
ROLE_TABLE_ROW_HEADER |
ROLE_TEAR_OFF_MENU_ITEM |
ROLE_TERMINAL |
ROLE_TEXT |
ROLE_TOGGLE_BUTTON |
ROLE_TOOL_BAR |
ROLE_TOOL_TIP |
ROLE_TREE |
ROLE_TREE_TABLE |
ROLE_UNKNOWN |
ROLE_VIEWPORT |
ROLE_WINDOW |
ROLE_HEADER |
ROLE_FOOTER |
ROLE_PARAGRAPH |
ROLE_RULER |
ROLE_APPLICATION |
ROLE_AUTOCOMPLETE |
ROLE_EDITBAR |
ROLE_EMBEDDED |
ROLE_ENTRY |
ROLE_CHART |
ROLE_CAPTION |
ROLE_DOCUMENT_FRAME |
ROLE_HEADING |
ROLE_PAGE |
ROLE_SECTION |
ROLE_REDUNDANT_OBJECT |
ROLE_FORM |
ROLE_LINK |
ROLE_INPUT_METHOD_WINDOW |
ROLE_TABLE_ROW |
ROLE_TREE_ITEM |
ROLE_DOCUMENT_SPREADSHEET |
ROLE_DOCUMENT_PRESENTATION |
ROLE_DOCUMENT_TEXT |
ROLE_DOCUMENT_WEB |
ROLE_DOCUMENT_EMAIL |
ROLE_COMMENT |
ROLE_LIST_BOX |
ROLE_GROUPING |
ROLE_IMAGE_MAP |
ROLE_NOTIFICATION |
ROLE_INFO_BAR |
ROLE_LEVEL_BAR |
ROLE_TITLE_BAR |
ROLE_BLOCK_QUOTE |
ROLE_AUDIO |
ROLE_VIDEO |
ROLE_DEFINITION |
ROLE_ARTICLE |
ROLE_LANDMARK |
ROLE_LOG |
ROLE_MARQUEE |
ROLE_MATH |
ROLE_RATING |
ROLE_TIMER |
ROLE_DESCRIPTION_LIST |
ROLE_DESCRIPTION_TERM |
ROLE_DESCRIPTION_VALUE |
ROLE_STATIC |
ROLE_MATH_FRACTION |
ROLE_MATH_ROOT |
ROLE_SUBSCRIPT |
ROLE_SUPERSCRIPT |
ROLE_LAST_DEFINED |

## StateType

enum Atk::StateType

Enumerator
STATE_INVALID |
STATE_ACTIVE |
STATE_ARMED |
STATE_BUSY |
STATE_CHECKED |
STATE_DEFUNCT |
STATE_EDITABLE |
STATE_ENABLED |
STATE_EXPANDABLE |
STATE_EXPANDED |
STATE_FOCUSABLE |
STATE_FOCUSED |
STATE_HORIZONTAL |
STATE_ICONIFIED |
STATE_MODAL |
STATE_MULTI_LINE |
STATE_MULTISELECTABLE |
STATE_OPAQUE |
STATE_PRESSED |
STATE_RESIZABLE |
STATE_SELECTABLE |
STATE_SELECTED |
STATE_SENSITIVE |
STATE_SHOWING |
STATE_SINGLE_LINE |
STATE_STALE |
STATE_TRANSIENT |
STATE_VERTICAL |
STATE_VISIBLE |
STATE_MANAGES_DESCENDANTS |
STATE_INDETERMINATE |
STATE_TRUNCATED |
STATE_REQUIRED |
STATE_INVALID_ENTRY |
STATE_SUPPORTS_AUTOCOMPLETION |
STATE_SELECTABLE_TEXT |
STATE_DEFAULT |
STATE_ANIMATED |
STATE_VISITED |
STATE_CHECKABLE |
STATE_HAS_POPUP |
STATE_HAS_TOOLTIP |
STATE_READ_ONLY |
STATE_LAST_DEFINED |

## TextBoundary

enum Atk::TextBoundary

Text boundary types used for specifying boundaries for regions of text.

This enumerationis deprecated since 2.9.4 and should not be used. Use AtkTextGranularity with #atk_text_get_string_at_offset instead.

Enumerator
TEXT_BOUNDARY_CHAR | Boundary is the boundary between characters (including non-printing characters).
TEXT_BOUNDARY_WORD_START | Boundary is the start (i.e. first character) of a word.
TEXT_BOUNDARY_WORD_END | Boundary is the end (i.e. last character) of a word.
TEXT_BOUNDARY_SENTENCE_START | Boundary is the first character in a sentence.
TEXT_BOUNDARY_SENTENCE_END | Boundary is the last (terminal) character in a sentence; in languages which use "sentence stop" punctuation such as English, the boundary is thus the '. ', '?', or similar terminal punctuation character.
TEXT_BOUNDARY_LINE_START | Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character.
TEXT_BOUNDARY_LINE_END | Boundary is the linefeed, or return character.

## TextClipType

enum Atk::TextClipType

Describes the type of clipping required.

Enumerator
TEXT_CLIP_NONE | No clipping to be done.
TEXT_CLIP_MIN | Text clipped by min coordinate is omitted.
TEXT_CLIP_MAX | Text clipped by max coordinate is omitted.
TEXT_CLIP_BOTH | Only text fully within mix/max bound is retained.

## TextGranularity

enum Atk::TextGranularity

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

Enumerator
TEXT_GRANULARITY_CHAR | Granularity is defined by the boundaries between characters (including non-printing characters).
TEXT_GRANULARITY_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.
TEXT_GRANULARITY_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.
TEXT_GRANULARITY_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.
TEXT_GRANULARITY_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.