Enums

Details

class Atspi.CollectionMatchType(value)

Bases: GObject.GEnum

Enumeration used by Atspi.MatchRule to specify how to interpret Atspi.Accessible objects.

INVALID = 0

Indicates an error condition or uninitialized value.

ALL = 1

True if all of the criteria are met.

ANY = 2

True if any of the criteria are met.

NONE = 3

True if none of the criteria are met.

EMPTY = 4

Same as ATSPI_Collection_MATCH_ALL if the criteria is non-empty; for empty criteria this rule requires returned value to also have empty set.

LAST_DEFINED = 5

Used only to determine the end of the enumeration.

class Atspi.CollectionSortOrder(value)

Bases: GObject.GEnum

Enumeration used by interface Atspi.Collection to specify the way #AtspiAccesible objects should be sorted.

INVALID = 0

Invalid sort order

CANONICAL = 1

Canonical sort order

FLOW = 2

Flow sort order

TAB = 3

Tab sort order

REVERSE_CANONICAL = 4

Reverse canonical sort order

REVERSE_FLOW = 5

Reverse flow sort order

REVERSE_TAB = 6

Reverse tab sort order

LAST_DEFINED = 7

Used only to determine the end of the enumeration.

class Atspi.CollectionTreeTraversalType(value)

Bases: GObject.GEnum

Enumeration used by interface Atspi.Collection to specify restrictions on #AtspiAccesible objects to be traversed.

RESTRICT_CHILDREN = 0

Restrict children tree traveral

RESTRICT_SIBLING = 1

Restrict sibling tree traversal

INORDER = 2

In-order tree traversal.

LAST_DEFINED = 3

Used only to determine the end of the enumeration.

class Atspi.ComponentLayer(value)

Bases: GObject.GEnum

The Atspi.ComponentLayer of an Atspi.Component instance indicates its relative stacking order with respect to the onscreen visual representation of the UI. Atspi.ComponentLayer, in combination with Atspi.Component bounds information, can be used to compute the visibility of all or part of a component. This is important in programmatic determination of region-of-interest for magnification, and in flat screen review models of the screen, as well as for other uses. Objects residing in two of the Atspi.ComponentLayer categories support further z-ordering information, with respect to their peers in the same layer: namely, Atspi.ComponentLayer.WINDOW and Atspi.ComponentLayer.MDI. Relative stacking order for other objects within the same layer is not available; the recommended heuristic is first child paints first. In other words, assume that the first siblings in the child list are subject to being overpainted by later siblings if their bounds intersect. The order of layers, from bottom to top, is: Atspi.ComponentLayer.BACKGROUND, Atspi.ComponentLayer.WINDOW, Atspi.ComponentLayer.MDI, Atspi.ComponentLayer.CANVAS, Atspi.ComponentLayer.WIDGET, Atspi.ComponentLayer.POPUP, and Atspi.ComponentLayer.OVERLAY.

INVALID = 0

Indicates an error condition or uninitialized value.

BACKGROUND = 1

The bottom-most layer, over which everything else is painted. The ‘desktop background’ is generally in this layer.

CANVAS = 2

The ‘background’ layer for most content renderers and UI Atspi.Component containers.

WIDGET = 3

The layer in which the majority of ordinary ‘foreground’ widgets reside.

MDI = 4

A special layer between Atspi.ComponentLayer.CANVAS and Atspi.ComponentLayer.WIDGET, in which the ‘pseudo windows’ (e.g. the MDI frames) reside. See Atspi.Component.get_mdi_z_order.

POPUP = 5

A layer for popup window content, above Atspi.ComponentLayer.WIDGET.

OVERLAY = 6

The topmost layer.

WINDOW = 7

The layer in which a toplevel window background usually resides.

LAST_DEFINED = 8

Used only to determine the end of the enumeration.

class Atspi.CoordType(value)

Bases: GObject.GEnum

Enumeration used by Atspi.Component, Atspi.Image, and Atspi.Text interfaces to specify whether coordinates are relative to the window or the screen.

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.

class Atspi.EventType(value)

Bases: GObject.GEnum

Enumeration used to specify the event types of interest to an Atspi.EventListener, or to identify the type of an event for which notification has been sent.

KEY_PRESSED_EVENT = 0

Indicates that a key on a keyboard device was pressed.

KEY_RELEASED_EVENT = 1

Indicates that a key on a keyboard device was released.

BUTTON_PRESSED_EVENT = 2

Indicates that a button on a non-keyboard human interface device (HID) was pressed.

BUTTON_RELEASED_EVENT = 3

Indicates that a button on a non-keyboard human interface device (HID) was released.

class Atspi.KeyEventType(value)

Bases: GObject.GEnum

Deprecated. Should not be used.

PRESSED = 0

Key press event

RELEASED = 1

Key release event

class Atspi.KeySynthType(value)

Bases: GObject.GEnum

Enumeration used when synthesizing keyboard input via Atspi.generate_keyboard_event.

PRESS = 0

Emulates the pressing of a hardware keyboard key.

RELEASE = 1

Emulates the release of a hardware keyboard key.

PRESSRELEASE = 2

Emulates the pressing and immediate releasing of a hardware keyboard key.

SYM = 3

A symbolic key event is generated, without specifying a hardware key. Note: if the keysym is not present in the current keyboard map, the #AtspiDeviceEventController instance has a limited ability to generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent calls using out-of-keymap keysyms will vary from system to system, and on the number of different out-of-keymap keysyms being generated in quick succession. In practice this is rarely significant, since the keysyms of interest to AT clients and keyboard emulators are usually part of the current keymap, i.e., present on the system keyboard for the current locale (even if a physical hardware keyboard is not connected).

STRING = 4

A string is converted to its equivalent keyboard events and emitted. If the string consists of complex characters or composed characters which are not in the current keymap, string emission is subject to the out-of-keymap limitations described for Atspi.KeySynthType.SYM. In practice this limitation primarily effects Chinese and Japanese locales.

LOCKMODIFIERS = 5

Emulates locking a set of modifiers.

UNLOCKMODIFIERS = 6

Emulates unlocking a set of modifiers.

class Atspi.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 “announcement” events, but it may be used for additional purposes in the future.

NONE = 0

No live region.

POLITE = 1

This live region should be considered polite.

ASSERTIVE = 2

This live region should be considered assertive.

class Atspi.LocaleType(value)

Bases: GObject.GEnum

Used by interfaces Atspi.Text and Atspi.Document, this enumeration corresponds to the POSIX ‘setlocale’ enum values.

MESSAGES = 0

For localizable natural-language messages.

COLLATE = 1

For regular expression matching and string collation.

CTYPE = 2

For regular expression matching, character classification, conversion, case-sensitive comparison, and wide character functions.

MONETARY = 3

For monetary formatting.

NUMERIC = 4

For number formatting (such as the decimal point and the thousands separator).

TIME = 5

For time and date formatting.

class Atspi.ModifierType(value)

Bases: GObject.GEnum

SHIFT = 0

The left or right ‘Shift’ key.

SHIFTLOCK = 1

The ShiftLock or CapsLock key.

NUMLOCK = 14

A symbolic meta key name that is mapped by AT-SPI to the appropriate META value, for the convenience of the client.

CONTROL = 2

‘Control’/’Ctrl’.

ALT = 3

The Alt key (as opposed to AltGr).

META = 4

Depending on the platform, this may map to ‘Window’, ‘Function’, ‘Meta’, ‘Menu’, or ‘NumLock’. Such ‘Meta keys’ will map to one of META, META2, META3. On X Windows platforms these META values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an event having Atspi.ModifierType.META2 means that the ‘Mod2Mask’ bit is set in the corresponding XEvent.

META2 = 5

See Atspi.ModifierType.META.

META3 = 6

See Atspi.ModifierType.META.

class Atspi.RelationType(value)

Bases: GObject.GEnum

Atspi.RelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship. It allows better semantic identification of how objects are associated with one another. For instance the Atspi.RelationType.LABELLED_BY relationship may be used to identify labelling information that should accompany the accessible name property when presenting an object’s content or identity to the end user. Similarly, Atspi.RelationType.CONTROLLER_FOR can be used to further specify the context in which a valuator is useful, and/or the other UI components which are directly effected by user interactions with the valuator. Common examples include association of scrollbars with the viewport or panel which they control.

Enumeration used to specify the type of relation encapsulated in an Atspi.Relation object.

NULL = 0

Not a meaningful relationship; clients should not normally encounter this Atspi.RelationType value.

LABEL_FOR = 1

Object is a label for one or more other objects.

FLOWS_TO = 10

Object renders content which flows logically to another object. For instance, text in a paragraph may flow to another object which is not the ‘next sibling’ in the accessibility hierarchy.

FLOWS_FROM = 11

Reciprocal of Atspi.RelationType.FLOWS_TO.

SUBWINDOW_OF = 12

Object is visually and semantically considered a subwindow of another object, even though it is not the object’s child. Useful when dealing with embedded applications and other cases where the widget hierarchy does not map cleanly to the onscreen presentation.

EMBEDS = 13

Similar to Atspi.RelationType.SUBWINDOW_OF, but specifically used for cross-process embedding.

EMBEDDED_BY = 14

Reciprocal of Atspi.RelationType.EMBEDS. Used to denote content rendered by embedded renderers that live in a separate process space from the embedding context.

POPUP_FOR = 15

Denotes that the object is a transient window or frame associated with another onscreen object. Similar to ATSPI_TOOLTIP_FOR, but more general. Useful for windows which are technically toplevels but which, for one or more reasons, do not explicitly cause their associated window to lose ‘window focus’. Creation of an Atspi.Role.WINDOW object with the Atspi.RelationType.POPUP_FOR relation usually requires some presentation action on the part of assistive technology clients, even though the previous toplevel Atspi.Role.FRAME object may still be the active window.

PARENT_WINDOW_OF = 16

This is the reciprocal relation to Atspi.RelationType.POPUP_FOR.

DESCRIPTION_FOR = 17

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

DESCRIBED_BY = 18

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

DETAILS = 19

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

New in version 2.26.

LABELLED_BY = 2

Object is labelled by one or more other objects.

DETAILS_FOR = 20

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

New in version 2.26.

ERROR_MESSAGE = 21

Reciprocal of Atspi.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 Atspi.StateType.INVALID_ENTRY in their Atspi.StateSet.

New in version 2.26.

ERROR_FOR = 22

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

New in version 2.26.

LAST_DEFINED = 23

Do not use as a parameter value, used to determine the size of the enumeration.

CONTROLLER_FOR = 3

Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects.

CONTROLLED_BY = 4

Object state, position, etc. is modified/controlled by user interaction with one or more other objects. For instance a viewport or scroll pane may be Atspi.RelationType.CONTROLLED_BY scrollbars.

MEMBER_OF = 5

Object has a grouping relationship (e.g. ‘same group as’) to one or more other objects.

TOOLTIP_FOR = 6

Object is a tooltip associated with another object.

NODE_CHILD_OF = 7

Object is a child of the target.

NODE_PARENT_OF = 8

Object is a parent of the target.

EXTENDED = 9

Used to indicate that a relationship exists, but its type is not specified in the enumeration.

class Atspi.Role(value)

Bases: GObject.GEnum

Enumeration used by interface Atspi.Accessible to specify the role of an Atspi.Accessible object.

classmethod get_localized_name(role)
Parameters:

role (Atspi.Role) – an Atspi.Role object to query.

Returns:

the localized string describing the Atspi.Role

Return type:

str

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

classmethod get_name(role)
Parameters:

role (Atspi.Role) – an Atspi.Role object to query.

Returns:

a localizable string name for an Atspi.Role enumerated type.

Return type:

str

Gets a localizable string that indicates the name of an Atspi.Role.

INVALID = 0

A role indicating an error condition, such as uninitialized Role data.

ACCELERATOR_LABEL = 1

Object is a label indicating the keyboard accelerators for the parent.

COLUMN_HEADER = 10

The header for a column of data.

IMAGE_MAP = 100

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.

NOTIFICATION = 101

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

INFO_BAR = 102

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

LEVEL_BAR = 103

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

TITLE_BAR = 104

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

New in version 2.12.

BLOCK_QUOTE = 105

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

New in version 2.12.

AUDIO = 106

An object which represents an audio element.

New in version 2.12.

VIDEO = 107

An object which represents a video element.

New in version 2.12.

DEFINITION = 108

A definition of a term or concept.

New in version 2.12.

ARTICLE = 109

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.

COMBO_BOX = 11

A list of choices the user can select from.

LANDMARK = 110

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

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.

MARQUEE = 112

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

A text widget or container that holds a mathematical expression.

New in version 2.12.

RATING = 114

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

New in version 2.12.

TIMER = 115

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.

STATIC = 116

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 Atspi.Role.STATIC is appropriate include the message displayed in a message box and an image used as an alternative means to display text. Atspi.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. The displayed information, as a general rule, should be exposed through the accessible name of the object. For labels which describe another widget, see Atspi.Role.LABEL. For text views, see Atspi.Role.TEXT. For generic containers, see Atspi.Role.PANEL. For objects whose role is not known by the implementor, see Atspi.Role.UNKNOWN.

New in version 2.16.

MATH_FRACTION = 117

An object that represents a mathematical fraction.

New in version 2.16.

MATH_ROOT = 118

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

New in version 2.16.

SUBSCRIPT = 119

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

New in version 2.16.

DATE_EDITOR = 12

An object which allows entry of a date.

SUPERSCRIPT = 120

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

New in version 2.16.

DESCRIPTION_LIST = 121

An object that represents a list of term-value groups. A term-value group represents an individual description and consist of one or more names (Atspi.Role.DESCRIPTION_TERM) followed by one or more values (Atspi.Role.DESCRIPTION_VALUE). For each list, there should not be more than one group with the same term name.

New in version 2.26.

DESCRIPTION_TERM = 122

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

New in version 2.26.

DESCRIPTION_VALUE = 123

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

New in version 2.26.

FOOTNOTE = 124

An object that contains the text of a footnote.

New in version 2.26.

CONTENT_DELETION = 125

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

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

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

New in version 2.36.

SUGGESTION = 128

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. An object with this role should include children with Atspi.Role.CONTENT_DELETION and/or Atspi.Role.CONTENT_INSERTION, in any order, to indicate what the actual change is.

New in version 2.36.

PUSH_BUTTON_MENU = 129

A specialized push button to open a menu.

New in version 2.46.

DESKTOP_ICON = 13

An inconifed internal frame within a DESKTOP_FRAME.

LAST_DEFINED = 130

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

DESKTOP_FRAME = 14

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

DIAL = 15

An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element.

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 displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename.

ALERT = 2

Object is used to alert the user about something.

FILLER = 20

A object that fills up space in a user interface.

FOCUS_TRAVERSABLE = 21

Don’t use, reserved for future use.

FONT_CHOOSER = 22

Allows selection of a display font.

FRAME = 23

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

GLASS_PANE = 24

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

HTML_CONTAINER = 25

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

ICON = 26

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

IMAGE = 27

An image, typically static.

INTERNAL_FRAME = 28

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

LABEL = 29

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

ANIMATION = 3

Object contains a dynamic or moving image of some kind.

LAYERED_PANE = 30

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

LIST = 31

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

LIST_ITEM = 32

An object that represents an element of a list.

MENU = 33

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

MENU_BAR = 34

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

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

OPTION_PANE = 36

A specialized pane whose primary use is inside a dialog.

PAGE_TAB = 37

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

PAGE_TAB_LIST = 38

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

PANEL = 39

A generic container that is often used to group objects.

ARROW = 4

Object is a 2d directional indicator.

PASSWORD_TEXT = 40

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

POPUP_MENU = 41

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

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

PUSH_BUTTON = 43

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

RADIO_BUTTON = 44

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

Object is both a menu item and a “radio button” . See Atspi.Role.RADIO_BUTTON.

ROOT_PANE = 46

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

ROW_HEADER = 47

The header for a row of data.

SCROLL_BAR = 48

An object usually used to allow a user to incrementally view a large amount of data by moving the bounds of a viewport along a one-dimensional axis.

SCROLL_PANE = 49

An object that allows a user to incrementally view a large amount of information. Atspi.Role.SCROLL_PANE objects are usually accompanied by Atspi.Role.SCROLL_BAR controllers, on which the Atspi.RelationType.CONTROLLER_FOR and Atspi.RelationType.CONTROLLED_BY reciprocal relations are set. See #atspi_get_relation_set.

CALENDAR = 5

Object contains one or more dates, usually arranged into a 2d list.

SEPARATOR = 50

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

SLIDER = 51

An object that allows the user to select from a bounded range. Unlike Atspi.Role.SCROLL_BAR, Atspi.Role.SLIDER objects need not control ‘viewport’-like objects.

SPIN_BUTTON = 52

An object which allows one of a set of choices to be selected, and which displays the current choice.

SPLIT_PANE = 53

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

STATUS_BAR = 54

Object displays non-quantitative status information (c.f. Atspi.Role.PROGRESS_BAR)

TABLE = 55

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

TABLE_CELL = 56

A ‘cell’ or discrete child within a Table. Note: Table cells need not have Atspi.Role.TABLE_CELL, other #AtspiRoleType values are valid as well.

TABLE_COLUMN_HEADER = 57

An object which labels a particular column in an Atspi.Table.

TABLE_ROW_HEADER = 58

An object which labels a particular row in a Atspi.Table. Atspi.Table rows and columns may also be labelled via the Atspi.RelationType.LABEL_FOR/Atspi.RelationType.LABELLED_BY relationships. See #atspi_get_relation_set.

TEAROFF_MENU_ITEM = 59

Object allows menu to be removed from menubar and shown in its own window.

CANVAS = 6

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

TERMINAL = 60

An object that emulates a terminal.

TEXT = 61

An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus Atspi.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 Atspi.Role.ENTRY and Atspi.Role.PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see Atspi.Role.STATIC.

TOGGLE_BUTTON = 62

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

TOOL_BAR = 63

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

TOOL_TIP = 64

An object that provides information about another object.

TREE = 65

An object used to repsent hierarchical information to the user.

TREE_TABLE = 66

An object that presents both tabular and hierarchical info to the user.

UNKNOWN = 67

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

VIEWPORT = 68

An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport.

WINDOW = 69

A top level window with no title or border.

CHECK_BOX = 7

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

EXTENDED = 70

means that the role for this item is known, but not included in the core enumeration. Deprecated since 2.24.

HEADER = 71

An object that serves as a document header.

FOOTER = 72

An object that serves as a document footer.

PARAGRAPH = 73

An object which is contains a single paragraph of text content. See also Atspi.Role.TEXT.

RULER = 74

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

APPLICATION = 75

An object corresponding to the toplevel accessible of an application, which may contain Atspi.Role.FRAME objects or other accessible objects. Children of objects with the Atspi.Role.DESKTOP_FRAME role are generally Atspi.Role.APPLICATION objects.

AUTOCOMPLETE = 76

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.

EDITBAR = 77

The object is an editable text object in a toolbar.

EMBEDDED = 78

The object is an embedded component container. This role is a “grouping” hint that the contained objects share a context which is different from the container in which this accessible is embedded. In particular, it is used for some kinds of document embedding, and for embedding of out-of-process component, “panel applets”, etc.

ENTRY = 79

The object is a component whose textual content may be entered or modified by the user, provided Atspi.StateType.EDITABLE is present. A readonly Atspi.Role.ENTRY object (i.e. where Atspi.StateType.EDITABLE is not present) implies a read-only ‘text field’ in a form, as opposed to a title, label, or caption.

CHECK_MENU_ITEM = 8

A menu item that behaves like a check box. See Atspi.Role.CHECK_BOX.

CHART = 80

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 ATSPI_LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible description property. See Atspi.Role.CAPTION.

CAPTION = 81

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

DOCUMENT_FRAME = 82

The object is a visual frame or container which contains a view of document content. Atspi.Document frames may occur within another Atspi.Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often Atspi.Role.DOCUMENT_FRAME: Either this object, or a singleton descendant, should implement the Atspi.Document interface.

HEADING = 83

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

The object is a containing instance which encapsulates a page of information. Atspi.Role.PAGE is used in documents and content which support a paginated navigation model.

SECTION = 85

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.

REDUNDANT_OBJECT = 86

The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should be ignored by clients, if they are encountered at all.

FORM = 87

The object is a containing instance of document content which has within it components with which the user can interact in order to input information; i.e. the object is a container for pushbuttons, comboboxes, text input fields, and other ‘GUI’ components. Atspi.Role.FORM should not, in general, be used for toplevel GUI containers or dialogs, but should be reserved for ‘GUI’ containers which occur within document content, for instance within Web documents, presentations, or text documents. Unlike other GUI containers and dialogs which occur inside application instances, Atspi.Role.FORM containers’ components are associated with the current document, rather than the current foreground application or viewer instance.

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 Atspi.Hypertext/Atspi.Hyperlink interfacesto indicate the range/location within a text object where an inline or embedded object lies.

INPUT_METHOD_WINDOW = 89

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

COLOR_CHOOSER = 9

A specialized dialog that lets the user choose a color.

TABLE_ROW = 90

A row in a table.

TREE_ITEM = 91

An object that represents an element of a tree.

DOCUMENT_SPREADSHEET = 92

A document frame which contains a spreadsheet.

DOCUMENT_PRESENTATION = 93

A document frame which contains a presentation or slide content.

DOCUMENT_TEXT = 94

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

DOCUMENT_WEB = 95

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

DOCUMENT_EMAIL = 96

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

COMMENT = 97

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.

LIST_BOX = 98

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

GROUPING = 99

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

class Atspi.ScrollType(value)

Bases: GObject.GEnum

Enumeration used by interface Atspi.Accessible to specify where an Atspi.Accessible object should be placed on the screen when using scroll_to.

TOP_LEFT = 0

Scroll the object to the top left corner of the window.

BOTTOM_RIGHT = 1

Scroll the object to the bottom right corner of the window.

TOP_EDGE = 2

Scroll the object to the top edge of the window.

BOTTOM_EDGE = 3

Scroll the object to the bottom edge of the window.

LEFT_EDGE = 4

Scroll the object to the left edge of the window.

RIGHT_EDGE = 5

Scroll the object to the right edge of the window.

ANYWHERE = 6

Scroll the object to application-dependent position on the window.

class Atspi.StateType(value)

Bases: GObject.GEnum

Enumeration used by various interfaces indicating every possible state an #AtspiAccesible object can assume.

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. Atspi.StateType.ACTIVE should not be used for objects which have Atspi.StateType.FOCUSABLE or Atspi.StateType.SELECTABLE: Those objects should use Atspi.StateType.FOCUSED and Atspi.StateType.SELECTED respectively. Atspi.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.

EXPANDED = 10

Indicates this object is expanded.

FOCUSABLE = 11

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

Indicates this object currently has the keyboard focus.

HAS_TOOLTIP = 13

Indicates that the object has an associated tooltip.

HORIZONTAL = 14

Indicates the orientation of this object is horizontal.

ICONIFIED = 15

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

MODAL = 16

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

MULTI_LINE = 17

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

MULTISELECTABLE = 18

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

Indicates this object paints every pixel within its rectangular region. It also indicates an alpha value of unity, if it supports alpha blending.

ARMED = 2

Indicates that the object is armed.

PRESSED = 20

Indicates this object is currently pressed.

RESIZABLE = 21

Indicates the size of this object’s size is not fixed.

SELECTABLE = 22

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

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

Indicates this object is sensitive, e.g. to user interaction. Atspi.StateType.SENSITIVE usually accompanies. Atspi.StateType.ENABLED for user-actionable controls, but may be found in the absence of Atspi.StateType.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 Atspi.StateType.SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. See Atspi.StateType.ENABLED, Atspi.StateType.INDETERMINATE.

SHOWING = 25

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

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

STALE = 27

Indicates that the information returned for this object may no longer be synchronized with the application state. This can occur if the object has Atspi.StateType.TRANSIENT, and can also occur towards the end of the object peer’s lifecycle.

TRANSIENT = 28

Indicates this object is transient.

VERTICAL = 29

Indicates the orientation of this object is vertical; for example this state may appear on such objects as scrollbars, text objects (with vertical text flow), separators, etc.

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.

VISIBLE = 30

Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. Atspi.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 Atspi.StateType.VISIBLE and Atspi.StateType.SHOWING. The absence of Atspi.StateType.VISIBLE and Atspi.StateType.SHOWING is semantically equivalent to saying that an object is ‘hidden’.

MANAGES_DESCENDANTS = 31

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 Atspi.StateType.MANAGES_DESCENDANTS is an indication to the client that the children should not, and need not, be enumerated by the client. Objects implementing this state are expected to provide relevant state notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children.

INDETERMINATE = 32

Indicates that a check box or other boolean indicator is in a state other than checked or not checked. This usually means that the boolean value reflected or controlled by the object does not apply consistently to the entire current context. For example, a checkbox for the “Bold” attribute of text may have Atspi.StateType.INDETERMINATE if the currently selected text contains a mixture of weight attributes. In many cases interacting with a Atspi.StateType.INDETERMINATE object will cause the context’s corresponding boolean attribute to be homogenized, whereupon the object will lose Atspi.StateType.INDETERMINATE and a corresponding state-changed event will be fired.

REQUIRED = 33

Indicates that user interaction with this object is ‘required’ from the user, for instance before completing the processing of a form.

TRUNCATED = 34

Indicates that an object’s onscreen content is truncated, e.g. a text value in a spreadsheet cell.

ANIMATED = 35

Indicates this object’s visual representation is dynamic, not static. This state may be applied to an object during an animated ‘effect’ and be removed from the object once its visual representation becomes static. 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.

INVALID_ENTRY = 36

This object has indicated 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 = 37

This state 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 Atspi.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 source.

SELECTABLE_TEXT = 38

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

IS_DEFAULT = 39

This state indicates that the object in question is the ‘default’ interaction object in a dialog, i.e. the one that gets activated if the user presses “Enter” when the dialog is initially posted.

CHECKED = 4

Indicates this object is currently checked.

VISITED = 40

This state indicates that the object (typically a hyperlink) has already been activated or invoked, with the result that some backing data has been downloaded or rendered.

CHECKABLE = 41

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

New in version 2.12.

HAS_POPUP = 42

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.

READ_ONLY = 43

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

New in version 2.16.

LAST_DEFINED = 44

This value of the enumeration should not be used as a parameter, it indicates the number of items in the Atspi.StateType enumeration.

COLLAPSED = 5

Indicates this object is collapsed.

DEFUNCT = 6

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

EDITABLE = 7

Indicates the user can change the contents of this object.

ENABLED = 8

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 Atspi.StateType.SENSITIVE if direct user interaction cannot cause them to acquire Atspi.StateType.ENABLED. See Atspi.StateType.SENSITIVE.

EXPANDABLE = 9

Indicates this object allows progressive disclosure of its children.

class Atspi.TextBoundaryType(value)

Bases: GObject.GEnum

Specifies the boundary conditions determining a run of text as returned from Atspi.Text.get_text_at_offset, Atspi.Text.get_text_after_offset, and Atspi.Text.get_text_before_offset.

This enumerationis deprecated since 2.9.90 and should not be used. Use Atspi.TextGranularity with Atspi.Text.get_string_at_offset instead.

CHAR = 0

An Atspi.Text instance is bounded by this character only. Start and end offsets differ by one, by definition, for this value.

WORD_START = 1

Boundary condition is start of a word; i.e. range is from start of one word to the start of another word.

WORD_END = 2

Boundary condition is the end of a word; i.e. range is from the end of one word to the end of another. Some locales may not distinguish between words and characters or glyphs. In particular, those locales which use wholly or partially ideographic character sets. In these cases, characters may be returned in lieu of multi-character substrings.

SENTENCE_START = 3

Boundary condition is start of a sentence, as determined by the application. Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines of text instead of grammatical sentences.

SENTENCE_END = 4

Boundary condition is end of a sentence, as determined by the application, including the sentence-delimiting character, for instance ‘.’ Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines of text instead of grammatical sentences.

LINE_START = 5

Boundary condition is the start of a line; i.e. range is from start of one line to the start of another. This generally means that an end-of-line character will appear at the end of the range.

LINE_END = 6

Boundary condition is the end of a line; i.e. range is from start of one line to the start of another. This generally means that an end-of-line character will be the first character of the range.

class Atspi.TextClipType(value)

Bases: GObject.GEnum

Enumeration used by interface Atspi.Text to indicate how to treat characters intersecting bounding boxes.

NONE = 0

No characters/glyphs are omitted.

MIN = 1

Characters/glyphs clipped by the minimum coordinate are omitted.

MAX = 2

Characters/glyphs which intersect the maximum coordinate are omitted.

BOTH = 3

Only glyphs falling entirely within the region bounded by min and max are retained.

class Atspi.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.