Enums

Details

class Atk.CoordType(value)

Bases: GObject.GEnum

Specifies how xy coordinates are to be interpreted. Used by functions such as Atk.Component.get_position() and Atk.Text.get_character_extents()

SCREEN = 0

specifies xy coordinates relative to the screen

WINDOW = 1

specifies xy coordinates relative to the widget’s top-level window

PARENT = 2

specifies xy coordinates relative to the widget’s immediate parent.

New in version 2.30.

class Atk.KeyEventType(value)

Bases: GObject.GEnum

Specifies the type of a keyboard evemt.

PRESS = 0

specifies a key press event

RELEASE = 1

specifies a key release event

LAST_DEFINED = 2

Not a valid value; specifies end of enumeration

class Atk.Layer(value)

Bases: GObject.GEnum

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.

INVALID = 0

The object does not have a layer

BACKGROUND = 1

This layer is reserved for the desktop background

CANVAS = 2

This layer is used for Canvas components

WIDGET = 3

This layer is normally used for components

MDI = 4

This layer is used for layered components

POPUP = 5

This layer is used for popup components, such as menus

OVERLAY = 6

This layer is reserved for future use.

WINDOW = 7

This layer is used for toplevel windows.

class Atk.Live(value)

Bases: GObject.GEnum

Enumeration used to indicate a type of live region and how assertive it should be in terms of speaking notifications. Currently, this is only used for “notification” events, but it may be used for additional purposes in the future.

New in version 2.50.

NONE = 0

No live region.

POLITE = 1

This live region should be considered polite.

ASSERTIVE = 2

This live region should be considered assertive.

class Atk.RelationType(value)

Bases: GObject.GEnum

Describes the type of the relation

classmethod for_name(name)[source]
Parameters:

name (str) – a string which is the (non-localized) name of an ATK relation type.

Returns:

the Atk.RelationType enumerated type corresponding to the specified name, or Atk.RelationType.NULL if no matching relation type is found.

Return type:

Atk.RelationType

Get the Atk.RelationType type corresponding to a relation name.

classmethod get_name(type)[source]
Parameters:

type (Atk.RelationType) – The Atk.RelationType whose name is required

Returns:

the string describing the Atk.RelationType

Return type:

str

Gets the description string describing the Atk.RelationType type.

classmethod register(name)[source]
Parameters:

name (str) – a name string

Returns:

an Atk.RelationType associated with name

Return type:

Atk.RelationType

Associate name with a new Atk.RelationType

NULL = 0

Not used, represens “no relationship” or an error condition.

CONTROLLED_BY = 1

Indicates an object controlled by one or more target objects.

EMBEDS = 10

Indicates that the object visually embeds another object’s content, i.e. this object’s content flows around another’s content.

EMBEDDED_BY = 11

Reciprocal of Atk.RelationType.EMBEDS, indicates that this object’s content is visualy embedded in another object.

POPUP_FOR = 12

Indicates that an object is a popup for another object.

PARENT_WINDOW_OF = 13

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

DESCRIBED_BY = 14

Reciprocal of Atk.RelationType.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.RelationType.LABELLED_BY. For an on-screen error message, use Atk.RelationType.ERROR_MESSAGE. For lengthy extended descriptive information contained in an on-screen object, consider using Atk.RelationType.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 = 15

Reciprocal of Atk.RelationType.DESCRIBED_BY. Indicates that this object provides descriptive information about the target object(s). See also Atk.RelationType.DETAILS_FOR and Atk.RelationType.ERROR_FOR.

NODE_PARENT_OF = 16

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

DETAILS = 17

Reciprocal of Atk.RelationType.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.RelationType.DESCRIBED_BY. If the detailed information describes an error condition, Atk.RelationType.ERROR_FOR should be used instead.

New in version 2.26.

DETAILS_FOR = 18

Reciprocal of Atk.RelationType.DETAILS. Indicates that this object provides a detailed or extended description about the target object(s). See also Atk.RelationType.DESCRIPTION_FOR and Atk.RelationType.ERROR_FOR.

New in version 2.26.

ERROR_MESSAGE = 19

Reciprocal of Atk.RelationType.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.

New in version 2.26.

CONTROLLER_FOR = 2

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

ERROR_FOR = 20

Reciprocal of Atk.RelationType.ERROR_MESSAGE. Indicates that this object contains an error message describing an invalid condition in the target object(s).

New in version ATK_2.26.

LAST_DEFINED = 21

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

LABEL_FOR = 3

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

LABELLED_BY = 4

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

MEMBER_OF = 5

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

NODE_CHILD_OF = 6

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

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

FLOWS_FROM = 8

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

SUBWINDOW_OF = 9

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

class Atk.Role(value)

Bases: GObject.GEnum

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 Atk.Role >= Atk.Role.LAST_DEFINED is not necessarily an error.

classmethod for_name(name)[source]
Parameters:

name (str) – a string which is the (non-localized) name of an ATK role.

Returns:

the Atk.Role enumerated type corresponding to the specified name, or Atk.Role.INVALID if no matching role is found.

Return type:

Atk.Role

Get the Atk.Role type corresponding to a rolew name.

classmethod get_localized_name(role)[source]
Parameters:

role (Atk.Role) – The Atk.Role whose localized name is required

Returns:

the localized string describing the Atk.Role

Return type:

str

Gets the localized description string describing the Atk.Role role.

classmethod get_name(role)[source]
Parameters:

role (Atk.Role) – The Atk.Role whose name is required

Returns:

the string describing the Atk.Role

Return type:

str

Gets the description string describing the Atk.Role role.

classmethod register(name)[source]
Parameters:

name (str) – a character string describing the new role.

Returns:

an Atk.Role for the new role if added properly. Atk.Role.INVALID in case of error.

Return type:

Atk.Role

Registers the role specified by name. name must be a meaningful name. So it should not be empty, or consisting on whitespaces.

Deprecated since version 2.12: If your application/toolkit doesn’t find a suitable role for a specific object defined at Atk.Role, please submit a bug in order to add a new role to the specification.

INVALID = 0

Invalid role

ACCELERATOR_LABEL = 1

A label which represents an accelerator

COLUMN_HEADER = 10

The header for a column of data

INFO_BAR = 100

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

New in version 2.1.0.

LEVEL_BAR = 101

A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery.

New in version 2.7.3.

TITLE_BAR = 102

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

New in version 2.12.

BLOCK_QUOTE = 103

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

New in version 2.12.

AUDIO = 104

An object which represents an audio element.

New in version 2.12.

VIDEO = 105

An object which represents a video element.

New in version 2.12.

DEFINITION = 106

A definition of a term or concept.

New in version 2.12.

ARTICLE = 107

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.

New in version 2.12.

LANDMARK = 108

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.

New in version 2.12.

LOG = 109

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.

New in version 2.12.

COMBO_BOX = 11

A collapsible list of choices the user can select from

MARQUEE = 110

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.

New in version 2.12.

MATH = 111

A text widget or container that holds a mathematical expression.

New in version 2.12.

RATING = 112

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 Atk.Value.

New in version 2.12.

TIMER = 113

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.

New in version 2.12.

DESCRIPTION_LIST = 114

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.

New in version 2.12.

DESCRIPTION_TERM = 115

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

New in version 2.12.

DESCRIPTION_VALUE = 116

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

New in version 2.12.

STATIC = 117

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.

New in version 2.16.

MATH_FRACTION = 118

An object that represents a mathematical fraction.

New in version 2.16.

MATH_ROOT = 119

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

New in version 2.16.

DATE_EDITOR = 12

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

SUBSCRIPT = 120

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

New in version 2.16.

SUPERSCRIPT = 121

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

New in version 2.16.

FOOTNOTE = 122

An object that contains the text of a footnote.

New in version 2.26.

CONTENT_DELETION = 123

Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers.

New in version 2.34.

CONTENT_INSERTION = 124

Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers.

New in version 2.34.

MARK = 125

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.RelationType.DETAILS should be used on the mark to point to that associated section. In addition, the reciprocal relation Atk.RelationType.DETAILS_FOR should be used on the associated content section to point back to the mark.

New in version 2.36.

SUGGESTION = 126

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.

New in version 2.36.

PUSH_BUTTON_MENU = 127

A specialized push button to open a menu.

New in version 2.46.

LAST_DEFINED = 128

not a valid role, used for finding end of the enumeration

DESKTOP_ICON = 13

An inconifed internal frame within a DESKTOP_PANE

DESKTOP_FRAME = 14

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

DIAL = 15

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

DIALOG = 16

A top level window with title bar and a border

DIRECTORY_PANE = 17

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

DRAWING_AREA = 18

An object used for drawing custom user interface elements

FILE_CHOOSER = 19

A specialized dialog that lets the user choose a file

ALERT = 2

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.

FILLER = 20

A object that fills up space in a user interface

FONT_CHOOSER = 21

A specialized dialog that lets the user choose a font

FRAME = 22

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

GLASS_PANE = 23

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

HTML_CONTAINER = 24

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

ICON = 25

A small fixed size picture, typically used to decorate components

IMAGE = 26

An object whose primary purpose is to display an image

INTERNAL_FRAME = 27

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

LABEL = 28

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

LAYERED_PANE = 29

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

ANIMATION = 3

An object which is an animated image

LIST = 30

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

LIST_ITEM = 31

An object that represents an element of a list

MENU = 32

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

MENU_BAR = 33

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

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

OPTION_PANE = 35

A specialized pane whose primary use is inside a DIALOG

PAGE_TAB = 36

An object that is a child of a page tab list

PAGE_TAB_LIST = 37

An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object

PANEL = 38

A generic container that is often used to group objects

PASSWORD_TEXT = 39

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

ARROW = 4

An arrow in one of the four cardinal directions

POPUP_MENU = 40

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

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

PUSH_BUTTON = 42

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

RADIO_BUTTON = 43

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

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

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

ROW_HEADER = 46

The header for a row of data

SCROLL_BAR = 47

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

SCROLL_PANE = 48

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

SEPARATOR = 49

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

CALENDAR = 5

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

SLIDER = 50

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

SPLIT_PANE = 51

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

SPIN_BUTTON = 52

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

STATUSBAR = 53

An object which reports messages of minor importance to the user

TABLE = 54

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

TABLE_CELL = 55

A cell in a table

TABLE_COLUMN_HEADER = 56

The header for a column of a table

TABLE_ROW_HEADER = 57

The header for a row of a table

TEAR_OFF_MENU_ITEM = 58

A menu item used to tear off and reattach its menu

TERMINAL = 59

An object that represents an accessible terminal.

New in version 0.6.

CANVAS = 6

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

TEXT = 60

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

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

TOOL_BAR = 62

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

TOOL_TIP = 63

An object that provides information about another object

TREE = 64

An object used to represent hierarchical information to the user

TREE_TABLE = 65

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

New in version 0.7.

UNKNOWN = 66

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

VIEWPORT = 67

An object usually used in a scroll pane

WINDOW = 68

A top level window with no title or border.

HEADER = 69

An object that serves as a document header.

New in version 1.1.1.

CHECK_BOX = 7

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

FOOTER = 70

An object that serves as a document footer.

New in version 1.1.1.

PARAGRAPH = 71

An object which is contains a paragraph of text content.

New in version 1.1.1.

RULER = 72

An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).

New in version 1.1.1.

APPLICATION = 73

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.

New in version 1.1.4.

AUTOCOMPLETE = 74

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.

New in version 1.3.

EDIT_BAR = 75

The object is an editable text object in a toolbar.

New in version 1.5.

EMBEDDED = 76

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.

New in version 1.7.2.

ENTRY = 77

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

New in version 1.11.

CHART = 78

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.

New in version 1.11.

CAPTION = 79

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

New in version 1.11.

CHECK_MENU_ITEM = 8

A menu item with a check box

DOCUMENT_FRAME = 80

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.

New in version 1.11.

HEADING = 81

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

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.

New in version 1.11.

SECTION = 83

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.

New in version 1.11.

REDUNDANT_OBJECT = 84

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.

New in version 1.11.

FORM = 85

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.

New in version 1.12.0.

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.

New in version 1.12.1.

INPUT_METHOD_WINDOW = 87

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

New in version 1.12.1.

TABLE_ROW = 88

A row in a table.

New in version 2.1.0.

TREE_ITEM = 89

An object that represents an element of a tree.

New in version 2.1.0.

COLOR_CHOOSER = 9

A specialized dialog that lets the user choose a color

DOCUMENT_SPREADSHEET = 90

A document frame which contains a spreadsheet.

New in version 2.1.0.

DOCUMENT_PRESENTATION = 91

A document frame which contains a presentation or slide content.

New in version 2.1.0.

DOCUMENT_TEXT = 92

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

New in version 2.1.0.

DOCUMENT_WEB = 93

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

New in version 2.1.0.

DOCUMENT_EMAIL = 94

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

New in version 2.1.0.

COMMENT = 95

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.

New in version 2.1.0.

LIST_BOX = 96

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

New in version 2.1.0.

GROUPING = 97

A group of related widgets. This group typically has a label.

New in version 2.1.0.

IMAGE_MAP = 98

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.

New in version 2.1.0.

NOTIFICATION = 99

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

New in version 2.1.0.

class Atk.ScrollType(value)

Bases: GObject.GEnum

Specifies where an object should be placed on the screen when using scroll_to.

New in version 2.30.

TOP_LEFT = 0

Scroll the object vertically and horizontally to bring its top left corner to the top left corner of the window.

BOTTOM_RIGHT = 1

Scroll the object vertically and horizontally to bring its bottom right corner to the bottom right corner of the window.

TOP_EDGE = 2

Scroll the object vertically to bring its top edge to the top edge of the window.

BOTTOM_EDGE = 3

Scroll the object vertically to bring its bottom edge to the bottom edge of the window.

LEFT_EDGE = 4

Scroll the object vertically and horizontally to bring its left edge to the left edge of the window.

RIGHT_EDGE = 5

Scroll the object vertically and horizontally to bring its right edge to the right edge of the window.

ANYWHERE = 6

Scroll the object vertically and horizontally so that as much as possible of the object becomes visible. The exact placement is determined by the application.

class Atk.StateType(value)

Bases: GObject.GEnum

The possible types of states of an object

classmethod for_name(name)[source]
Parameters:

name (str) – a character string state name

Returns:

an Atk.StateType corresponding to name

Return type:

Atk.StateType

Gets the Atk.StateType corresponding to the description string name.

classmethod get_name(type)[source]
Parameters:

type (Atk.StateType) – The Atk.StateType whose name is required

Returns:

the string describing the Atk.StateType

Return type:

str

Gets the description string describing the Atk.StateType type.

classmethod register(name)[source]
Parameters:

name (str) – a character string describing the new state.

Returns:

an #AtkState value for the new state.

Return type:

Atk.StateType

Register a new object state.

INVALID = 0

Indicates an invalid state - probably an error condition.

ACTIVE = 1

Indicates a window is currently the active window, or an object is the active subelement within a container or table. Atk.StateType.ACTIVE should not be used for objects which have Atk.StateType.FOCUSABLE or Atk.StateType.SELECTABLE: Those objects should use Atk.StateType.FOCUSED and Atk.StateType.SELECTED respectively. Atk.StateType.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.

FOCUSABLE = 10

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

Indicates this object currently has the keyboard focus

HORIZONTAL = 12

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

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

MODAL = 14

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

MULTI_LINE = 15

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

MULTISELECTABLE = 16

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

Indicates this object paints every pixel within its rectangular region.

PRESSED = 18

Indicates this object is currently pressed.

RESIZABLE = 19

Indicates the size of this object is not fixed

ARMED = 2

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.StateType.ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code.

SELECTABLE = 20

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

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

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

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

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

STALE = 25

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

Indicates this object is transient, i.e. a snapshot which may not emit events when its state changes. Data from objects with Atk.StateType.TRANSIENT should not be cached, since there may be no notification given when the cached data becomes obsolete.

VERTICAL = 27

Indicates the orientation of this object is vertical

VISIBLE = 28

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

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.

BUSY = 3

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.StateType.BUSY flag is removed.

INDETERMINATE = 30

Indicates that the value, or some other quantifiable property, of this Atk.Object 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 = 31

Indicates that an object is truncated, e.g. a text value in a speradsheet cell.

REQUIRED = 32

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

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

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 Atk.Text interface. This state supplants Atk.Role.AUTOCOMPLETE.

SELECTABLE_TEXT = 35

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.StateType.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 = 36

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

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

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

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

New in version 2.12.

CHECKED = 4

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

HAS_POPUP = 40

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.

New in version 2.12.

HAS_TOOLTIP = 41

Indicates this object has a tooltip.

New in version 2.16.

READ_ONLY = 42

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.StateType.READ_ONLY should not be applied. See also Atk.StateType.EDITABLE.

New in version 2.16.

COLLAPSED = 43

Indicates this object is collapsed.

New in version 2.38.

LAST_DEFINED = 44

Not a valid state, used for finding end of enumeration

DEFUNCT = 5

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

EDITABLE = 6

Indicates that this object can contain text, and that the user can change the textual contents of this object by editing those contents directly. 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.StateType.EDITABLE and should contain Atk.StateType.READ_ONLY.

ENABLED = 7

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.StateType.SENSITIVE

EXPANDABLE = 8

Indicates this object allows progressive disclosure of its children

EXPANDED = 9

Indicates this object its expanded - see Atk.StateType.EXPANDABLE above

class Atk.TextAttribute(value)

Bases: GObject.GEnum

Describes the text attributes supported

classmethod for_name(name)[source]
Parameters:

name (str) – a string which is the (non-localized) name of an ATK text attribute.

Returns:

the Atk.TextAttribute enumerated type corresponding to the specified name, or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found.

Return type:

Atk.TextAttribute

Get the Atk.TextAttribute type corresponding to a text attribute name.

classmethod get_name(attr)[source]
Parameters:

attr (Atk.TextAttribute) – The Atk.TextAttribute whose name is required

Returns:

a string containing the name; this string should not be freed

Return type:

str

Gets the name corresponding to the Atk.TextAttribute

classmethod get_value(attr, index_)[source]
Parameters:
Returns:

a string containing the value; this string should not be freed; None is returned if there are no values maintained for the attr value.

Return type:

str or None

Gets the value for the index of the Atk.TextAttribute

classmethod register(name)[source]
Parameters:

name (str) – a name string

Returns:

an Atk.TextAttribute associated with name

Return type:

Atk.TextAttribute

Associate name with a new Atk.TextAttribute

INVALID = 0

Invalid attribute, like bad spelling or grammar.

LEFT_MARGIN = 1

The pixel width of the left margin

RISE = 10

Number of pixels that the characters are risen above the baseline. See also Atk.TextAttribute.TEXT_POSITION.

UNDERLINE = 11

“none”, “single”, “double”, “low”, or “error”

STRIKETHROUGH = 12

“true” or “false” whether the text is strikethrough

SIZE = 13

The size of the characters in points. eg: 10

SCALE = 14

The scale of the characters. The value is a string representation of a double

WEIGHT = 15

The weight of the characters.

LANGUAGE = 16

The language used

FAMILY_NAME = 17

The font family name

BG_COLOR = 18

The background color. The value is an RGB value of the format “%u,%u,%u”

FG_COLOR = 19

The foreground color. The value is an RGB value of the format “%u,%u,%u”

RIGHT_MARGIN = 2

The pixel width of the right margin

BG_STIPPLE = 20

“true” if a #GdkBitmap is set for stippling the background color.

FG_STIPPLE = 21

“true” if a #GdkBitmap is set for stippling the foreground color.

WRAP_MODE = 22

The wrap mode of the text, if any. Values are “none”, “str", “word”, or “word_char”.

DIRECTION = 23

The direction of the text, if set. Values are “none”, “ltr” or “rtl”

JUSTIFICATION = 24

The justification of the text, if set. Values are “left”, “right”, “center” or “fill”

STRETCH = 25

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

The capitalization variant of the text, if set. Values are “normal” or “small_caps”

STYLE = 27

The slant style of the text, if set. Values are “normal”, “oblique” or “italic”

TEXT_POSITION = 28

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

not a valid text attribute, used for finding end of enumeration

INDENT = 3

The number of pixels that the text is indented

INVISIBLE = 4

Either “true” or “false” indicating whether text is visible or not

EDITABLE = 5

Either “true” or “false” indicating whether text is editable or not

PIXELS_ABOVE_LINES = 6

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

PIXELS_BELOW_LINES = 7

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

PIXELS_INSIDE_WRAP = 8

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

BG_FULL_HEIGHT = 9

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

class Atk.TextBoundary(value)

Bases: GObject.GEnum

Text boundary types used for specifying boundaries for regions of text. This enumeration is deprecated since 2.9.4 and should not be used. Use Atk.TextGranularity with Atk.Text.get_string_at_offset instead.

CHAR = 0

Boundary is the boundary between characters (including non-printing characters)

WORD_START = 1

Boundary is the start (i.e. first character) of a word.

WORD_END = 2

Boundary is the end (i.e. last character) of a word.

SENTENCE_START = 3

Boundary is the first character in a sentence.

SENTENCE_END = 4

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.

LINE_START = 5

Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character.

LINE_END = 6

Boundary is the linefeed, or return character.

class Atk.TextClipType(value)

Bases: GObject.GEnum

Describes the type of clipping required.

NONE = 0

No clipping to be done

MIN = 1

Text clipped by min coordinate is omitted

MAX = 2

Text clipped by max coordinate is omitted

BOTH = 3

Only text fully within mix/max bound is retained

class Atk.TextGranularity(value)

Bases: GObject.GEnum

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

CHAR = 0

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

WORD = 1

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

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

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

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.

class Atk.ValueType(value)

Bases: GObject.GEnum

Default types for a given value. Those are defined in order to easily get localized strings to describe a given value or a given subrange, using Atk.ValueType.get_localized_name().

classmethod get_localized_name(value_type)[source]
Parameters:

value_type (Atk.ValueType) – The Atk.ValueType whose localized name is required

Returns:

the localized string describing the Atk.ValueType

Return type:

str

Gets the localized description string describing the Atk.ValueType value_type.

classmethod get_name(value_type)[source]
Parameters:

value_type (Atk.ValueType) – The Atk.ValueType whose name is required

Returns:

the string describing the Atk.ValueType

Return type:

str

Gets the description string describing the Atk.ValueType value_type.

VERY_WEAK = 0
WEAK = 1
VERY_BAD = 10
BAD = 11
GOOD = 12
VERY_GOOD = 13
BEST = 14
LAST_DEFINED = 15
ACCEPTABLE = 2
STRONG = 3
VERY_STRONG = 4
VERY_LOW = 5
LOW = 6
MEDIUM = 7
HIGH = 8
VERY_HIGH = 9