atkmm 2.28.4
Classes | Typedefs | Enumerations | Functions
Atk Namespace Reference

The ATK interface which provides standard mechanism for manipulating hyperlinks. More...

Classes

class  Action
 The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e. More...
 
class  Attribute
 
struct  AttributeTraits
 
class  Component
 The ATK interface provided by UI components which occupy a physical area on the screen. More...
 
class  Document
 The ATK interface which allows access to a DOM associated with on object. More...
 
class  EditableText
 The ATK interface implemented by components containing user-editable text content. More...
 
class  Hyperlink
 Encapsulates a link or set of links in a hypertext document. More...
 
class  Hypertext
 
class  Image
 The ATK Interface implemented by components which expose image or pixmap content on-screen. More...
 
class  Implementor
 
class  NoOpObject
 An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces. More...
 
class  Object
 The base object class for the Accessibility Toolkit API. More...
 
class  ObjectAccessible
 This object class is derived from AtkObject and can be used as a basis implementing accessible objects. More...
 
class  Range
 A given range or subrange, to be used with Atk::Value. More...
 
class  Relation
 An Atk::Relation describes a relation between an object and one or more other objects. More...
 
class  RelationSet
 A set of Atk::Relations, normally the set of AtkRelations which an Atk::Object has. More...
 
class  Selection
 The ATK interface implemented by container objects whose Atk::Object children can be selected. More...
 
class  StateSet
 An AtkStateSet determines a component's state set. More...
 
class  StreamableContent
 The ATK interface which provides access to streamable content. More...
 
class  Table
 The ATK interface implemented for UI components which contain tabular or row/column information. More...
 
class  Text
 The ATK interface implemented by components with text content. More...
 
class  TextAttribute
 
class  Value
 The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. More...
 

Typedefs

typedef guint64 State
 
typedef Glib::SListHandle< Attribute, AttributeTraitsAttributeSet
 

Enumerations

enum  CoordType {
  XY_SCREEN ,
  XY_WINDOW
}
 
enum  Layer {
  LAYER_INVALID ,
  LAYER_BACKGROUND ,
  LAYER_CANVAS ,
  LAYER_WIDGET ,
  LAYER_MDI ,
  LAYER_POPUP ,
  LAYER_OVERLAY ,
  LAYER_WINDOW
}
 
enum  Role {
  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
}
 
enum  RelationType {
  RELATION_NULL ,
  RELATION_CONTROLLED_BY ,
  RELATION_CONTROLLER_FOR ,
  RELATION_LABEL_FOR ,
  RELATION_LABELLED_BY ,
  RELATION_MEMBER_OF ,
  RELATION_NODE_CHILD_OF ,
  RELATION_FLOWS_TO ,
  RELATION_FLOWS_FROM ,
  RELATION_SUBWINDOW_OF ,
  RELATION_EMBEDS ,
  RELATION_EMBEDDED_BY ,
  RELATION_POPUP_FOR ,
  RELATION_PARENT_WINDOW_OF ,
  RELATION_DESCRIBED_BY ,
  RELATION_DESCRIPTION_FOR ,
  RELATION_NODE_PARENT_OF ,
  RELATION_LAST_DEFINED
}
 
enum  StateType {
  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
}
 
enum  BuiltinTextAttribute {
  TEXT_ATTR_INVALID ,
  TEXT_ATTR_LEFT_MARGIN ,
  TEXT_ATTR_RIGHT_MARGIN ,
  TEXT_ATTR_INDENT ,
  TEXT_ATTR_INVISIBLE ,
  TEXT_ATTR_EDITABLE ,
  TEXT_ATTR_PIXELS_ABOVE_LINES ,
  TEXT_ATTR_PIXELS_BELOW_LINES ,
  TEXT_ATTR_PIXELS_INSIDE_WRAP ,
  TEXT_ATTR_BG_FULL_HEIGHT ,
  TEXT_ATTR_RISE ,
  TEXT_ATTR_UNDERLINE ,
  TEXT_ATTR_STRIKETHROUGH ,
  TEXT_ATTR_SIZE ,
  TEXT_ATTR_SCALE ,
  TEXT_ATTR_WEIGHT ,
  TEXT_ATTR_LANGUAGE ,
  TEXT_ATTR_FAMILY_NAME ,
  TEXT_ATTR_BG_COLOR ,
  TEXT_ATTR_FG_COLOR ,
  TEXT_ATTR_BG_STIPPLE ,
  TEXT_ATTR_FG_STIPPLE ,
  TEXT_ATTR_WRAP_MODE ,
  TEXT_ATTR_DIRECTION ,
  TEXT_ATTR_JUSTIFICATION ,
  TEXT_ATTR_STRETCH ,
  TEXT_ATTR_VARIANT ,
  TEXT_ATTR_STYLE ,
  TEXT_ATTR_LAST_DEFINED
}
 
enum  TextBoundary {
  TEXT_BOUNDARY_CHAR ,
  TEXT_BOUNDARY_WORD_START ,
  TEXT_BOUNDARY_WORD_END ,
  TEXT_BOUNDARY_SENTENCE_START ,
  TEXT_BOUNDARY_SENTENCE_END ,
  TEXT_BOUNDARY_LINE_START ,
  TEXT_BOUNDARY_LINE_END
}
 
enum  TextClipType {
  TEXT_CLIP_NONE ,
  TEXT_CLIP_MIN ,
  TEXT_CLIP_MAX ,
  TEXT_CLIP_BOTH
}
 
enum  TextGranularity {
  TEXT_GRANULARITY_CHAR ,
  TEXT_GRANULARITY_WORD ,
  TEXT_GRANULARITY_SENTENCE ,
  TEXT_GRANULARITY_LINE ,
  TEXT_GRANULARITY_PARAGRAPH
}
 

Functions

void init ()
 Initialize atkmm.
 

Detailed Description

The ATK interface which provides standard mechanism for manipulating hyperlinks.

Typedef Documentation

◆ AttributeSet

◆ State

typedef guint64 Atk::State

Enumeration Type Documentation

◆ BuiltinTextAttribute

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

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

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.

◆ TextBoundary

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

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

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.

Function Documentation

◆ init()

void Atk::init ( )

Initialize atkmm.

You may call this more than once. You do not need to call this if you are using Gtk::Main, because it calls this for you.