The base interface which is implemented by all accessible objects. All objects support interfaces for querying their contained 'children' and position in the accessible-object hierarchy, whether or not they actually have children. Clears the cached information for the given accessible and all of its descendants. The #AtspiAccessible whose cache to clear. Clears the cached information only for the given accessible. The #AtspiAccessible whose cache to clear. Gets the accessible id of the accessible. This is not meant to be presented to the user, but to be an id which is stable over application development. Typically, this is the gtkbuilder id. a character string representing the accessible id of the #AtspiAccessible object or NULL on exception. an #AtspiAccessible Gets the #AtspiAction interface for an #AtspiAccessible. Use atspi_accessible_get_action_iface instead. a pointer to an #AtspiAction interface instance, or NULL if @obj does not implement #AtspiAction. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiAction interface for an #AtspiAccessible. a pointer to an #AtspiAction interface instance, or NULL if @obj does not implement #AtspiAction. a pointer to the #AtspiAccessible instance to query. Gets the containing #AtspiApplication for an object. the containing #AtspiApplication instance for this object. The #AtspiAccessible being queried. Gets the AT-SPI IPC specification version supported by the application pointed to by the #AtspiAccessible object. Only works on application root objects. a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the #AttributeSet representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes instead. The name-value-pair attributes assigned to this object. The #AtspiAccessible being queried. Gets a #GArray representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes_as_array instead. The name-value-pair attributes assigned to this object. The #AtspiAccessible being queried. Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index. a pointer to the #AtspiAccessible child object at index @child_index or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. a #long indicating which child is specified. Gets the number of children contained by an #AtspiAccessible object. a #long indicating the number of #AtspiAccessible children contained by an #AtspiAccessible object or -1 on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiCollection interface for an #AtspiAccessible. Use atspi_accessible_get_collection_iface instead. a pointer to an #AtspiCollection interface instance, or NULL if @obj does not implement #AtspiCollection. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiCollection interface for an #AtspiAccessible. a pointer to an #AtspiCollection interface instance, or NULL if @obj does not implement #AtspiCollection. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiComponent interface for an #AtspiAccessible. Use atspi_accessible_get_component_iface instead. a pointer to an #AtspiComponent interface instance, or NULL if @obj does not implement #AtspiComponent. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiComponent interface for an #AtspiAccessible. a pointer to an #AtspiComponent interface instance, or NULL if @obj does not implement #AtspiComponent. a pointer to the #AtspiAccessible instance to query. Gets the description of an #AtspiAccessible object. a UTF-8 string describing the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiDocument interface for an #AtspiAccessible. Use atspi_accessible_get_document_iface instead. a pointer to an #AtspiDocument interface instance, or NULL if @obj does not implement #AtspiDocument. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiDocument interface for an #AtspiAccessible. a pointer to an #AtspiDocument interface instance, or NULL if @obj does not implement #AtspiDocument. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiEditableText interface for an #AtspiAccessible. Use atspi_accessible_get_editable_text_iface instead. a pointer to an #AtspiEditableText interface instance, or NULL if @obj does not implement #AtspiEditableText. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiEditableText interface for an #AtspiAccessible. a pointer to an #AtspiEditableText interface instance, or NULL if @obj does not implement #AtspiEditableText. a pointer to the #AtspiAccessible instance to query. Gets the help text associated with the accessible, if set. When this is present, it provides information that a screen reader can relay to the user to explain how to interact with the object. a character string representing the help text for the #AtspiAccessible object or NULL on exception. an #AtspiAccessible Gets the #AtspiHyperlink interface for an #AtspiAccessible. the #AtspiHyperlink object associated with the given #AtspiAccessible, or NULL if not supported. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiHypertext interface for an #AtspiAccessible. Use atspi_accessible_get_hypertext_iface instead. a pointer to an #AtspiHypertext interface instance, or NULL if @obj does not implement #AtspiHypertext. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiHypertext interface for an #AtspiAccessible. a pointer to an #AtspiHypertext interface instance, or NULL if @obj does not implement #AtspiHypertext. a pointer to the #AtspiAccessible instance to query. Gets the application id for a #AtspiAccessible object. Only works on application root objects. a positive #gint indicating the id for the #AtspiAccessible object or -1 on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiImage interface for an #AtspiAccessible. Use atspi_accessible_get_image_iface instead. a pointer to an #AtspiImage interface instance, or NULL if @obj does not implement #AtspiImage. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiImage interface for an #AtspiAccessible. a pointer to an #AtspiImage interface instance, or NULL if @obj does not implement #AtspiImage. a pointer to the #AtspiAccessible instance to query. Gets the index of an #AtspiAccessible object within its parent's #AtspiAccessible children list. a #glong indicating the index of the #AtspiAccessible object in its parent, or -1 if @obj has no containing parent or on exception. a pointer to the #AtspiAccessible object on which to operate. A set of pointers to all interfaces supported by an #AtspiAccessible. A #GArray of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (i.e. "Component", "Text" etc.). The #AtspiAccessible to query. Gets a UTF-8 string corresponding to the name of the role played by an object, translated to the current locale. This method will return useful values for roles that fall outside the enumeration used in atspi_accessible_getRole (). a localized, UTF-8 string specifying the type of UI role played by an #AtspiAccessible object. a pointer to the #AtspiAccessible object on which to operate. Gets the name of an #AtspiAccessible object. a UTF-8 string indicating the name of the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. Gets an #AtspiAccessible object's parent container. a pointer to the #AtspiAccessible object which contains the given #AtspiAccessible instance, or NULL if the @obj has no parent container. a pointer to the #AtspiAccessible object to query. Returns the process id associated with the given accessible. Mainly added for debugging; it is a shortcut to explicitly querying the accessible's app->bus_name and then calling GetConnectionUnixProcessID. The process ID or undetermined value if @error is set. The #AtspiAccessible to query. Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's relationships with other #AtspiAccessible objects. a #GArray of #AtspiRelation pointers or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the UI role played by an #AtspiAccessible object. This role's name can be obtained via atspi_accessible_get_role_name (). the #AtspiRole of an #AtspiAccessible object. a pointer to the #AtspiAccessible object on which to operate. Gets a UTF-8 string corresponding to the name of the role played by an object. This method will return useful values for roles that fall outside the enumeration used in atspi_accessible_get_role (). a UTF-8 string specifying the type of UI role played by an #AtspiAccessible object. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiSelection interface for an #AtspiAccessible. Use atspi_accessible_get_selection_iface instead. a pointer to an #AtspiSelection interface instance, or NULL if @obj does not implement #AtspiSelection. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiSelection interface for an #AtspiAccessible. a pointer to an #AtspiSelection interface instance, or NULL if @obj does not implement #AtspiSelection. a pointer to the #AtspiAccessible instance to query. Gets the states currently held by an object. a pointer to an #AtspiStateSet representing an object's current state set. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiTable interface for an #AtspiAccessible. Use atspi_accessible_get_table_iface instead. a pointer to an #AtspiTable interface instance, or NULL if @obj does not implement #AtspiTable. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiTableCell interface for an #AtspiAccessible. a pointer to an #AtspiTableCell interface instance, or NULL if @obj does not implement #AtspiTable. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiTable interface for an #AtspiAccessible. a pointer to an #AtspiTable interface instance, or NULL if @obj does not implement #AtspiTable. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiTable interface for an #AtspiAccessible. Use atspi_accessible_get_text_iface instead. a pointer to an #AtspiText interface instance, or NULL if @obj does not implement #AtspiText. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiTable interface for an #AtspiAccessible. a pointer to an #AtspiText interface instance, or NULL if @obj does not implement #AtspiText. a pointer to the #AtspiAccessible instance to query. Gets the toolkit name for an #AtspiAccessible object. Only works on application root objects. a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the toolkit version for an #AtspiAccessible object. Only works on application root objects. a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiTable interface for an #AtspiAccessible. Use atspi_accessible_get_value_iface instead. a pointer to an #AtspiValue interface instance, or NULL if @obj does not implement #AtspiValue. a pointer to the #AtspiAccessible instance to query. Gets the #AtspiTable interface for an #AtspiAccessible. a pointer to an #AtspiValue interface instance, or NULL if @obj does not implement #AtspiValue. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiAction interface. #TRUE if @obj implements the #AtspiAction interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiApplication interface. #TRUE if @obj implements the #AtspiApplication interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiCollection interface. #TRUE if @obj implements the #AtspiCollection interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements #AtspiComponent. #TRUE if @obj implements the #AtspiComponent interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiDocument interface. #TRUE if @obj implements the #AtspiDocument interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiEditableText interface. #TRUE if @obj implements the #AtspiEditableText interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiHyperlink interface. #TRUE if @obj implements the #AtspiHypertext interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiHypertext interface. #TRUE if @obj implements the #AtspiHypertext interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiImage interface. #TRUE if @obj implements the #AtspiImage interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiSelection interface. #TRUE if @obj implements the #AtspiSelection interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiTable interface. #TRUE if @obj implements the #AtspiTable interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiTableCell interface. #TRUE if @obj implements the #AtspiTable interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiText interface. #TRUE if @obj implements the #AtspiText interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Query whether the specified #AtspiAccessible implements the #AtspiValue interface. #TRUE if @obj implements the #AtspiValue interface, #FALSE otherwise. a pointer to the #AtspiAccessible instance to query. Sets the type of data to cache for accessibles. If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED, then the desktop's cache flag will be used. If the desktop's cache flag is also undefined, then all possible data will be cached. This function is intended to work around bugs in toolkits where the proper events are not raised / to aid in testing for such bugs. The #AtspiAccessible to operate on. Must be the desktop or the root of an application. An #AtspiCache specifying a bit mask of the types of data to cache. The signal "mode-changed" is emitted by a screen reader to indicate that its mode has changed. This signal supports the following details: focus-tracking flat-review mouse-review say-all caret-tracking a boolean specifying whether the mode is being toggled on or off. an optional string explaining why the mode changed. The signal "region-changed" is emitted by a screen reader to indicate that it is now reading or tracking a new object, or, a new piece of text within an object. This allows a magnifier to gain the information needed to highlight the object that the screen reader is reading. an integer specifying the current offset of the text being read, if the object is textual. an integer specifying the ending offset of the text being read, if the object is textual. Invoke the action indicated by #index. #TRUE if the action is successfully invoked, otherwise #FALSE. a pointer to the #AtspiAction to query. an integer specifying which action to invoke. Get the description of '@i-th' action invocable on an object implementing #AtspiAction. a UTF-8 string describing the '@i-th' invocable action. a pointer to the #AtspiAction implementor to query. an integer indicating which action to query. Get the name of the '@i-th' action invocable on an object implementing #AtspiAction. the non-localized name of the action, as a UTF-8 string. a pointer to the #AtspiAction implementor to query. an integer indicating which action to query. Get the description of '@i-th' action invocable on an object implementing #AtspiAction. Use atspi_action_get_action_description instead. a UTF-8 string describing the '@i-th' invocable action. a pointer to the #AtspiAction implementor to query. an integer indicating which action to query. Get the keybindings for the @i-th action invocable on an object implementing #AtspiAction, if any are defined. The keybindings string format is as follows: there are multiple parts to a keybinding string (typically 3). They are delimited with ";". The first is the action's keybinding which is usable if the object implementing the action is currently posted to the screen, e.g. if a menu is posted then these keybindings for the corresponding menu-items are available. The second keybinding substring is the full key sequence necessary to post the action's widget and activate it, e.g. for a menu item such as "File->Open" it would both post the menu and activate the item. Thus the second keybinding string is available during the lifetime of the containing toplevel window as a whole, whereas the first keybinding string only works while the object implementing AtkAction is posted. The third (and optional) keybinding string is the "keyboard shortcut" which invokes the action without posting any menus. Meta-keys are indicated by the conventional strings "<Control>", "<Alt>", "<Shift>", "<Mod2>", etc. (we use the same string as gtk_accelerator_name() in gtk+-2.X. a UTF-8 string which can be parsed to determine the @i-th invocable action's keybindings. a pointer to the #AtspiAction implementor to query. an integer indicating which action to query. Get the name of the '@i-th' action invocable on an object implementing #AtspiAction. the name of the action, as a UTF-8 string. a pointer to the #AtspiAction implementor to query. an integer indicating which action to query. Get the number of actions invokable on an #AtspiAction implementor. an integer indicating the number of invocable actions. a pointer to the #AtspiAction to query. Get the name of the '@i-th' action invocable on an object implementing #AtspiAction. Use atspi_action_get_action_name instead. the non-localized name of the action, as a UTF-8 string. a pointer to the #AtspiAction implementor to query. an integer indicating which action to query. An interface identifying the root object associated with a running application. An interface identifying an object which is the root of the hierarchy associated with a running application. One higher than the highest valid value of #AtspiComponentLayer. One higher than the highest valid value of #AtspiCoordType. An interface designed to allow accessibles which satisfy a set of criteria to be returned. An interface designed to allow accessibles which satisfy a set of criteria to be returned. This interface can be used to avoid iteration or client-side search of the object tree. The active descendant of the given object. Not yet implemented. Gets all #AtspiAccessible objects from the @collection matching a given @rule. All #AtspiAccessible objects matching the given match rule. A pointer to the #AtspiCollection to query. An #AtspiMatchRule describing the match criteria. An #AtspiCollectionSortOrder specifying the way the results are to be sorted. The maximum number of results to return, or 0 for no limit. Not supported. Gets all #AtspiAccessible objects from the @collection, before @current_object, matching a given @rule. All #AtspiAccessible objects matching the given match rule that preceed @current_object. A pointer to the #AtspiCollection to query. Upon reaching this object, searching should stop. An #AtspiMatchRule describing the match criteria. An #AtspiCollectionSortOrder specifying the way the results are to be sorted. An #AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed. The maximum number of results to return, or 0 for no limit. Not supported. Gets all #AtspiAccessible objects from the @collection, after @current_object, matching a given @rule. All #AtspiAccessible objects matching the given match rule after @current_object. A pointer to the #AtspiCollection to query. The object at which to start searching. An #AtspiMatchRule describing the match criteria. An #AtspiCollectionSortOrder specifying the way the results are to be sorted. An #AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed. If #TRUE, only descendants of @current_object's parent will be returned. Otherwise (if #FALSE), any accessible may be returned if it would preceed @current_object in a flattened hierarchy. The maximum number of results to return, or 0 for no limit. Not supported. Not yet implemented. Enumeration used by #AtspiMatchRule to specify how to interpret #AtspiAccessible objects. Indicates an error condition or uninitialized value. #TRUE if all of the criteria are met. #TRUE if any of the criteria are met. #TRUE if none of the criteria are met. 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. Used only to determine the end of the enumeration. Enumeration used by interface #AtspiCollection to specify the way #AtspiAccesible objects should be sorted. Invalid sort order Canonical sort order Flow sort order Tab sort order Reverse canonical sort order Reverse flow sort order Reverse tab sort order Used only to determine the end of the enumeration. Enumeration used by interface #AtspiCollection to specify restrictions on #AtspiAccesible objects to be traversed. Restrict children tree traveral Restrict sibling tree traversal In-order tree traversal. Used only to determine the end of the enumeration. An interface implemented by objects which have onscreen visual representations. The Component interface is implemented by objects which occupy on-screen space, e.g. objects which have onscreen visual representations. The methods in Component allow clients to identify where the objects lie in the onscreen coordinate system, their relative size, stacking order, and position. It also provides a mechanism whereby keyboard focus may be transferred to specific user interface elements programmatically. This is a 2D API. Coordinates of 3D objects are projected into the 2-dimensional screen view for purposes of this interface. Queries whether a given #AtspiComponent contains a particular point. #TRUE if the specified component contains the point (@x, @y), #FALSE otherwise. a pointer to the #AtspiComponent to query. a #gint specifying the x coordinate in question. a #gint specifying the y coordinate in question. the desired coordinate system of the point (@x, @y) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN). Gets the accessible child at a given coordinate within an #AtspiComponent. a pointer to an #AtspiAccessible child of the specified component which contains the point (@x, @y), or NULL if no child contains the point. a pointer to the #AtspiComponent to query. a #gint specifying the x coordinate of the point in question. a #gint specifying the y coordinate of the point in question. the coordinate system of the point (@x, @y) (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Gets the opacity/alpha value of a component, if alpha blending is in use. the opacity value of a component, as a #gdouble between 0.0 and 1.0. The #AtspiComponent to be queried. Gets the bounding box of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING. An #AtspiRect giving the accessible's extents. a pointer to the #AtspiComponent to query. the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Queries which layer the component is painted into, to help determine its visibility in terms of stacking order. the #AtspiComponentLayer into which this component is painted. a pointer to the #AtspiComponent to query. Queries the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top) a #gshort indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer. a pointer to the #AtspiComponent to query. Gets the minimum x and y coordinates of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING. An #AtspiPoint giving the @obj's position. a pointer to the #AtspiComponent to query. the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Gets the size of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING. An #AtspiPoint giving the @obj's size. a pointer to the #AtspiComponent to query. Attempts to set the keyboard input focus to the specified #AtspiComponent. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiComponent on which to operate. Scrolls whatever container of the #AtspiComponent object so it becomes visible on the screen. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiComponent object on which to operate. a #AtspiScrollType indicating where the object should be placed on the screen. Scrolls whatever container of the #AtspiComponent object so it becomes visible on the screen at a given position. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiComponent object on which to operate. a #AtspiCoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object. the x coordinate of the point to reach the y coordinate of the point to reach Moves and resizes the specified component. #TRUE if successful; #FALSE otherwise. a pointer to the #AtspiComponent to move. the new horizontal position to which the component should be moved. the new vertical position to which the component should be moved. the width to which the component should be resized. the height to which the component should be resized. the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Moves the component to the specified position. #TRUE if successful; #FALSE otherwise. a pointer to the #AtspiComponent to move. the new horizontal position to which the component should be moved. the new vertical position to which the component should be moved. the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Resizes the specified component to the given pixel dimensions. #TRUE if successful; #FALSE otherwise. a pointer to the #AtspiComponent to query. the width to which the component should be resized. the height to which the component should be resized. The #AtspiComponentLayer of an #AtspiComponent instance indicates its relative stacking order with respect to the onscreen visual representation of the UI. #AtspiComponentLayer, in combination with #AtspiComponent 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 #AtspiComponentLayer categories support further z-ordering information, with respect to their peers in the same layer: namely, @ATSPI_LAYER_WINDOW and @ATSPI_LAYER_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_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI, @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and @ATSPI_LAYER_OVERLAY. Indicates an error condition or uninitialized value. The bottom-most layer, over which everything else is painted. The 'desktop background' is generally in this layer. The 'background' layer for most content renderers and UI #AtspiComponent containers. The layer in which the majority of ordinary 'foreground' widgets reside. A special layer between @ATSPI_LAYER_CANVAS and @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) reside. See #atspi_component_get_mdi_z_order. A layer for popup window content, above @ATSPI_LAYER_WIDGET. The topmost layer. The layer in which a toplevel window background usually resides. Used only to determine the end of the enumeration. Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces to specify whether coordinates are relative to the window or the screen. Specifies xy coordinates relative to the screen. Specifies xy coordinates relative to the widget's top-level window. Specifies xy coordinates relative to the widget's immediate parent. Creates a new #AtspiDevice with a specified callback function. a pointer to a newly-created #AtspiDevice. Synthesizes a mouse event at a specific screen coordinate. Most AT clients should use the #AccessibleAction interface when tempted to generate mouse events, rather than this method. Event names: b1p = button 1 press; b2r = button 2 release; b3c = button 3 click; b2d = button 2 double-click; abs = absolute motion; rel = relative motion. the device. The #AtspiAccessible that should receive the click. a #gint indicating the x coordinate of the mouse event, relative to @obj.. a #gint indicating the y coordinate of the mouse event, relative to @obj.. a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs"). Returns the locked modifiers (ie, num lock, caps lock) associated with this keyboard. a guint of modifier flags. the device. Gets the modifier for a given keycode, if one exists. Does not create a new mapping. This function should be used when the intention is to query a locking modifier such as num lock via atspi_device_get_locked_modifiers, rather than to add key grabs. the modifier that is mapped to this keycode. the device. the keycode to map. Attempts to grab the entire keyboard. This should only be done temporarily, as it may conflict with other applications that also want to grab the keyboard. #TRUE if successful, #FALSE otherwise. Maps the specified key code to a modifier so that it can be used in conjunction with other keys to create a key grab. If the given keycode is already mapped, then this function will return the modifier that is currently mapped to the keycode, without doing anything else. Otherwise, it will use the last modifier that AT-SPI used to map a key. If no keys have yet been mapped using this device, then it will look for a modifier that is not currently being used. If no unused modifier can be found, then it will use the first modifier by default. the modifier that is now mapped to this keycode. This return value can be passed to atspi_device_add_key_grab. the device. the keycode to map. Removes the key grab specified by @id. the device. the identifier of the grab to be removed. Removes a keyboard grab added via a call to atspi_device_add_keyboard. Removes a mapped modifier from the given keycode. the device. the keycode to unmap. an identifier that can be later used to remove the grab, or 0 if the key/modifier combination could not be grabbed. Add a key grab for the given key/modifier combination. the device. a #AtspiKeyDefinition specifying the key code to grab. the function to call when the given key is pressed. Data to be passed to @callback. callback function to be called when @callback is destroyed. Add a callback that will receive a notification whenever a key is pressed or released. the device. the function to call when the given key is pressed. Data to be passed to @callback. callback function to be called when @callback is destroyed. Synthesizes a mouse event at a specific screen coordinate. Most AT clients should use the #AccessibleAction interface when tempted to generate mouse events, rather than this method. Event names: b1p = button 1 press; b2r = button 2 release; b3c = button 3 click; b2d = button 2 double-click; abs = absolute motion; rel = relative motion. the device. The #AtspiAccessible that should receive the click. a #gint indicating the x coordinate of the mouse event, relative to @obj.. a #gint indicating the y coordinate of the mouse event, relative to @obj.. a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs"). Returns the locked modifiers (ie, num lock, caps lock) associated with this keyboard. a guint of modifier flags. the device. Gets the modifier for a given keycode, if one exists. Does not create a new mapping. This function should be used when the intention is to query a locking modifier such as num lock via atspi_device_get_locked_modifiers, rather than to add key grabs. the modifier that is mapped to this keycode. the device. the keycode to map. Attempts to grab the entire keyboard. This should only be done temporarily, as it may conflict with other applications that also want to grab the keyboard. #TRUE if successful, #FALSE otherwise. Maps the specified key code to a modifier so that it can be used in conjunction with other keys to create a key grab. If the given keycode is already mapped, then this function will return the modifier that is currently mapped to the keycode, without doing anything else. Otherwise, it will use the last modifier that AT-SPI used to map a key. If no keys have yet been mapped using this device, then it will look for a modifier that is not currently being used. If no unused modifier can be found, then it will use the first modifier by default. the modifier that is now mapped to this keycode. This return value can be passed to atspi_device_add_key_grab. the device. the keycode to map. Removes the key grab specified by @id. the device. the identifier of the grab to be removed. Removes a keyboard grab added via a call to atspi_device_add_keyboard. Removes a mapped modifier from the given keycode. the device. the keycode to unmap. the device. the identifier of the grab to be removed. the modifier that is now mapped to this keycode. This return value can be passed to atspi_device_add_key_grab. the device. the keycode to map. the device. the keycode to unmap. the modifier that is mapped to this keycode. the device. the keycode to map. #TRUE if successful, #FALSE otherwise. a guint of modifier flags. the device. the device. The #AtspiAccessible that should receive the click. a #gint indicating the x coordinate of the mouse event, relative to @obj.. a #gint indicating the y coordinate of the mouse event, relative to @obj.. a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs"). Creates a new #AtspiDeviceLegacy. a pointer to a newly-created #AtspiDeviceLegacy. Creates a new #AtspiDeviceListener with a specified callback function. a pointer to a newly-created #AtspiDeviceListener. an #AtspiDeviceListenerCB callback function, or NULL. a pointer to data which will be passed to the callback when invoked. A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. Creates a new #AtspiDeviceListener with a specified callback function. This method is similar to #atspi_device_listener_new, but callback takes no user data. a pointer to a newly-created #AtspiDeviceListener. an #AtspiDeviceListenerCB callback function, or NULL. A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. Adds an in-process callback function to an existing #AtspiDeviceListener. the #AtspiDeviceListener instance to modify. an #AtspiDeviceListenerCB function pointer. A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. a pointer to data which will be passed to the callback when invoked. Removes an in-process callback function from an existing #AtspiDeviceListener. the #AtspiDeviceListener instance to modify. an #AtspiDeviceListenerCB function pointer. A callback function prototype via which clients receive device event notifications. #TRUE if the client wishes to consume/preempt the event, preventing it from being relayed to the currently focussed application, #FALSE if the event delivery should proceed as normal. The #AtspiDeviceEvent for which notification is being received. Data which is passed to the client each time this callback is notified. Similar to #AtspiDeviceListenerCB, but with no user data. #TRUE if the client wishes to consume/preempt the event, preventing it from being relayed to the currently focussed application, #FALSE if the event delivery should proceed as normal. The #AtspiDeviceEvent for which notification is being received. Creates a new #AtspiDeviceX11. a pointer to a newly-created #AtspiDeviceX11. Gets the value of a single attribute, if specified for the document as a whole. Use atspi_document_get_document_attribute_value instead. a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object. a pointer to the #AtspiDocument object on which to operate. a string indicating the name of a specific attribute. Gets all constant attributes for the document as a whole. For attributes that change within the document content, see @atspi_text_get_attribute_run instead. Use atspi_document_get_document_attributes instead. a #GHashTable containing the constant attributes of the document, as name-value pairs. a pointer to the #AtspiDocument object on which to operate. Gets the current page number of an #AccessibleDocument object. a #gint indicating the current page number in the #AccessibleDocument object. a pointer to the #AtspiDocument object to query. Gets the value of a single attribute, if specified for the document as a whole. a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object. a pointer to the #AtspiDocument object on which to operate. a string indicating the name of a specific attribute. Gets all constant attributes for the document as a whole. For attributes that change within the document content, see @atspi_text_get_attribute_run instead. a #GHashTable containing the constant attributes of the document, as name-value pairs. a pointer to the #AtspiDocument object on which to operate. Gets the locale associated with the document's content, e.g. the locale for LOCALE_TYPE_MESSAGES. a string compliant with the POSIX standard for locale description. a pointer to the #AtspiDocument object on which to operate. Gets the page count of an #AccessibleDocument object. a #gint indicating the page count of an #AccessibleDocument object. a pointer to the #AtspiDocument object to query. Returns an array of AtspiTextSelections within this document. a GArray of AtspiTextSelection structures representing the selection. an #AtspiDocument Makes 1 or more selections within this document denoted by the given array of AtspiTextSelections. Any existing physical selection (inside or outside this document) is replaced by the new selections. All objects within the given selection ranges must be descendants of this document. Otherwise FALSE will be returned. TRUE if the selection was made successfully; FALSE otherwise. an #AtspiDocument. a GArray of AtspiTextSelections to be selected. One higher than the highest valid value of #AtspiEventType. Copies text from an #AtspiEditableText object into the system clipboard. see: #atspi_editable_text_paste_text #TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. a #gint indicating the starting character offset of the text to copy. a #gint indicating the offset of the first character past the end of the text section to be copied. Deletes text from an #AtspiEditableText object, copying the excised portion into the system clipboard. see: #atspi_editable_text_paste_text #TRUE if operation was successful, #FALSE otherwise. a pointer to the #AtspiEditableText object to modify. a #gint indicating the starting character offset of the text to cut. a #gint indicating the offset of the first character past the end of the text section to be cut. Deletes text from an #AtspiEditableText object, without copying the excised portion into the system clipboard. see: #atspi_editable_text_cut_text #TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. a #gint indicating the starting character offset of the text to delete. a #gint indicating the offset of the first character past the end of the text section to be deleted. Inserts text into an #AtspiEditableText object. As with all character offsets, the specified @position may not be the same as the resulting byte offset, since the text is in a variable-width encoding. #TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. a #gint indicating the character offset at which to insert the new text. a string representing the text to insert, in UTF-8 encoding. the number of characters of text to insert, in bytes. If the byte count of text is less than or equal to length, the entire contents of text will be inserted. Inserts text from the system clipboard into an #AtspiEditableText object. As with all character offsets, the specified @position may not be the same as the resulting byte offset, since the text is in a variable-width encoding. #TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. a #gint indicating the character offset at which to insert the new text. Replace the entire text contents of an #AtspiEditableText object. #TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. a character string, encoded in UTF-8, which is to become the new text contents of the #AtspiEditableText object. Starts/enters the main event loop for the AT-SPI services. NOTE: This method does not return control; it is exited via a call to #atspi_event_quit from within an event handler. Quits the last main event loop for the AT-SPI services, See: #atspi_event_main A generic interface implemented by objects for the receipt of event notifications. A generic interface implemented by objects for the receipt of event notifications. atspi-event-listener is the interface via which clients of the atspi-registry receive notification of changes to an application's user interface and content. Creates a new #AtspiEventListener associated with a specified @callback. A new #AtspiEventListener. An #AtspiEventListenerCB to be called when an event is fired. data to pass to the callback. A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. Can be NULL. Creates a new #AtspiEventListener associated with a specified @callback. A new #AtspiEventListener. An #AtspiEventListenerSimpleCB to be called when an event is fired. A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. Can be NULL. Deregisters an #AtspiEventListenerCB from the registry, for a specific event type. #TRUE if successful, otherwise #FALSE. the #AtspiEventListenerCB registered against an event type. User data that was passed in for this callback. a string specifying the event type for which this listener is to be deregistered. deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific event type. #TRUE if successful, otherwise #FALSE. the #AtspiEventListenerSimpleCB registered against an event type. a string specifying the event type for which this listener is to be deregistered. Registers an #AtspiEventListenerCB against an @event_type. #TRUE if successfull, otherwise #FALSE. the #AtspiEventListenerCB to be registered against an event type. User data to be passed to the callback. A #GDestroyNotify called when the callback is destroyed. a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format. #TRUE if successful, otherwise #FALSE. an #AtspiEventListenerCB function pointer. #TRUE if successful, otherwise #FALSE. an #AtspiEventListenerCB function pointer. Registers an #AtspiEventListenetSimpleCB. The method is similar to #atspi_event_listener_register, but @callback takes no user_data. #TRUE if successfull, otherwise #FALSE. the #AtspiEventListenerSimpleCB to be registered against an event type. A #GDestroyNotify called when the callback is destroyed. a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. EventClasses include "object", "window", "mouse", and toolkit events (e.g. "Gtk", "AWT"). Examples: "focus:", "Gtk:GtkWidget:button_press_event". Deregisters an #AtspiEventListener from the registry, for a specific event type. #TRUE if successful, otherwise #FALSE. The #AtspiEventListener to deregister. a string specifying the event type for which this listener is to be deregistered. Adds an in-process callback function to an existing #AtspiEventListener. Legal object event types: (property change events) object:property-change object:property-change:accessible-name object:property-change:accessible-description object:property-change:accessible-help-text object:property-change:accessible-parent object:property-change:accessible-value object:property-change:accessible-role object:property-change:accessible-table-caption object:property-change:accessible-table-column-description object:property-change:accessible-table-column-header object:property-change:accessible-table-row-description object:property-change:accessible-table-row-header object:property-change:accessible-table-summary (other object events) object:state-changed object:children-changed object:visible-data-changed object:selection-changed object:text-selection-changed object:text-changed object:text-caret-moved object:row-inserted object:row-reordered object:row-deleted object:column-inserted object:column-reordered object:column-deleted object:model-changed object:active-descendant-changed object:announcement (screen reader events) screen-reader:region-changed (window events) window:minimize window:maximize window:restore window:close window:create window:reparent window:desktop-create window:desktop-destroy window:activate window:deactivate window:raise window:lower window:move window:resize window:shade window:unshade window:restyle (other events) focus: mouse:abs mouse:rel mouse:b1p mouse:b1r mouse:b2p mouse:b2r mouse:b3p mouse:b3r NOTE: this character string may be UTF-8, but should not contain byte value 56 (ascii ':'), except as a delimiter, since non-UTF-8 string delimiting functions are used internally. In general, listening to toolkit-specific events is not recommended. Currently, object:text-reading-position needs to be specified explicitly (it is not implied by object:text), since it is generated by the screen reader and is thus a special case internally. #TRUE if successful, otherwise #FALSE. The #AtspiEventListener to register against an event type. a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. EventClasses include "object", "window", "mouse", and toolkit events (e.g. "Gtk", "AWT"). Examples: "focus:", "Gtk:GtkWidget:button_press_event". Adds an in-process callback function to an existing #AtspiEventListener. #TRUE if successful, otherwise #FALSE. The #AtspiEventListener to register against an event type. a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format and legal event types. a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback. TODO: Document. Adds an in-process callback function to an existing #AtspiEventListener. #TRUE if successful, otherwise #FALSE. The #AtspiEventListener to register against an event type. a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format and legal event types. a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback. the application whose events should be reported, or %null for all applications. A function prototype for callbacks via which clients are notified of AT-SPI events. The event for which notification is sent. User data which is passed to the callback each time a notification takes place. Like #AtspiEventlistenerCB, but with no user_data. The event for which notification is sent. Enumeration used to specify the event types of interest to an #AtspiEventListener, or to identify the type of an event for which notification has been sent. Indicates that a key on a keyboard device was pressed. Indicates that a key on a keyboard device was released. Indicates that a button on a non-keyboard human interface device (HID) was pressed. Indicates that a button on a non-keyboard human interface device (HID) was released. Instances of atspi-hyperlink are the means by which end users and clients interact with linked content. Instances of atspi-hyperlink are returned by atspi-hypertext objects, and are the means by which end users and clients interact with linked, and in some cases embedded, content. These instances may have multiple "anchors", where an anchor corresponds to a reference to a particular resource with a corresponding resource identified (URI). Gets the ending character offset of the text range associated with an #AtspiHyperlink, in its originating #AtspiHypertext. a pointer to the #AtspiHyperlink implementor on which to operate. Gets the starting and ending character offsets of the text range associated with an #AtspiHyperlink, in its originating #AtspiHypertext. a pointer to the #AtspiHyperlink implementor on which to operate. Gets the total number of anchors which an #AtspiHyperlink implementor has. Though typical hyperlinks have only one anchor, client-side image maps and other hypertext objects may potentially activate or refer to multiple URIs. For each anchor there is a corresponding URI and object. see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a #gint indicating the number of anchors in this hyperlink. a pointer to the #AtspiHyperlink object on which to operate. Gets the object associated with a particular hyperlink anchor, as an #AtspiAccessible. an #AtspiAccessible that represents the object associated with the @ith anchor of the specified #AtspiHyperlink. a pointer to the #AtspiHyperlink implementor on which to operate. a (zero-index) #gint indicating which hyperlink anchor to query. Gets the starting character offset of the text range associated with an #AtspiHyperlink, in its originating #AtspiHypertext. a pointer to the #AtspiHyperlink implementor on which to operate. Gets the URI associated with a particular hyperlink anchor. a UTF-8 string giving the URI of the @ith hyperlink anchor. a pointer to the #AtspiHyperlink implementor on which to operate. a (zero-index) integer indicating which hyperlink anchor to query. Tells whether an #AtspiHyperlink object is still valid with respect to its originating hypertext object. #TRUE if the specified #AtspiHyperlink is still valid with respect to its originating #AtspiHypertext object, #FALSE otherwise. a pointer to the #AtspiHyperlink on which to operate. An interface used for objects which implement linking between multiple resource locations. An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. A hypertext instance is associated with one or more hyperlinks which are associated with particular offsets within the hypertext's content. Gets the #AtspiHyperlink object at a specified index. the #AtspiHyperlink object specified by @link_index. a pointer to the #AtspiHypertext implementor on which to operate. a (zero-index) #gint indicating which hyperlink to query. Gets the index of the #AtspiHyperlink object at a specified character offset. the linkIndex of the #AtspiHyperlink active at character offset @character_offset, or -1 if there is no hyperlink at the specified character offset. a pointer to the #AtspiHypertext implementor on which to operate. a #gint specifying the character offset to query. Gets the total number of #AtspiHyperlink objects that an #AtspiHypertext implementor has. a #gint indicating the number of #AtspiHyperlink objects of the #AtspiHypertext implementor, or -1 if the number cannot be determined (for example, if the #AtspiHypertext object is so large that it is not all currently in the memory cache). a pointer to the #AtspiHypertext implementor on which to operate. Gets the description of the image displayed in an #AtspiImage object. a UTF-8 string describing the image. a pointer to the #AtspiImage implementor on which to operate. Gets the bounding box of the image displayed in a specified #AtspiImage implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING. a pointer to an #AtspiRect corresponding to the image's bounding box. The minimum x and y coordinates, width, and height are specified. a pointer to the #AtspiImage implementor to query. the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Gets the locale associated with an image and its textual representation. A POSIX LC_MESSAGES-style locale value for image description and text. a pointer to the #AtspiImage to query. Gets the minimum x and y coordinates of the image displayed in a specified #AtspiImage implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING. a pointer to an #AtspiPoint where x and y correspond to the minimum coordinates of the displayed image. a pointer to the #AtspiImage implementor to query. the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). Gets the size of the image displayed in a specified #AtspiImage object. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING. a pointer to an #AtspiPoint where x corresponds to the image's width and y corresponds to the image's height. a pointer to the #AtspiImage to query. One higher than the highest valid value of #AtspiKeyEventType. One higher than the highest valid value of #AtspiKeySynthType. A callback that will be invoked when a key is pressed. the device. TRUE if the key is being pressed, FALSE if being released. the hardware code for the key. the keysym for the key. a bitflag indicating which key modifiers are active. the text corresponding to the keypress. user-supplied data Deprecated. Should not be used. Key press event Key release event Specifies the type of a key listener event. The values above can and should be bitwise-'OR'-ed together, observing the compatibility limitations specified in the description of each value. For instance, #ATSPI_KEYLISTENER_ALL_WINDOWS | #ATSPI_KEYLISTENER_CANCONSUME is a commonly used combination which gives the AT complete control over the delivery of matching events. However, such filters should be used sparingly as they may have a negative impact on system performance. Events may be delivered asynchronously, which means in some cases they may already have been delivered to the application before the AT client receives the notification. Events are delivered synchronously, before the currently focused application sees them. Events may be consumed by the AT client. Presumes and requires #ATSPI_KEYLISTENER_SYNCHRONOUS, incompatible with #ATSPI_KEYLISTENER_NOSYNC. Events are received not from the application toolkit layer, but from the device driver or windowing system subsystem; such notifications are 'global' in the sense that they are not broken or defeated by applications that participate poorly in the accessibility APIs, or not at all; however because of the intrusive nature of such snooping, it can have side-effects on certain older platforms. If unconditional event notifications, even when inaccessible or "broken" applications have focus, are not required, it may be best to avoid this enum value/flag. Structure containing identifying information about a set of keycode or keysyms. Enumeration used when synthesizing keyboard input via #atspi_generate_keyboard_event. Emulates the pressing of a hardware keyboard key. Emulates the release of a hardware keyboard key. Emulates the pressing and immediate releasing of a hardware keyboard key. 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). 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_KEY_SYM. In practice this limitation primarily effects Chinese and Japanese locales. Emulates locking a set of modifiers. Emulates unlocking a set of modifiers. One higher than the highest valid value of #AtspiLocaleType. 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. No live region. This live region should be considered polite. This live region should be considered assertive. Used by interfaces #AtspiText and #AtspiDocument, this enumeration corresponds to the POSIX 'setlocale' enum values. For localizable natural-language messages. For regular expression matching and string collation. For regular expression matching, character classification, conversion, case-sensitive comparison, and wide character functions. For monetary formatting. For number formatting (such as the decimal point and the thousands separator). For time and date formatting. One higher than the highest valid value of #AtspiModifierType. An interface that allows the definition of match rules for accessible objects. Creates a new #AtspiMatchRule with specified @states, @attributes, @interfaces, and @roles. A new #AtspiMatchRule. An #AtspiStateSet specifying the states to match or NULL if none. An #AtspiCollectionMatchType specifying how to interpret @states. A #GHashTable specifying attributes to match. To specify multiple attribute values, separate each value with a :: If an attribute value contains a :, then it can be escaped by preceding it with a \. A backslash can likewise be escaped by inserting a double backslash. An #AtspiCollectionMatchType specifying how to interpret @attributes. A #GArray of roles to match, or NULL if not applicable. An #AtspiCollectionMatchType specifying how to interpret @roles. An array of interfaces to match, or NULL if not applicable. Interface names should be specified by the final component of their DBus names (Accessible, Component, etc). An #AtspiCollectionMatchType specifying how to interpret @interfaces. if #TRUE, the match rule should be denied (inverted); if #FALSE, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time. The left or right 'Shift' key. The ShiftLock or CapsLock key. 'Control'/'Ctrl'. The Alt key (as opposed to AltGr). 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_MODIFIER_META2 means that the 'Mod2Mask' bit is set in the corresponding XEvent. See @ATSPI_MODIFIER_META. See @ATSPI_MODIFIER_META. A symbolic meta key name that is mapped by AT-SPI to the appropriate META value, for the convenience of the client. One higher than the highest valid value of #AtspiRelationType. One higher than the highest valid value of #AtspiRole. Gets a copy of an #AtspiRange object. the #AtspiRange copy of an #AtspiRange object. a pointer to the source #AtspiRange object that will be copied. An interface via which non-hierarchical relationships are indicated. An interface via which non-hierarchical relationships are indicated. An instance of this interface represents a "one-to-many" correspondence. Gets the number of objects which this relationship has as its target objects (the subject is the #AtspiAccessible from which this #AtspiRelation originated). a #gint indicating how many target objects which the originating #AtspiAccessible object has the #AtspiRelation relationship with. a pointer to the #AtspiRelation object to query. Gets the type of relationship represented by an #AtspiRelation. an #AtspiRelationType indicating the type of relation encapsulated in this #AtspiRelation object. a pointer to the #AtspiRelation object to query. Gets the @i-th target of a specified #AtspiRelation relationship. an #AtspiAccessible which is the @i-th object with which the originating #AtspiAccessible has relationship specified in the #AtspiRelation object. a pointer to the #AtspiRelation object to query. a (zero-index) #gint indicating which (of possibly several) target is requested. #AtspiRelationType 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_RELATION_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_RELATION_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 #AtspiRelation object. Not a meaningful relationship; clients should not normally encounter this #AtspiRelationType value. Object is a label for one or more other objects. Object is labelled by one or more other objects. Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects. 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_RELATION_CONTROLLED_BY scrollbars. Object has a grouping relationship (e.g. 'same group as') to one or more other objects. Object is a tooltip associated with another object. Object is a child of the target. Object is a parent of the target. Used to indicate that a relationship exists, but its type is not specified in the enumeration. 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. Reciprocal of @ATSPI_RELATION_FLOWS_TO. 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. Similar to @ATSPI_RELATION_SUBWINDOW_OF, but specifically used for cross-process embedding. Reciprocal of @ATSPI_RELATION_EMBEDS. Used to denote content rendered by embedded renderers that live in a separate process space from the embedding context. 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_RELATION_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. This is the reciprocal relation to @ATSPI_RELATION_POPUP_FOR. Reciprocal of %ATSPI_RELATION_DESCRIBED_BY. Indicates that this object provides descriptive information about the target object(s). See also %ATSPI_RELATION_DETAILS_FOR and %ATSPI_RELATION_ERROR_FOR. Reciprocal of %ATSPI_RELATION_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_RELATION_LABELLED_BY. For an on-screen error message, use %ATSPI_RELATION_ERROR_MESSAGE. For lengthy extended descriptive information contained in an on-screen object, consider using %ATSPI_RELATION_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. Reciprocal of %ATSPI_RELATION_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_RELATION_DESCRIBED_BY. If the detailed information describes an error condition, %ATSPI_RELATION_ERROR_FOR should be used instead. @Since: 2.26. Reciprocal of %ATSPI_RELATION_DETAILS. Indicates that this object provides a detailed or extended description about the target object(s). See also %ATSPI_RELATION_DESCRIPTION_FOR and %ATSPI_RELATION_ERROR_FOR. @Since: 2.26. Reciprocal of %ATSPI_RELATION_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_STATE_INVALID_ENTRY in their #AtspiStateSet. @Since: 2.26. Reciprocal of %ATSPI_RELATION_ERROR_MESSAGE. Indicates that this object contains an error message describing an invalid condition in the target object(s). @Since: 2.26. Do not use as a parameter value, used to determine the size of the enumeration. Enumeration used by interface #AtspiAccessible to specify the role of an #AtspiAccessible object. A role indicating an error condition, such as uninitialized Role data. Object is a label indicating the keyboard accelerators for the parent. Object is used to alert the user about something. Object contains a dynamic or moving image of some kind. Object is a 2d directional indicator. Object contains one or more dates, usually arranged into a 2d list. Object that can be drawn into and is used to trap events. A choice that can be checked or unchecked and provides a separate indicator for the current state. A menu item that behaves like a check box. See @ATSPI_ROLE_CHECK_BOX. A specialized dialog that lets the user choose a color. The header for a column of data. A list of choices the user can select from. An object which allows entry of a date. An inconifed internal frame within a DESKTOP_FRAME. A pane that supports internal frames and iconified versions of those internal frames. An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element. A top level window with title bar and a border. A pane that allows the user to navigate through and select the contents of a directory. An object used for drawing custom user interface elements. 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. A object that fills up space in a user interface. Don't use, reserved for future use. Allows selection of a display font. A top level window with a title bar, border, menubar, etc. A pane that is guaranteed to be painted on top of all panes beneath it. A document container for HTML, whose children represent the document content. A small fixed size picture, typically used to decorate components. An image, typically static. A frame-like object that is clipped by a desktop pane. An object used to present an icon or short string in an interface. A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. An object that presents a list of objects to the user and allows the user to select one or more of them. An object that represents an element of a list. An object usually found inside a menu bar that contains a list of actions the user can choose from. 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. An object usually contained in a menu that presents an action the user can choose. A specialized pane whose primary use is inside a dialog. An object that is a child of a page tab list. An object that presents a series of panels (or page tabs), one at a time,through some mechanism provided by the object. A generic container that is often used to group objects. A text object uses for passwords, or other places where the text content is not shown visibly to the user. 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. An object used to indicate how much of a task has been completed. An object the user can manipulate to tell the application to do something. A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked. Object is both a menu item and a "radio button" . See @ATSPI_ROLE_RADIO_BUTTON. A specialized pane that has a glass pane and a layered pane as its children. The header for a row of data. 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. 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_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY reciprocal relations are set. See #atspi_get_relation_set. An object usually contained in a menu to provide a visible and logical separation of the contents in a menu. 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. An object which allows one of a set of choices to be selected, and which displays the current choice. A specialized panel that presents two other panels at the same time. Object displays non-quantitative status information (c.f. @ATSPI_ROLE_PROGRESS_BAR) An object used to repesent information in terms of rows and columns. 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. An object which labels a particular column in an #AtspiTable. An object which labels a particular row in a #AtspiTable. #AtspiTable rows and columns may also be labelled via the @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships. See #atspi_get_relation_set. Object allows menu to be removed from menubar and shown in its own window. An object that emulates a terminal. 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. A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state. A bar or palette usually composed of push buttons or toggle buttons. An object that provides information about another object. An object used to repsent hierarchical information to the user. An object that presents both tabular and hierarchical info to the user. The object contains some #AtspiAccessible information, but its role is not known. An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport. A top level window with no title or border. means that the role for this item is known, but not included in the core enumeration. Deprecated since 2.24. An object that serves as a document header. An object that serves as a document footer. An object which is contains a single paragraph of text content. See also @ATSPI_ROLE_TEXT. An object which describes margins and tab stops, etc. for text objects which it controls (should have @ATSPI_RELATION_CONTROLLER_FOR relation to such). 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. 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. The object is an editable text object in a toolbar. 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. The object is a component whose textual content may be entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present. A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is not present) implies a read-only 'text field' in a form, as opposed to a title, label, or caption. 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. The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. The object is a visual frame or container which contains a view of document content. #AtspiDocument frames may occur within another #AtspiDocument 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 #AtspiDocument interface. 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. 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. 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. 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. 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 #AtspiHypertext/#AtspiHyperlink interfacesto indicate the range/location within a text object where an inline or embedded object lies. 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". A row in a table. An object that represents an element of a tree. A document frame which contains a spreadsheet. A document frame which contains a presentation or slide content. A document frame which contains textual content, such as found in a word processing application. A document frame which contains HTML or other markup suitable for display in a web browser. A document frame which contains email content to be displayed or composed either in plain text or HTML. 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. A non-collapsible list of choices the user can select from. A group of related widgets. This group typically has a label. 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. A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. An object designed to present a message to the user within an existing window. A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. @Since: 2.8 A bar that serves as the title of a window or a dialog. @Since: 2.12 An object which contains a text section that is quoted from another source. @Since: 2.12 An object which represents an audio element. @Since: 2.12 An object which represents a video element. @Since: 2.12 A definition of a term or concept. @Since: 2.12 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. @Since: 2.12 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. @Since: 2.12 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. @Since: 2.12 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. @Since: 2.12 A text widget or container that holds a mathematical expression. @Since: 2.12 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 AtspiValue. @Since: 2.12 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. @Since: 2.12 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. @Since: 2.16. An object that represents a mathematical fraction. @Since: 2.16. An object that represents a mathematical expression displayed with a radical. @Since: 2.16. An object that contains text that is displayed as a subscript. @Since: 2.16. An object that contains text that is displayed as a superscript. @Since: 2.16. 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. @Since: 2.26. An object that represents a term or phrase with a corresponding definition. @Since: 2.26. An object that represents the description, definition, or value of a term. @Since: 2.26. An object that contains the text of a footnote. @Since: 2.26. Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers. @Since: 2.34. Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers. @Since: 2.34. 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_RELATION_DETAILS should be used on the mark to point to that associated section. In addition, the reciprocal relation %ATSPI_RELATION_DETAILS_FOR should be used on the associated content section to point back to the mark. @Since: 2.36. 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. @Since: 2.36 A specialized push button to open a menu. @Since 2.46 Not a valid role, used for finding end of enumeration. Gets the localized description string describing the #AtspiRole @role. the localized string describing the AtspiRole an #AtspiRole object to query. Gets a localizable string that indicates the name of an #AtspiRole. a localizable string name for an #AtspiRole enumerated type. an #AtspiRole object to query. One higher than the highest valid value of #AtspiScrollType. One higher than the highest valid value of #AtspiCollectionSortOrder. One higher than the highest valid value of #AtspiStateType. Enumeration used by interface #AtspiAccessible to specify where an #AtspiAccessible object should be placed on the screen when using scroll_to. Scroll the object to the top left corner of the window. Scroll the object to the bottom right corner of the window. Scroll the object to the top edge of the window. Scroll the object to the bottom edge of the window. Scroll the object to the left edge of the window. Scroll the object to the right edge of the window. Scroll the object to application-dependent position on the window. An interface which indicates that an object exposes a 'selection' model, allowing the selection of one or more of its children. An interface which indicates that an object exposes a 'selection' model, allowing the selection of one or more of its children. Read-only Selection instances are possible, in which case the interface is used to programmatically determine the selected-ness of its children. Clears the current selection, removing all selected children from the specified #AtspiSelection implementor's selection list. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiSelection implementor on which to operate. Deselects a specific child of an #AtspiSelection. Note that @child_index is the index of the child in the parent container. See #atspi_selection_deselect_selected_child #TRUE if the child was successfully deselected, #FALSE otherwise. a pointer to the #AtspiSelection on which to operate. a #gint indicating which of the children of the #AtspiAccessible is to be de-selected. Removes a child from the selected children list of an #AtspiSelection. Note that @child_index is the index in the selected-children list, not the index in the parent container. @selectedChildIndex in this method, and @child_index in #atspi_selection_select_child are asymmetric. #TRUE if the child was successfully deselected, #FALSE otherwise. a pointer to the #AtspiSelection on which to operate. a #gint indicating which of the selected children of the #Accessible is to be selected. Gets the number of children of an #AtspiSelection implementor which are currently selected. a #gint indicating the number of #Accessible children of the #AtspiSelection implementor which are currently selected. a pointer to the #AtspiSelection implementor on which to operate. Gets the i-th selected #AtspiAccessible child of an #AtspiSelection. Note that @selected_child_index refers to the index in the list of 'selected' children and generally differs from that used in #atspi_accessible_get_child_at_index or returned by #atspi_accessible_get_index_in_parent. @selected_child_index must lie between 0 and #atspi_selection_get_n_selected_children - 1, inclusive. a pointer to a selected #AtspiAccessible child object, specified by @selected_child_index. a pointer to the #AtspiSelection on which to operate. a #gint indicating which of the selected children is specified. Determines whether a particular child of an #AtspiSelection implementor is currently selected. Note that @child_index is the index into the standard #AtspiAccessible container's list of children. #TRUE if the specified child is currently selected, #FALSE otherwise. a pointer to the #AtspiSelection implementor on which to operate. an index into the #AtspiSelection's list of children. Attempts to select all of the children of an #AtspiSelection implementor. Not all #AtspiSelection implementors support this operation. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiSelection implementor on which to operate. Adds a child to the selected children list of an #AtspiSelection. For #AtspiSelection implementors that only allow single selections, this may replace the (single) current selection. #TRUE if the child was successfully selected, #FALSE otherwise. a pointer to the #AtspiSelection on which to operate. a #gint indicating which child of the #Accessible is to be selected. The atspi-stateset objects implement wrappers around a bitmap of accessible states. Generates an #AtspiStateSet with the given @states. A new #AtspiStateSet with the given states. An array of states with which the method initializes the state set. Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the given state to #TRUE in the stateset). a pointer to the #AtspiStateSet object on which to operate. an #AtspiStateType to be added to the specified #AtspiStateSet. Determines the differences between two instances of #AtspiStateSet. @see #atspi_state_set_equals. an #AtspiStateSet object containing all states contained on one of the two sets but not the other. a pointer to the first #AtspiStateSet object on which to operate. a pointer to the second #AtspiStateSet object on which to operate. Determines whether a given #AtspiStateSet includes a given state; that is, whether @state is true for the @set in question. #TRUE if @state is true/included in the given #AtspiStateSet, otherwise #FALSE. a pointer to the #AtspiStateSet object on which to operate. an #AtspiStateType for which the specified #AtspiStateSet will be queried. Determines whether two instances of #AtspiStateSet are equivalent (i.e. consist of the same #AtspiStates). Useful for checking multiple state variables at once. @see #atspi_state_set_compare. #TRUE if the two #AtspiStateSets are equivalent, otherwise #FALSE. a pointer to the first #AtspiStateSet object on which to operate. a pointer to the second #AtspiStateSet object on which to operate. Returns the states in an #AtspiStateSet as an array. A #GArray of state types representing the current state. The #AtspiStateSet to be queried. #TRUE if the state set contains no states; #FALSE otherwise. The #AtspiStateSet to query. Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the given state to #FALSE in the stateset.) a pointer to the #AtspiStateSet object on which to operate. an #AtspiStateType to remove from the specified @set. Enables/disables a state in an #AtspiStateSet according to its @name. a pointer to the #AtspiStateSet object on which to operate. a string corresponding to a state name. if #TRUE, @name should be enabled in the @set in question; otherwise, it should be disabled. Enumeration used by various interfaces indicating every possible state an #AtspiAccesible object can assume. Indicates an invalid state - probably an error condition. Indicates a window is currently the active window, or an object is the active subelement within a container or table. @ATSPI_STATE_ACTIVE should not be used for objects which have #ATSPI_STATE_FOCUSABLE or #ATSPI_STATE_SELECTABLE: Those objects should use @ATSPI_STATE_FOCUSED and @ATSPI_STATE_SELECTED respectively. @ATSPI_STATE_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. Indicates that the object is armed. 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. Indicates this object is currently checked. Indicates this object is collapsed. Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed). Indicates the user can change the contents of this object. 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_STATE_SENSITIVE if direct user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. See @ATSPI_STATE_SENSITIVE. Indicates this object allows progressive disclosure of its children. Indicates this object is expanded. 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. Indicates this object currently has the keyboard focus. Indicates that the object has an associated tooltip. Indicates the orientation of this object is horizontal. Indicates this object is minimized and is represented only by an icon. Indicates something must be done with this object before the user can interact with an object in a different window. Indicates this (text) object can contain multiple lines of text. 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. Indicates this object paints every pixel within its rectangular region. It also indicates an alpha value of unity, if it supports alpha blending. Indicates this object is currently pressed. Indicates the size of this object's size is not fixed. 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. 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. Indicates this object is sensitive, e.g. to user interaction. @ATSPI_STATE_SENSITIVE usually accompanies. @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the absence of @ATSPI_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 @ATSPI_STATE_SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED, @ATSPI_STATE_INDETERMINATE. 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. Indicates this (text) object can contain only a single line of text. 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_STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. Indicates this object is transient. 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. Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. @ATSPI_STATE_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_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is semantically equivalent to saying that an object is 'hidden'. 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_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. 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_STATE_INDETERMINATE if the currently selected text contains a mixture of weight attributes. In many cases interacting with a @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding boolean attribute to be homogenized, whereupon the object will lose @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be fired. Indicates that user interaction with this object is 'required' from the user, for instance before completing the processing of a form. Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell. 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. 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. 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 #AtspiSelection. 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. This state indicates that the object in question supports text selection. It should only be exposed on objects which implement the #AtspiText interface, in order to distinguish this state from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements #AtspiSelection. While similar, text selection and subelement selection are distinct operations. 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. 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. Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell. @Since: 2.12 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. @Since: 2.12 Indicates that an object which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user. @Since: 2.16 This value of the enumeration should not be used as a parameter, it indicates the number of items in the #AtspiStateType enumeration. One higher than the highest valid value of #AtspiTextBoundaryType. One higher than the highest valid value of #AtspiTextClipType. One higher than the highest valid value of #AtspiCollection_TreeTraversalType. An interface used by containers whose data is arranged in a tabular form. An interface used by containers whose contained data is arranged in a tabular (i.e. row-column) form. Tables may resemble a two-dimensional grid, as in a spreadsheet, or may feature objects which span multiple rows and/or columns, but whose bounds are aligned on a row/column matrix. Objects within tables are children of the table object, and they may be referenced either via a child index or via a row/column pair. Table 'cells' may implement other interfaces, such as Text, Action, Image, and Component, and should do so as appropriate to their onscreen presentation and/or behavior. Selects the specified column, adding it to the current column selection. Not all tables support column selection. #TRUE if the specified column was successfully selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed column number of the column being selected. Selects the specified row, adding it to the current row selection. Not all tables support row selection. #TRUE if the specified row was successfully selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed row number of the row being selected. Gets the table cell at the specified row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use #atspi_component_get_accessible_at_point. an #AtspiAccessible object representing the specified table cell. a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. the specified table column, zero-indexed. Gets an accessible representation of the caption for an #AtspiTable. an #AtspiAccessible object that serves as the table's caption. a pointer to the #AtspiTable implementor on which to operate. Gets the table column index occupied by the child at a particular 1-D child index. @see #atspi_table_get_index_at, #atspi_table_get_row_at_index a #gint indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) @index. a pointer to the #AtspiTable implementor on which to operate. the specified child index, zero-indexed. Gets a text description of a particular table column. This differs from #atspi_table_get_column_header, which returns an #Accessible. a UTF-8 string describing the specified table column, if available. a pointer to the #AtspiTable implementor on which to operate. the specified table column, zero-indexed. Gets the number of columns spanned by the table cell at the specific row and column (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING. a #gint indicating the number of columns spanned by the specified cell. a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. the specified table column, zero-indexed. Gets the header associated with a table column, if available. This differs from #atspi_table_get_column_description, which returns a string. an #AtspiAccessible representation of the specified table column, if available. a pointer to the #AtspiTable implementor on which to operate. the specified table column, zero-indexed. Gets the 1-D child index corresponding to the specified 2-D row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use #atspi_component_get_accessible_at_point. @see #atspi_table_get_row_at_index, #atspi_table_get_column_at_index a #gint which serves as the index of a specified cell in the table, in a form usable by #atspi_get_child_at_index. a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. the specified table column, zero-indexed. Gets the number of columns in an #AtspiTable, exclusive of any columns that are programmatically hidden, but inclusive of columns that may be outside of the current scrolling window or viewport. a #gint indicating the number of columns in the table. a pointer to the #AtspiTable implementor on which to operate. Gets the number of rows in an #AtspiTable, exclusive of any rows that are programmatically hidden, but inclusive of rows that may be outside of the current scrolling window or viewport. a #gint indicating the number of rows in the table. a pointer to the #AtspiTable implementor on which to operate. Queries a table to find out how many columns are currently selected. Not all tables support column selection. a #gint indicating the number of columns currently selected. a pointer to the #AtspiTable implementor on which to operate. Query a table to find out how many rows are currently selected. Not all tables support row selection. a #gint indicating the number of rows currently selected. a pointer to the #AtspiTable implementor on which to operate. Gets the table row index occupied by the child at a particular 1-D child index. @see #atspi_table_get_index_at, #atspi_table_get_column_at_index a #gint indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) @index. a pointer to the #AtspiTable implementor on which to operate. the specified child index, zero-indexed. Given a child index, determines the row and column indices and extents, and whether the cell is currently selected. If the child at index is not a cell (for instance, if it is a summary, caption, etc.), #FALSE is returned. The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING. Example: If the #AtspiTable child at index '6' extends across columns 5 and 6 of row 2 of an #AtspiTable instance, and is currently selected, then retval = atspi_table_get_row_column_extents_at_index (table, 6, row, col, row_extents, col_extents, is_selected); will return #TRUE, and after the call row, col, row_extents, col_extents, and is_selected will contain 2, 5, 1, 2, and #TRUE, respectively. #TRUE if the index is associated with a valid table cell, #FALSE if the index does not correspond to a cell. If #FALSE is returned, the values of the out parameters are undefined. a pointer to the #AtspiTable implementor on which to operate. the index of the #AtspiTable child whose row/column extents are requested. back-filled with the first table row associated with the cell with child index. back-filled with the first table column associated with the cell with child index. back-filled with the number of table rows across which child i extends. back-filled with the number of table columns across which child i extends. a boolean which is back-filled with #TRUE if the child at index i corresponds to a selected table cell, #FALSE otherwise. Gets a text description of a particular table row. This differs from #atspi_table_get_row_header, which returns an #AtspiAccessible. a UTF-8 string describing the specified table row, if available. a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. Gets the number of rows spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING. a #gint indicating the number of rows spanned by the specified cell. a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. the specified table column, zero-indexed. Gets the header associated with a table row, if available. This differs from #atspi_table_get_row_description, which returns a string. an #AtspiAccessible representation of the specified table row, if available. a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. Queries a table for a list of indices of columns which are currently selected. an array of #gint values, specifying which columns are currently selected. a pointer to the #AtspiTable implementor on which to operate. Queries a table for a list of indices of rows which are currently selected. an array of #gint values, specifying which rows are currently selected. a pointer to the #AtspiTable implementor on which to operate. Gets an accessible object which summarizes the contents of an #AtspiTable. an #AtspiAccessible object that serves as the table's summary (often a reduced #AtspiTable). a pointer to the #AtspiTable implementor on which to operate. Determines whether specified table column is selected. Not all tables support column selection. #TRUE if the specified column is currently selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed column number of the column being queried. Determines whether a table row is selected. Not all tables support row selection. #TRUE if the specified row is currently selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed row number of the row being queried. Determines whether the cell at a specific row and column is selected. #TRUE if the specified cell is currently selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed row of the cell being queried. the zero-indexed column of the cell being queried. De-selects the specified column, removing it from the current column selection. Not all tables support column selection. #TRUE if the specified column was successfully de-selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed column number of the column being de-selected. De-selects the specified row, removing it from the current row selection. Not all tables support row selection. #TRUE if the specified row was successfully de-selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. the zero-indexed number of the row being de-selected. Returns the column headers as an array of cell accessibles. a GPtrArray of AtspiAccessibles representing the column header cells. a GObject instance that implements AtspiTableCellIface Returns the number of columns occupied by this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING. a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method. a GObject instance that implements AtspiTableCellIface Retrieves the tabular position of this cell. TRUE if successful, FALSE otherwise. a GObject instance that implements AtspiTableCellIface the row of the given cell. the column of the given cell. Gets the row and column indexes and extents of this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING. a GObject instance that implements AtspiTableCellIface the row index of the given cell. the column index of the given cell. the number of rows occupied by this cell. the number of columns occupied by this cell. Returns the row headers as an array of cell accessibles. a GPtrArray of AtspiAccessibles representing the row header cells. a GObject instance that implements AtspiTableCellIface Returns the number of rows occupied by this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING. a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method. a GObject instance that implements AtspiTableCellIface Returns a reference to the accessible of the containing table. the AtspiAccessible for the containing table. a GObject instance that implements AtspiTableCellIface An interface implemented by objects which place textual information onscreen. The text interface should be implemented by objects which place textual information onscreen as character strings or glyphs. The text interface allows access to textual content including display attributes and semantic hints associated with runs of text, and to bounding information for glyphs and substrings. It also allows portions of text to be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT. Selects some text (adds a text selection) in an #AtspiText object. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. the starting offset of the desired new selection. the offset of the first character after the new selection. Gets a set of attributes applied to a range of text from an #AtspiText object, optionally including its 'default' attributes. a #GHashTable with attributes defined at the indicated offset, optionally including the 'default' ones. a pointer to the #AtspiText object to query. a #gint indicating the offset from which the attribute search is based. a #bool that, when set as #FALSE, indicates the call should only return those attributes which are explicitly set on the current attribute run, omitting any attributes which are inherited from the default values. a #gint pointer indicating the start of the desired text range. a #gint pointer indicating the first character past the desired range. Gets the value of a named attribute at a given offset. Use atspi_text_get_text_attribute_value instead. the value of a given attribute at the given offset, or %NULL if not present. a pointer to the #AtspiText object to query. The character offset at which to query the attribute. The attribute to query. Gets the attributes applied to a range of text from an #AtspiText object. The text attributes correspond to CSS attributes where possible. Use atspi_text_get_text_attributes instead. a #GHashTable describing the attributes at the given character offset. a pointer to the #AtspiText object to query. a #gint indicating the offset from which the attribute search is based. a #gint pointer indicating the start of the desired text range. a #gint pointer indicating the first character past the desired range. Gets the ranges of text from an #AtspiText object which lie within the bounds defined by (@x, @y) and (@x+@width, @y+@height). a null-terminated list of pointers to #AtspiTextRange structs detailing the bounded text. a pointer to the #AtspiText object on which to operate. the 'starting' x coordinate of the bounding box. the 'starting' y coordinate of the bounding box. the x extent of the bounding box. the y extent of the bounding box. an #AccessibleCoordType indicating the coordinate system to use for the returned values. an #AtspiTextClipType indicating how to treat characters that intersect the bounding box's x extents. an #AtspiTextClipType indicating how to treat characters that intersect the bounding box's y extents. Gets the current offset of the text caret in an #AtspiText object. a #gint indicating the current position of the text caret. a pointer to the #AtspiText object to query. Gets the character at a given offset for an #AtspiText object. a #guint representing the UCS-4 unicode code point of the given character, or 0xFFFFFFFF if the character in question cannot be represented in the UCS-4 encoding. a pointer to the #AtspiText object on which to operate. a #gint indicating the text offset where the desired character is located. Gets the character count of an #AccessibleText object. a #gint indicating the total number of characters in the #AccessibleText object. a pointer to the #AtspiText object to query. Gets a bounding box containing the glyph representing the character at a particular text offset. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING. An #AtspiRect specifying the position and size of the character. a pointer to the #AtspiText object on which to operate. a #gint indicating the offset of the text character for whom boundary information is requested. an #AccessibleCoordType indicating the coordinate system to use for the returned values. Gets the default attributes applied to an #AtspiText object. The text attributes correspond to CSS attributes where possible. The combination of this attribute set and the attributes reported by #atspi_text_get_attributes describes the entire set of text attributes over a range. a #GHashTable containing the default attributes applied to a text object, (exclusive of explicitly-set attributes), encoded as UTF-8. a pointer to the #AtspiText object to query. Gets the number of active non-contiguous selections for an #AtspiText object. a #gint indicating the current number of non-contiguous text selections active within an #AtspiText object. a pointer to the #AtspiText object on which to operate. Gets the character offset into the text at a given point. the offset (as a #gint) at the point (@x, @y) in the specified coordinate system. a pointer to the #AtspiText object on which to operate. the x coordinate of the point to be queried. the y coordinate of the point to be queried. an #AtspiCoordType indicating the coordinate system in which the values should be returned. Gets the bounding box for text within a range in an #AtspiText object. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING. An #AtspiRect giving the position and size of the specified range of text. a pointer to the #AtspiText object on which to operate. a #gint indicating the offset of the first text character for whom boundary information is requested. a #gint indicating the offset of the text character after the last character for whom boundary information is requested. an #AtspiCoordType indicating the coordinate system to use for the returned values. Gets the bounds of the @selection_num-th active text selection for an #AtspiText object. a pointer to the #AtspiText object on which to operate. a #gint indicating which selection to query. Gets a portion of the text exposed through an #AtspiText according to a given @offset and a specific @granularity, along with the start and end offsets defining the boundaries of such a portion of text. If @granularity is ATSPI_TEXT_GRANULARITY_CHAR the character at the offset is returned. If @granularity is ATSPI_TEXT_GRANULARITY_WORD the returned string is from the word start at or before the offset to the word start after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word. If @granularity is ATSPI_TEXT_GRANULARITY_SENTENCE the returned string is from the sentence start at or before the offset to the sentence start after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence. If @granularity is ATSPI_TEXT_GRANULARITY_LINE the returned string is from the line start at or before the offset to the line start after the offset. If @granularity is ATSPI_TEXT_GRANULARITY_PARAGRAPH the returned string is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. an #AtspiText position An #AtspiTextGranularity Gets a range of text from an #AtspiText object. The number of bytes in the returned string may exceed either end_offset or start_offset, since UTF-8 is a variable-width encoding. a text string containing characters from @start_offset to @end_offset-1, inclusive, encoded as UTF-8. a pointer to the #AtspiText object to query. a #gint indicating the start of the desired text range. a #gint indicating the first character past the desired range. Gets delimited text from an #AtspiText object which follows a given text offset. an #AtspiTextRange containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are after or inclusive of the current offset, or an empty string if no such text exists. a pointer to the #AtspiText object on which to operate. a #gint indicating the offset from which the delimiter search is based. an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. Gets delimited text from an #AtspiText object which includes a given text offset. Use atspi_text_get_string_at_offset. an #AtspiTextRange containing a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists. a pointer to the #AtspiText object on which to operate. a #gint indicating the offset from which the delimiter search is based. an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. Gets the value of a named attribute at a given offset. the value of a given attribute at the given offset, or %NULL if not present. a pointer to the #AtspiText object to query. The character offset at which to query the attribute. The attribute to query. Gets the attributes applied to a range of text from an #AtspiText object. The text attributes correspond to CSS attributes where possible. a #GHashTable describing the attributes at the given character offset. a pointer to the #AtspiText object to query. a #gint indicating the offset from which the attribute search is based. a #gint pointer indicating the start of the desired text range. a #gint pointer indicating the first character past the desired range. Gets delimited text from an #AtspiText object which precedes a given text offset. an #AtspiTextRange containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are before the current offset, or an empty string if no such text exists. a pointer to the #AtspiText object on which to operate. a #gint indicating the offset from which the delimiter search is based. an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. De-selects a text selection. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. a #gint indicating which text selection to remove. Scrolls whatever container of the #AtspiText text range so it becomes visible on the screen. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. a #gint indicating the start of the desired text range. a #gint indicating the first character past the desired range. a #AtspiScrollType indicating where the object should be placed on the screen. Scrolls whatever container of the #AtspiText text range so it becomes visible on the screen at a given position. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. a #gint indicating the start of the desired text range. a #gint indicating the first character past the desired range. a #AtspiCoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object. the x coordinate of the point to reach the y coordinate of the point to reach Moves the text caret to a given position. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. the offset to which the text caret is to be moved. Changes the bounds of an existing #AtspiText text selection. #TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. a zero-offset index indicating which text selection to modify. a #gint indicating the new starting offset for the selection. a #gint indicating the desired new offset of the first character after the selection. 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 AtspiTextGranularity with #atspi_text_get_string_at_offset instead. An #AtspiText instance is bounded by this character only. Start and end offsets differ by one, by definition, for this value. Boundary condition is start of a word; i.e. range is from start of one word to the start of another word. 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. 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. 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. 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. 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. Enumeration used by interface #AtspiText to indicate how to treat characters intersecting bounding boxes. No characters/glyphs are omitted. Characters/glyphs clipped by the minimum coordinate are omitted. Characters/glyphs which intersect the maximum coordinate are omitted. Only glyphs falling entirely within the region bounded by min and max are retained. Text granularity types used for specifying the granularity of the region of text we are interested in. Granularity is defined by the boundaries between characters (including non-printing characters) 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. 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. 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. 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. This structure represents a single text selection within a document. This selection is defined by two points in the content, where each one is defined by an AtkObject supporting the AtkText interface and a character offset relative to it. The end object must appear after the start object in the accessibility tree, i.e. the end object must be reachable from the start object by navigating forward (next, first child etc). This struct also contains a @start_is_active boolean, to communicate if the start of the selection is the active point or not. The active point corresponds to the user's focus or point of interest. The user moves the active point to expand or collapse the range. The anchor point is the other point of the range and typically remains constant. In most cases, anchor is the start of the range and active is the end. However, when selecting backwards (e.g. pressing shift+left arrow in a text field), the start of the range is the active point, as the user moves this to manipulate the selection. the AtspiAccessible containing the start of the selection. the text offset of the beginning of the selection within @start_object. the AtspiAccessible containing the end of the selection. the text offset of the end of the selection within @end_object. a gboolean indicating whether the start of the selection is the active point. An interface supporting a one-dimensional scalar to be modified, or which reflects its value. An interface supporting a one-dimensional scalar to be modified, or which reflects its value. If STATE_EDITABLE is not present, the value is treated as "read only". Gets the current value for an #AtspiValue. the current value for this object. a pointer to the #AtspiValue implementor on which to operate. Gets the maximum allowed value for an #AtspiValue. the maximum allowed value for this object. a pointer to the #AtspiValue implementor on which to operate. Gets the minimum increment by which an #AtspiValue can be adjusted. the minimum increment by which the value may be changed, or zero if the minimum increment cannot be determined. a pointer to the #AtspiValue implementor on which to operate. Gets the minimum allowed value for an #AtspiValue. the minimum allowed value for this object. a pointer to the #AtspiValue implementor on which to operate. Gets the human readable text alternative associated with the value. @text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. a pointer to the #AtspiValue implementor on which to operate. Sets the current value of an #AtspiValue. #TRUE if the value could be assigned the specified value, #FALSE otherwise. a pointer to the #AtspiValue implementor on which to operate. a #gdouble value which is the desired new value of the object. Sets the watch and timeout functions of a #DBusConnection to integrate the connection with the GLib main loop. Pass in #NULL for the #GMainContext unless you're doing something specialized. If called twice for the same context, does nothing the second time. If called once with context A and once with context B, context B replaces context A as the context monitoring the connection. the connection the #GMainContext or #NULL for default context Sets the watch and timeout functions of a #DBusServer to integrate the server with the GLib main loop. In most cases the context argument should be #NULL. If called twice for the same context, does nothing the second time. If called once with context A and once with context B, context B replaces context A as the context monitoring the connection. the server the #GMainContext or #NULL for default Removes a device event listener from the registry's listener queue, ceasing notification of events of the specified type. %TRUE if successful, otherwise %FALSE. a pointer to the #AtspiDeviceListener for which device events are requested. Unused parameter. Removes a keystroke event listener from the registry's listener queue, ceasing notification of events with modifiers matching @modmask. %TRUE if successful, otherwise %FALSE. a pointer to the #AtspiDeviceListener for which keystroke events are requested. a pointer to the #AtspiKeyDefinition array indicating which keystroke events are requested, or %NULL to indicate that all keycodes and keyvals for the specified modifier set are to be included. the key modifier mask for which this listener is to be 'deregistered' (of type #AtspiKeyMaskType). an #AtspiKeyMaskType mask indicating which types of key events were requested (%ATSPI_KEY_PRESSED, etc.). Starts/enters the main event loop for the AT-SPI services. NOTE: This method does not return control; it is exited via a call to #atspi_event_quit from within an event handler. Quits the last main event loop for the AT-SPI services, See: #atspi_event_main Disconnects from #AtspiRegistry instances and releases any floating resources. Call only once at exit. 0 if there were no leaks, otherwise other integer values. Synthesizes a keyboard event (as if a hardware keyboard event occurred in the current UI context). %TRUE if successful, otherwise %FALSE. a #gint indicating the keycode or keysym or modifier mask of the key event being synthesized. an (optional) UTF-8 string which, if @synth_type is %ATSPI_KEY_STRING, indicates a 'composed' keyboard input string being synthesized; this type of keyboard event synthesis does not emulate hardware keypresses but injects the string as though a composing input method (such as XIM) were used. an #AtspiKeySynthType flag indicating whether @keyval is to be interpreted as a keysym rather than a keycode (%ATSPI_KEY_SYM) or a string (%ATSPI_KEY_STRING) or a modifier mask (%ATSPI_KEY_LOCKMODIFIERS and %ATSPI_KEY_UNLOCKMODIFIERS), or whether to synthesize %ATSPI_KEY_PRESS, %ATSPI_KEY_RELEASE, or both (%ATSPI_KEY_PRESSRELEASE). Synthesizes a mouse event at a specific screen coordinate. Most AT clients should use the #AccessibleAction interface when tempted to generate mouse events, rather than this method. Event names: b1p = button 1 press; b2r = button 2 release; b3c = button 3 click; b2d = button 2 double-click; abs = absolute motion; rel = relative motion. %TRUE if successful, otherwise %FALSE. a #glong indicating the screen x coordinate of the mouse event. a #glong indicating the screen y coordinate of the mouse event. a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs"). Like atspi_generate_mouse_event, but asynchronous. a #glong indicating the screen x coordinate of the mouse event. a #glong indicating the screen y coordinate of the mouse event. a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs"). a callback to be called when a reply is received. May be NULL. data to be passed to @callback. Gets the virtual desktop indicated by index @i. NOTE: currently multiple virtual desktops are not implemented; as a consequence, any @i value different from 0 will not return a virtual desktop - instead it will return NULL. a pointer to the @i-th virtual desktop's #AtspiAccessible representation. a #gint indicating which of the accessible desktops is to be returned. Gets the number of virtual desktops. NOTE: multiple virtual desktops are not implemented yet; as a consequence, this function always returns 1. a #gint indicating the number of active virtual desktops. Gets the list of virtual desktops. On return, @list will point to a newly-created, NULL terminated array of virtual desktop pointers. It is the responsibility of the caller to free this array when it is no longer needed. NOTE: currently multiple virtual desktops are not implemented; this implementation always returns a #Garray with a single #AtspiAccessible desktop. a #GArray of desktops. Returns the version of the AT-SPI library being used at runtime. the major version. the minor version. the micro/patch version. Connects to the accessibility registry and initializes the SPI. 0 on success, 1 if already initialized, or an integer error code. Indicates whether AT-SPI has been initialized. %True if initialized; %False otherwise. This function does nothing and should not be called. Always returns %FALSE. Registers a listener for keystroke events, either pre-emptively for all windows (%ATSPI_KEYLISTENER_ALL_WINDOWS), non-preemptively (%ATSPI_KEYLISTENER_NOSYNC), or pre-emptively at the toolkit level (%ATSPI_KEYLISTENER_CANCONSUME). If ALL_WINDOWS or CANCONSUME are used, the event is consumed upon receipt if one of @listener's callbacks returns %TRUE (other sync_type values may be available in the future). %TRUE if successful, otherwise %FALSE. a pointer to the #AtspiDeviceListener for which keystroke events are requested. a pointer to the #AtspiKeyDefinition array indicating which keystroke events are requested, or NULL to indicate that all keycodes and keyvals for the specified modifier set are to be included. an #AtspiKeyMaskType mask indicating which key event modifiers must be set in combination with @keys, events will only be reported for key events for which all modifiers in @modmask are set. If you wish to listen for events with multiple modifier combinations, you must call #atspi_register_keystroke_listener once for each combination. an #AtspiKeyMaskType mask indicating which types of key events are requested (%ATSPI_KEY_PRESSED etc.). an #AtspiKeyListenerSyncType parameter indicating the behavior of the notification/listener transaction. Gets the localized description string describing the #AtspiRole @role. the localized string describing the AtspiRole an #AtspiRole object to query. Gets a localizable string that indicates the name of an #AtspiRole. a localizable string name for an #AtspiRole enumerated type. an #AtspiRole object to query. Sets the main loop context that AT-SPI should assume is in use when setting an idle callback. This function should be called by application-side implementors (ie, at-spi2-atk) when it is desirable to re-enter the main loop. The #GMainContext to use. Deprecated. This function no longer does anything and should not be used. the #AtspiAccessible corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION. Set the timeout used for method calls. If this is not set explicitly, a default of 800 ms is used. Note that at-spi2-registryd currently uses a timeout of 3 seconds when sending a keyboard event notification. This means that, if an AT makes a call in response to the keyboard notification and the application being called does not respond before the timeout is reached, at-spi2-registryd will time out on the keyboard event notification and pass the key onto the application (ie, reply to indicate that the key was not consumed), so this may make it undesirable to set a timeout larger than 3 seconds. By default, the normal timeout is set to 800 ms, and the application startup timeout is set to 15 seconds. The timeout value, in milliseconds, or -1 to disable the timeout. The amount of time, in milliseconds, to allow to pass before enforcing timeouts on an application. Can be used to prevent timeout exceptions if an application is likely to block for an extended period of time on initialization. -1 can be passed to disable this behavior.