This is a singly-linked list (a #GSList) of #AtkAttribute. It is used by atk_text_get_run_attributes(), atk_text_get_default_attributes(), atk_editable_text_set_run_attributes(), atk_document_get_attributes() and atk_object_get_attributes()

An AtkState describes a single state of an object. An AtkState describes a single state of an object. The full set of states that apply to an object at a given time are contained in its #AtkStateSet. See [id@atk_object_ref_state_set] and [id@atk_object_notify_state_change]

The ATK interface provided by UI components which the user can activate/interact with. #AtkAction should be implemented by instances of #AtkObject classes with which the user can interact directly, i.e. buttons, checkboxes, scrollbars, e.g. components which are not "passive" providers of UI information. Exceptions: when the user interaction is already covered by another appropriate interface such as #AtkEditableText (insert/delete text, etc.) or #AtkValue (set value) then these actions should not be exposed by #AtkAction as well. Though most UI interactions on components should be invocable via keyboard as well as mouse, there will generally be a close mapping between "mouse actions" that are possible on a component and the AtkActions. Where mouse and keyboard actions are redundant in effect, #AtkAction should expose only one action rather than exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for #AtkAction names.

Perform the specified action on the object.

%TRUE if success, %FALSE otherwise

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Returns a description of the specified action of the object.

a description string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut". - The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for a button. - The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a traditional "New..." menu item. - The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a traditional "New..." menu item. Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.

the keybinding which can be used to activate this action, or %NULL if there is no keybinding for this action.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Returns the localized name of the specified action of the object.

a name string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object.

a the number of actions, or 0 if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. "click", "press", "release", "drag", "drop", "popup", etc. The "popup" action should be used to pop up a context menu for the object, if one exists. For technical reasons, some toolkits cannot guarantee that the reported action is actually 'bound' to a nontrivial user event; i.e. the result of some actions via atk_action_do_action() may be NIL.

a name string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Sets a description of the specified action of the object.

a gboolean representing if the description was successfully set;

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed the description to be assigned to this action

Perform the specified action on the object.

%TRUE if success, %FALSE otherwise

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Returns a description of the specified action of the object.

a description string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

the keybinding which can be used to activate this action, or %NULL if there is no keybinding for this action.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Returns the localized name of the specified action of the object.

a name string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object.

a the number of actions, or 0 if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

a name string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed

Sets a description of the specified action of the object.

a gboolean representing if the description was successfully set;

a #GObject instance that implements AtkActionIface

the action index corresponding to the action to be performed the description to be assigned to this action

The #AtkAction interface should be supported by any object that can perform one or more actions. The interface provides the standard mechanism for an assistive technology to determine what those actions are as well as tell the object to perform them. Any object that can be manipulated should support this interface.

%TRUE if success, %FALSE otherwise

a #GObject instance that implements AtkActionIface the action index corresponding to the action to be performed

a the number of actions, or 0 if @action does not implement this interface.

a #GObject instance that implements AtkActionIface

a description string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface the action index corresponding to the action to be performed

a name string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface the action index corresponding to the action to be performed

the keybinding which can be used to activate this action, or %NULL if there is no keybinding for this action.

a #GObject instance that implements AtkActionIface the action index corresponding to the action to be performed

a gboolean representing if the description was successfully set;

a #GObject instance that implements AtkActionIface the action index corresponding to the action to be performed the description to be assigned to this action

a name string, or %NULL if @action does not implement this interface.

a #GObject instance that implements AtkActionIface the action index corresponding to the action to be performed

AtkAttribute is a string name/value pair representing a generic attribute. This can be used to expose additional information from an accessible object as a whole (see atk_object_get_attributes()) or an document (see atk_document_get_attributes()). In the case of text attributes (see atk_text_get_default_attributes()), #AtkTextAttribute enum defines all the possible text attribute names. You can use atk_text_attribute_get_name() to get the string name from the enum value. See also atk_text_attribute_for_name() and atk_text_attribute_get_value() for more information. A string name/value pair representing a generic attribute.

The attribute name. the value of the attribute, represented as a string. Frees the memory used by an #AtkAttributeSet, including all its #AtkAttributes.

The #AtkAttributeSet to free

Like atk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.

Returns %TRUE if the version of the ATK header files is the same as or newer than the passed-in version.

major version (e.g. 1 for version 1.2.5) minor version (e.g. 2 for version 1.2.5) micro version (e.g. 5 for version 1.2.5)

The ATK interface provided by UI components which occupy a physical area on the screen. which the user can activate/interact with. #AtkComponent should be implemented by most if not all UI elements with an actual on-screen presence, i.e. components which can be said to have a screen-coordinate bounding box. Virtually all widgets will need to have #AtkComponent implementations provided for their corresponding #AtkObject class. In short, only UI elements which are *not* GUI elements will omit this ATK interface. A possible exception might be textual information with a transparent background, in which case text glyph bounding box information is provided by #AtkText.

Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again

If you need to track when an object gains or lose the focus, use the #AtkObject::state-change "focused" notification instead.

a handler id which can be used in atk_component_remove_focus_handler() or zero if the handler was already added.

The #AtkComponent to attach the @handler to

The #AtkFocusHandler to be attached to @component

Checks whether the specified point is within the extent of the @component. Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.

%TRUE or %FALSE indicating whether the specified point is within the extent of the @component or not

the #AtkComponent

x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the components top level window

Returns the alpha value (i.e. the opacity) for this @component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

An alpha value from 0 to 1.0, inclusive.

an #AtkComponent

Gets the rectangle which gives the extent of the @component. If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.

an #AtkComponent

address of #gint to put x coordinate address of #gint to put y coordinate address of #gint to put width address of #gint to put height specifies whether the coordinates are relative to the screen or to the components top level window

Gets the layer of the component.

an #AtkLayer which is the layer of the component

an #AtkComponent

Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.

a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container.

an #AtkComponent

Gets the position of @component in the form of a point specifying @component's top-left corner. If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.

Since 2.12. Use atk_component_get_extents() instead.

an #AtkComponent

address of #gint to put x coordinate position address of #gint to put y coordinate position specifies whether the coordinates are relative to the screen or to the components top level window

Gets the size of the @component in terms of width and height. If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.

Since 2.12. Use atk_component_get_extents() instead.

an #AtkComponent

address of #gint to put width of @component address of #gint to put height of @component

Grabs focus for this @component.

%TRUE if successful, %FALSE otherwise.

an #AtkComponent

Gets a reference to the accessible child, if one exists, at the coordinate point specified by @x and @y.

a reference to the accessible child, if one exists

the #AtkComponent

x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the components top level window

Remove the handler specified by @handler_id from the list of functions to be executed when this object receives focus events (in or out).

If you need to track when an object gains or lose the focus, use the #AtkObject::state-change "focused" notification instead.

the #AtkComponent to remove the focus handler from

the handler id of the focus handler to be removed from @component

Makes @component visible on the screen by scrolling all necessary parents. Contrary to atk_component_set_position, this does not actually move @component in its parent, this only makes the parents scroll so that the object shows up on the screen, given its current position within the parents.

whether scrolling was successful.

an #AtkComponent

specify where the object should be made visible.

Move the top-left of @component to a given position of the screen by scrolling all necessary parents.

whether scrolling was successful.

an #AtkComponent

specify whether coordinates are relative to the screen or to the parent object. x-position where to scroll to y-position where to scroll to

Sets the extents of @component.

%TRUE or %FALSE whether the extents were set or not

an #AtkComponent

x coordinate y coordinate width to set for @component height to set for @component specifies whether the coordinates are relative to the screen or to the components top level window

Sets the position of @component. Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves @component in its parent.

%TRUE or %FALSE whether or not the position was set or not

an #AtkComponent

x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the component's top level window

Set the size of the @component in terms of width and height.

%TRUE or %FALSE whether the size was set or not

an #AtkComponent

width to set for @component height to set for @component

Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again

If you need to track when an object gains or lose the focus, use the #AtkObject::state-change "focused" notification instead.

a handler id which can be used in atk_component_remove_focus_handler() or zero if the handler was already added.

The #AtkComponent to attach the @handler to

The #AtkFocusHandler to be attached to @component

%TRUE or %FALSE indicating whether the specified point is within the extent of the @component or not

the #AtkComponent

x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the components top level window

Returns the alpha value (i.e. the opacity) for this @component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

An alpha value from 0 to 1.0, inclusive.

an #AtkComponent

Gets the rectangle which gives the extent of the @component. If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.

an #AtkComponent

Gets the layer of the component.

an #AtkLayer which is the layer of the component

an #AtkComponent

Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.

a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container.

an #AtkComponent

Since 2.12. Use atk_component_get_extents() instead.

an #AtkComponent

address of #gint to put x coordinate position address of #gint to put y coordinate position specifies whether the coordinates are relative to the screen or to the components top level window

Gets the size of the @component in terms of width and height. If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.

Since 2.12. Use atk_component_get_extents() instead.

an #AtkComponent

address of #gint to put width of @component address of #gint to put height of @component

Grabs focus for this @component.

%TRUE if successful, %FALSE otherwise.

an #AtkComponent

Gets a reference to the accessible child, if one exists, at the coordinate point specified by @x and @y.

a reference to the accessible child, if one exists

the #AtkComponent

x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the components top level window

Remove the handler specified by @handler_id from the list of functions to be executed when this object receives focus events (in or out).

If you need to track when an object gains or lose the focus, use the #AtkObject::state-change "focused" notification instead.

the #AtkComponent to remove the focus handler from

the handler id of the focus handler to be removed from @component

whether scrolling was successful.

an #AtkComponent

specify where the object should be made visible.

Move the top-left of @component to a given position of the screen by scrolling all necessary parents.

whether scrolling was successful.

an #AtkComponent

specify whether coordinates are relative to the screen or to the parent object. x-position where to scroll to y-position where to scroll to

Sets the extents of @component.

%TRUE or %FALSE whether the extents were set or not

an #AtkComponent

x coordinate y coordinate width to set for @component height to set for @component specifies whether the coordinates are relative to the screen or to the components top level window

Sets the position of @component. Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves @component in its parent.

%TRUE or %FALSE whether or not the position was set or not

an #AtkComponent

x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the component's top level window

Set the size of the @component in terms of width and height.

%TRUE or %FALSE whether the size was set or not

an #AtkComponent

width to set for @component height to set for @component

The 'bounds-changed" signal is emitted when the position or size of the component changes.

The AtkRectangle giving the new position and size.

The AtkComponent interface should be supported by any object that is rendered on the screen. The interface provides the standard mechanism for an assistive technology to determine and set the graphical representation of an object.

This virtual function is deprecated since 2.9.4 and it should not be overriden. See atk_component_add_focus_handler() for more information.

a handler id which can be used in atk_component_remove_focus_handler() or zero if the handler was already added.

The #AtkComponent to attach the @handler to The #AtkFocusHandler to be attached to @component

%TRUE or %FALSE indicating whether the specified point is within the extent of the @component or not

the #AtkComponent x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the components top level window

a reference to the accessible child, if one exists

the #AtkComponent x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the components top level window

an #AtkComponent address of #gint to put x coordinate address of #gint to put y coordinate address of #gint to put width address of #gint to put height specifies whether the coordinates are relative to the screen or to the components top level window

This virtual function is deprecated since 2.12 and it should not be overriden. Use @AtkComponentIface.get_extents instead.

an #AtkComponent address of #gint to put x coordinate position address of #gint to put y coordinate position specifies whether the coordinates are relative to the screen or to the components top level window

This virtual function is deprecated since 2.12 and it should not be overriden. Use @AtkComponentIface.get_extents instead.

an #AtkComponent address of #gint to put width of @component address of #gint to put height of @component

%TRUE if successful, %FALSE otherwise.

an #AtkComponent

This virtual function is deprecated since 2.9.4 and it should not be overriden. See atk_component_remove_focus_handler() for more information.

the #AtkComponent to remove the focus handler from the handler id of the focus handler to be removed from @component

%TRUE or %FALSE whether the extents were set or not

an #AtkComponent x coordinate y coordinate width to set for @component height to set for @component specifies whether the coordinates are relative to the screen or to the components top level window

%TRUE or %FALSE whether or not the position was set or not

an #AtkComponent x coordinate y coordinate specifies whether the coordinates are relative to the screen or to the component's top level window

%TRUE or %FALSE whether the size was set or not

an #AtkComponent width to set for @component height to set for @component

an #AtkLayer which is the layer of the component

an #AtkComponent

a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container.

an #AtkComponent

An alpha value from 0 to 1.0, inclusive.

an #AtkComponent

whether scrolling was successful.

an #AtkComponent specify where the object should be made visible.

whether scrolling was successful.

an #AtkComponent specify whether coordinates are relative to the screen or to the parent object. x-position where to scroll to y-position where to scroll to

Specifies how xy coordinates are to be interpreted. Used by functions such as atk_component_get_position() and atk_text_get_character_extents() 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. Since: 2.30

A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE(), but defines an abstract type.

The name of the new type, in Camel case. The name of the new type, in lowercase, with words separated by '_'. The #GType of the parent type.

A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE_WITH_CODE(), but defines an abstract type.

The name of the new type, in Camel case. The name of the new type, in lowercase, with words separated by '_'. The #GType of the parent type. Custom code that gets inserted in the _get_type() function.

A convenience macro for type ATK implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these) and a static variable named @t_n _parent_class pointing to the parent class. Furthermore, it defines a _get_type() function.

The name of the new type, in Camel case. The name of the new type, in lowercase, with words separated by '_'. The #GType of the parent type.

The most general convenience macro for ATK type implementations, on which ATK_DEFINE_TYPE(), etc are based.

The name of the new type, in Camel case. The name of the new type, in lowercase, with words separated by '_'. The #GType of the parent type. #GTypeFlags to pass to g_type_register_static() Custom code that gets inserted in the _get_type() function.

A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE(), but allows you to insert custom code into the _get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().

The name of the new type, in Camel case. The name of the new type in lowercase, with words separated by '_'. The #GType of the parent type. Custom code that gets inserted in the _get_type() function.

The ATK interface which represents the toplevel container for document content. The AtkDocument interface should be supported by any object whose content is a representation or view of a document. The AtkDocument interface should appear on the toplevel container for the document content; however AtkDocument instances may be nested (i.e. an AtkDocument may be a descendant of another AtkDocument) in those cases where one document contains "embedded content" which can reasonably be considered a document in its own right.

Retrieves the current page number inside @document.

the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant.

the #AtkDocument

Gets a %gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer.

Since 2.12. @document is already a representation of the document. Use it directly, or one of its children, as an instance of the DOM.

a %gpointer that points to an instance of the DOM.

a #GObject instance that implements AtkDocumentIface

Retrieves the value of the given @attribute_name inside @document.

a string value associated with the named attribute for this document, or %NULL if a value for @attribute_name has not been specified for this document.

a #GObject instance that implements AtkDocumentIface

a character string representing the name of the attribute whose value is being queried.

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole.

a #GObject instance that implements AtkDocumentIface

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and atk_image_get_image_locale.

Please use atk_object_get_object_locale() instead.

a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale.

a #GObject instance that implements AtkDocumentIface

Gets a string indicating the document type.

Since 2.12. Please use atk_document_get_attributes() to ask for the document type if it applies.

a string indicating the document type

a #GObject instance that implements AtkDocumentIface

Retrieves the total number of pages inside @document.

total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant.

the #AtkDocument

Returns an array of AtkTextSelections within this document.

a GArray of AtkTextSelection structures representing the selection.

an #AtkDocument

Sets the value for the given @attribute_name inside @document.

%TRUE if @attribute_value is successfully associated with @attribute_name for this @document, and %FALSE if if the document does not allow the attribute to be modified

a #GObject instance that implements #AtkDocumentIface

a character string representing the name of the attribute whose value is being set. a string value to be associated with @attribute_name.

Makes 1 or more selections within this document denoted by the given array of AtkTextSelections. 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 #AtkDocument.

a GArray of AtkTextSelections to be selected.

Retrieves the value of the given @attribute_name inside @document.

a string value associated with the named attribute for this document, or %NULL if a value for @attribute_name has not been specified for this document.

a #GObject instance that implements AtkDocumentIface

a character string representing the name of the attribute whose value is being queried.

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole.

a #GObject instance that implements AtkDocumentIface

Retrieves the current page number inside @document.

the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant.

the #AtkDocument

Gets a %gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer.

Since 2.12. @document is already a representation of the document. Use it directly, or one of its children, as an instance of the DOM.

a %gpointer that points to an instance of the DOM.

a #GObject instance that implements AtkDocumentIface

Gets a string indicating the document type.

Since 2.12. Please use atk_document_get_attributes() to ask for the document type if it applies.

a string indicating the document type

a #GObject instance that implements AtkDocumentIface

Please use atk_object_get_object_locale() instead.

a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale.

a #GObject instance that implements AtkDocumentIface

Retrieves the total number of pages inside @document.

total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant.

the #AtkDocument

Returns an array of AtkTextSelections within this document.

a GArray of AtkTextSelection structures representing the selection.

an #AtkDocument

Sets the value for the given @attribute_name inside @document.

%TRUE if @attribute_value is successfully associated with @attribute_name for this @document, and %FALSE if if the document does not allow the attribute to be modified

a #GObject instance that implements #AtkDocumentIface

a character string representing the name of the attribute whose value is being set. a string value to be associated with @attribute_name.

TRUE if the selection was made successfully; FALSE otherwise.

an #AtkDocument.

a GArray of AtkTextSelections to be selected.

The "document-attribute-changed" signal should be emitted when there is a change to one of the document attributes returned by atk_document_get_attributes.

the name of the attribute being modified, or %NULL if not available. the attribute's new value, or %null if not available. The 'load-complete' signal is emitted when a pending load of a static document has completed. This signal is to be expected by ATK clients if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY, it should be safe for clients to assume that the AtkDocument's static contents are fully loaded into the container. (Dynamic document contents should be exposed via other signals.)

The 'load-stopped' signal is emitted when a pending load of document contents is cancelled, paused, or otherwise interrupted by the user or application logic. It should not however be emitted while waiting for a resource (for instance while blocking on a file or network read) unless a user-significant timeout has occurred.

The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.

the new page number. If this value is unknown or not applicable, -1 should be provided. The 'reload' signal is emitted when the contents of a document is refreshed from its source. Once 'reload' has been emitted, a matching 'load-complete' or 'load-stopped' signal should follow, which clients may await before interrogating ATK for the latest document content.

gets a string indicating the document type. This virtual function is deprecated since 2.12 and it should not be overriden.

a string indicating the document type

a #GObject instance that implements AtkDocumentIface

a #GObject instance that implements AtkDocumentIface. This virtual method is deprecated since 2.12 and it should not be overriden.

a %gpointer that points to an instance of the DOM.

a #GObject instance that implements AtkDocumentIface

gets locale. This virtual function is deprecated since 2.7.90 and it should not be overriden.

a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale.

a #GObject instance that implements AtkDocumentIface

gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole.

a #GObject instance that implements AtkDocumentIface

returns a string value assocciated with the named attribute for this document, or NULL

a string value associated with the named attribute for this document, or %NULL if a value for @attribute_name has not been specified for this document.

a #GObject instance that implements AtkDocumentIface a character string representing the name of the attribute whose value is being queried.

sets the value of an attribute. Returns TRUE on success, FALSE otherwise

%TRUE if @attribute_value is successfully associated with @attribute_name for this @document, and %FALSE if if the document does not allow the attribute to be modified

a #GObject instance that implements #AtkDocumentIface a character string representing the name of the attribute whose value is being set. a string value to be associated with @attribute_name.

gets the current page number. Since 2.12

the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant.

the #AtkDocument

gets the page count of the document. Since 2.12

total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant.

the #AtkDocument

a GArray of AtkTextSelection structures representing the selection.

an #AtkDocument

TRUE if the selection was made successfully; FALSE otherwise.

an #AtkDocument. a GArray of AtkTextSelections to be selected.

The ATK interface implemented by components containing user-editable text content. #AtkEditableText should be implemented by UI components which contain text which the user can edit, via the #AtkObject corresponding to that component (see #AtkObject). #AtkEditableText is a subclass of #AtkText, and as such, an object which implements #AtkEditableText is by definition an #AtkText implementor as well. See [iface@AtkText]

Copy text from @start_pos up to, but not including @end_pos to the clipboard.

an #AtkEditableText

start position end position

Copy text from @start_pos up to, but not including @end_pos to the clipboard and then delete from the widget.

an #AtkEditableText

start position end position

Delete text @start_pos up to, but not including @end_pos.

an #AtkEditableText

start position end position

Insert text at a given position.

an #AtkEditableText

the text to insert the length of text to insert, in bytes The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.

Paste text from clipboard to specified @position.

an #AtkEditableText

position to paste

Sets the attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets.

%TRUE if attributes successfully set for the specified range, otherwise %FALSE

an #AtkEditableText

an #AtkAttributeSet start of range in which to set attributes end of range in which to set attributes

Set text contents of @text.

an #AtkEditableText

string to set for text contents of @text

Copy text from @start_pos up to, but not including @end_pos to the clipboard.

an #AtkEditableText

start position end position

Copy text from @start_pos up to, but not including @end_pos to the clipboard and then delete from the widget.

an #AtkEditableText

start position end position

Delete text @start_pos up to, but not including @end_pos.

an #AtkEditableText

start position end position

Insert text at a given position.

an #AtkEditableText

Paste text from clipboard to specified @position.

an #AtkEditableText

position to paste

%TRUE if attributes successfully set for the specified range, otherwise %FALSE

an #AtkEditableText

an #AtkAttributeSet start of range in which to set attributes end of range in which to set attributes

Set text contents of @text.

an #AtkEditableText

string to set for text contents of @text

%TRUE if attributes successfully set for the specified range, otherwise %FALSE

an #AtkEditableText an #AtkAttributeSet start of range in which to set attributes end of range in which to set attributes

an #AtkEditableText string to set for text contents of @text

an #AtkEditableText the text to insert the length of text to insert, in bytes The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.

an #AtkEditableText start position end position

an #AtkEditableText position to paste

A function which is called when an object emits a matching event, as used in #atk_add_focus_tracker. Currently the only events for which object-specific handlers are supported are events of type "focus:". Most clients of ATK will prefer to attach signal handlers for the various ATK signals instead. see [id@atk_add_focus_tracker]

An #AtkObject instance for whom the callback will be called when the specified event (e.g. 'focus:') takes place.

An #AtkEventListenerInit function is a special function that is called in order to initialize the per-object event registration system used by #AtkEventListener, if any preparation is required. see [id@atk_focus_tracker_init]

The type of callback function used for atk_component_add_focus_handler() and atk_component_remove_focus_handler()

Deprecated with atk_component_add_focus_handler() and atk_component_remove_focus_handler(). See those methods for more information.

the #AtkObject that receives/lose the focus TRUE if the object receives the focus

An AtkFunction is a function definition used for padding which has been added to class and interface structures to allow for expansion in the future.

not used

custom data defined by the user

This object class is derived from AtkObject and can be used as a basis implementing accessible objects. This object class is derived from AtkObject. It can be used as a basis for implementing accessible objects for GObjects which are not derived from GtkWidget. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library.

Gets the accessible object for the specified @obj.

a #AtkObject which is the accessible object for the @obj

a #GObject

Gets the GObject for which @obj is the accessible object.

a #GObject which is the object for which @obj is the accessible object

a #AtkGObjectAccessible

An ATK object which encapsulates a link or set of links in a hypertext document. An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host AtkHypertext object.

Gets the index with the hypertext document at which this link ends.

the index with the hypertext document at which this link ends

an #AtkHyperlink

Gets the number of anchors associated with this hyperlink.

the number of anchors associated with this hyperlink

an #AtkHyperlink

Returns the item associated with this hyperlinks nth anchor. For instance, the returned #AtkObject will implement #AtkText if @link_ is a text hyperlink, #AtkImage if @link_ is an image hyperlink etc. Multiple anchors are primarily used by client-side image maps.

an #AtkObject associated with this hyperlinks i-th anchor

an #AtkHyperlink

a (zero-index) integer specifying the desired anchor

Gets the index with the hypertext document at which this link begins.

the index with the hypertext document at which this link begins

an #AtkHyperlink

Get a the URI associated with the anchor specified by @i of @link_. Multiple anchors are primarily used by client-side image maps.

a string specifying the URI

an #AtkHyperlink

a (zero-index) integer specifying the desired anchor

Determines whether this AtkHyperlink is selected

Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links.

True if the AtkHyperlink is selected, False otherwise

an #AtkHyperlink

Since the document that a link is associated with may have changed this method returns %TRUE if the link is still valid (with respect to the document it references) and %FALSE otherwise.

whether or not this link is still valid

an #AtkHyperlink

Gets the index with the hypertext document at which this link ends.

the index with the hypertext document at which this link ends

an #AtkHyperlink

Gets the number of anchors associated with this hyperlink.

the number of anchors associated with this hyperlink

an #AtkHyperlink

an #AtkObject associated with this hyperlinks i-th anchor

an #AtkHyperlink

a (zero-index) integer specifying the desired anchor

Gets the index with the hypertext document at which this link begins.

the index with the hypertext document at which this link begins

an #AtkHyperlink

Get a the URI associated with the anchor specified by @i of @link_. Multiple anchors are primarily used by client-side image maps.

a string specifying the URI

an #AtkHyperlink

a (zero-index) integer specifying the desired anchor

Indicates whether the link currently displays some or all of its content inline. Ordinary HTML links will usually return %FALSE, but an inline <src> HTML element will return %TRUE.

whether or not this link displays its content inline.

an #AtkHyperlink

Determines whether this AtkHyperlink is selected

Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links.

True if the AtkHyperlink is selected, False otherwise

an #AtkHyperlink

Since the document that a link is associated with may have changed this method returns %TRUE if the link is still valid (with respect to the document it references) and %FALSE otherwise.

whether or not this link is still valid

an #AtkHyperlink

Selected link

Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links.

The signal link-activated is emitted when a link is activated.

a string specifying the URI

an #AtkHyperlink a (zero-index) integer specifying the desired anchor

an #AtkObject associated with this hyperlinks i-th anchor

an #AtkHyperlink a (zero-index) integer specifying the desired anchor

the index with the hypertext document at which this link ends

an #AtkHyperlink

the index with the hypertext document at which this link begins

an #AtkHyperlink

whether or not this link is still valid

an #AtkHyperlink

the number of anchors associated with this hyperlink

an #AtkHyperlink

True if the AtkHyperlink is selected, False otherwise

an #AtkHyperlink

A queryable interface which allows AtkHyperlink instances associated with an AtkObject to be obtained. AtkHyperlinkImpl corresponds to AT-SPI's Hyperlink interface, and differs from AtkHyperlink in that AtkHyperlink is an object type, rather than an interface, and thus cannot be directly queried. FTW

Gets the hyperlink associated with this object.

an AtkHyperlink object which points to this implementing AtkObject.

a #GObject instance that implements AtkHyperlinkImplIface

Gets the hyperlink associated with this object.

an AtkHyperlink object which points to this implementing AtkObject.

a #GObject instance that implements AtkHyperlinkImplIface

an AtkHyperlink object which points to this implementing AtkObject.

a #GObject instance that implements AtkHyperlinkImplIface

Describes the type of link Link is inline The ATK interface which provides standard mechanism for manipulating hyperlinks. 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 included content. While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.

Gets the link in this hypertext document at index @link_index

the link in this hypertext document at index @link_index

an #AtkHypertext

an integer specifying the desired link

Gets the index into the array of hyperlinks that is associated with the character specified by @char_index.

an index into the array of hyperlinks in @hypertext, or -1 if there is no hyperlink associated with this character.

an #AtkHypertext

a character index

Gets the number of links within this hypertext document.

the number of links within this hypertext document

an #AtkHypertext

Gets the link in this hypertext document at index @link_index

the link in this hypertext document at index @link_index

an #AtkHypertext

an integer specifying the desired link

Gets the index into the array of hyperlinks that is associated with the character specified by @char_index.

an index into the array of hyperlinks in @hypertext, or -1 if there is no hyperlink associated with this character.

an #AtkHypertext

a character index

Gets the number of links within this hypertext document.

the number of links within this hypertext document

an #AtkHypertext

The "link-selected" signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.

the index of the hyperlink which is selected

the link in this hypertext document at index @link_index

an #AtkHypertext an integer specifying the desired link

the number of links within this hypertext document

an #AtkHypertext

an index into the array of hyperlinks in @hypertext, or -1 if there is no hyperlink associated with this character.

an #AtkHypertext a character index

Like atk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time.

The ATK Interface implemented by components which expose image or pixmap content on-screen. #AtkImage should be implemented by #AtkObject subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement #AtkImage. #AtkImage primarily provides two types of information: coordinate information (useful for screen review mode of screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image.

Get a textual description of this image.

a string representing the image description

a #GObject instance that implements AtkImageIface

Retrieves the locale identifier associated to the #AtkImage.

a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or %NULL if the image does not specify a locale.

An #AtkImage

Gets the position of the image in the form of a point specifying the images top-left corner. If the position can not be obtained (e.g. missing support), x and y are set to -1.

a #GObject instance that implements AtkImageIface

address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. specifies whether the coordinates are relative to the screen or to the components top level window

Get the width and height in pixels for the specified image. The values of @width and @height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen). If the size can not be obtained (e.g. missing support), x and y are set to -1.

a #GObject instance that implements AtkImageIface

filled with the image width, or -1 if the value cannot be obtained. filled with the image height, or -1 if the value cannot be obtained.

Sets the textual description for this image.

boolean TRUE, or FALSE if operation could not be completed.

a #GObject instance that implements AtkImageIface

a string description to set for @image

Get a textual description of this image.

a string representing the image description

a #GObject instance that implements AtkImageIface

Retrieves the locale identifier associated to the #AtkImage.

a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or %NULL if the image does not specify a locale.

An #AtkImage

Gets the position of the image in the form of a point specifying the images top-left corner. If the position can not be obtained (e.g. missing support), x and y are set to -1.

a #GObject instance that implements AtkImageIface

filled with the image width, or -1 if the value cannot be obtained. filled with the image height, or -1 if the value cannot be obtained.

Sets the textual description for this image.

boolean TRUE, or FALSE if operation could not be completed.

a #GObject instance that implements AtkImageIface

a string description to set for @image

a #GObject instance that implements AtkImageIface address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. specifies whether the coordinates are relative to the screen or to the components top level window

a string representing the image description

a #GObject instance that implements AtkImageIface

a #GObject instance that implements AtkImageIface filled with the image width, or -1 if the value cannot be obtained. filled with the image height, or -1 if the value cannot be obtained.

boolean TRUE, or FALSE if operation could not be completed.

a #GObject instance that implements AtkImageIface a string description to set for @image

a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or %NULL if the image does not specify a locale.

An #AtkImage

Gets a reference to an object's #AtkObject implementation, if the object implements #AtkObjectIface

a reference to an object's #AtkObject implementation

The #GObject instance which should implement #AtkImplementorIface if a non-null return value is required.

The AtkImplementor interface is implemented by objects for which AtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor); Encapsulates information about a key event.

An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE A bitmask representing the state of the modifier keys immediately after the event takes place. The meaning of the bits is currently defined to match the bitmask used by GDK in GdkEventType.state, see http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html#GdkEventKey A guint representing a keysym value corresponding to those used by GDK and X11: see /usr/X11/include/keysymdef.h. The length of member #string. A string containing one of the following: either a string approximating the text that would result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress. Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0", "semicolon", "aacute". Keypad keys have the prefix "KP". The raw hardware code that generated the key event. This field is raraly useful. A timestamp in milliseconds indicating when the event occurred. These timestamps are relative to a starting point which should be considered arbitrary, and only used to compare the dispatch times of events to one another.

Specifies the type of a keyboard evemt. specifies a key press event specifies a key release event Not a valid value; specifies end of enumeration An #AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs, if registered via atk_add_key_event_listener. It allows for pre-emptive interception of key events via the return code as described below.

TRUE (nonzero) if the event emission should be stopped and the event discarded without being passed to the normal GUI recipient; FALSE (zero) if the event dispatch to the client application should proceed as normal. see [id@atk_add_key_event_listener]

an AtkKeyEventStruct containing information about the key event for which notification is being given. a block of data which will be passed to the event listener, on notification.

Describes the layer of a component These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another. The object does not have a layer This layer is reserved for the desktop background This layer is used for Canvas components This layer is normally used for components This layer is used for layered components This layer is used for popup components, such as menus This layer is reserved for future use. This layer is used for toplevel windows. Enumeration used to indicate a type of live region and how assertive it should be in terms of speaking notifications. Currently, this is only used for "notification" events, but it may be used for additional purposes in the future. No live region. This live region should be considered polite. This live region should be considered assertive. Like atk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

Like atk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

Like atk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

A set of ATK utility functions for thread locking A set of utility functions for thread locking. This interface and all his related methods are deprecated since 2.12.

Obtain the singleton instance of AtkMisc for this application.

Since 2.12.

The singleton instance of AtkMisc for this application.

Take the thread mutex for the GUI toolkit, if one exists. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).

Since 2.12.

an AtkMisc instance for this application.

Release the thread mutex for the GUI toolkit, if one exists. This method, and atk_misc_threads_enter, are needed in some situations by threaded application code which services ATK requests, since fulfilling ATK requests often requires calling into the GUI toolkit. If a long-running or potentially blocking call takes place inside such a block, it should be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).

Since 2.12.

an AtkMisc instance for this application.

Take the thread mutex for the GUI toolkit, if one exists. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).

Since 2.12.

an AtkMisc instance for this application.

Since 2.12.

an AtkMisc instance for this application.

Usage of AtkMisc is deprecated since 2.12 and heavily discouraged.

This virtual function is deprecated since 2.12 and it should not be overriden.

an AtkMisc instance for this application.

This virtual function is deprecated sice 2.12 and it should not be overriden.

an AtkMisc instance for this application.

An AtkObject which purports to implement all ATK interfaces. An AtkNoOpObject is an AtkObject which purports to implement all ATK interfaces. It is the type of AtkObject which is created if an accessible object is requested for an object type for which no factory type is specified.

Provides a default (non-functioning stub) #AtkObject. Application maintainers should not use this method.

a default (non-functioning stub) #AtkObject

a #GObject

The AtkObjectFactory which creates an AtkNoOpObject. The AtkObjectFactory which creates an AtkNoOpObject. An instance of this is created by an AtkRegistry if no factory type has not been specified to create an accessible object of a particular type.

Creates an instance of an #AtkObjectFactory which generates primitive (non-functioning) #AtkObjects.

an instance of an #AtkObjectFactory

The base object class for the Accessibility Toolkit API. This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of #AtkObject (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of #AtkObject may also be queried as to whether they implement other ATK interfaces (e.g. #AtkAction, #AtkComponent, etc.), as appropriate to the role which a given UI component plays in a user interface. All UI components in an application which provide useful information or services to the user must provide corresponding #AtkObject instances on request (in GTK+, for instance, usually on a call to #gtk_widget_get_accessible ()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited #AtkObject implementation is insufficient, via instances of a new #AtkObject subclass. See [class@AtkObjectFactory], [class@AtkRegistry]. (GTK+ users see also #GtkAccessible).

Calls @handler on property changes.

Connect directly to #AtkObject::property-change or the relevant #GObject::notify signal for each desired property.

a #guint which is the handler id used in atk_object_remove_property_change_handler()

an #AtkObject

a function to be called when a property changes its value

The signal handler which is executed when there is a focus event for an object. This virtual function is deprecated since 2.9.4 and it should not be overriden. Use the #AtkObject::state-change "focused" signal instead.

Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" #AtkAttributeSet properties.

an #AtkAttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to atk_attribute_set_free().

An #AtkObject.

Gets the accessible description of the accessible.

a character string representing the accessible description of the accessible.

an #AtkObject

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

an integer which is the index of the accessible in its parent

an #AtkObject

Gets the layer of the accessible.

Use atk_component_get_layer instead.

an #AtkLayer which is the layer of the accessible

an #AtkObject

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

Use atk_component_get_mdi_zorder instead.

a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container.

an #AtkObject

Gets the accessible name of the accessible.

a character string representing the accessible name of the object.

an #AtkObject

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible.

a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible.

an #AtkObject

Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method. If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().

an #AtkObject representing the accessible parent of the accessible

an #AtkObject

Gets the role of the accessible.

an #AtkRole which is the role of the accessible

an #AtkObject

This function is called when implementing subclasses of #AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of #AtkObject

a #AtkObject

a #gpointer which identifies the object for which the AtkObject was created.

Gets the #AtkRelationSet associated with the object.

an #AtkRelationSet representing the relation set of the object.

an #AtkObject

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

a reference to an #AtkStateSet which is the state set of the accessible

an #AtkObject

Removes a property change handler.

See atk_object_connect_property_change_handler()

an #AtkObject

a guint which identifies the handler to be removed.

Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

an #AtkObject

a character string to be set as the accessible description

Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

an #AtkObject

a character string to be set as the accessible name

Sets the accessible parent of the accessible. @parent can be NULL.

an #AtkObject

an #AtkObject to be set as the accessible parent

Sets the role of the accessible.

an #AtkObject

an #AtkRole to be set as the role

Adds a relationship of the specified type with the specified target.

TRUE if the relationship is added.

The #AtkObject to which an AtkRelation is to be added.

The #AtkRelationType of the relation The #AtkObject which is to be the target of the relation.

Calls @handler on property changes.

Connect directly to #AtkObject::property-change or the relevant #GObject::notify signal for each desired property.

a #guint which is the handler id used in atk_object_remove_property_change_handler()

an #AtkObject

a function to be called when a property changes its value

Gets the accessible id of the accessible.

a character string representing the accessible id of the object, or NULL if no such string was set.

an #AtkObject

An #AtkObject.

Gets the accessible description of the accessible.

a character string representing the accessible description of the accessible.

an #AtkObject

Gets the help text associated with the accessible.

a character string representing the help text or the object, or NULL if no such string was set.

an #AtkObject

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

an integer which is the index of the accessible in its parent

an #AtkObject

Gets the layer of the accessible.

Use atk_component_get_layer instead.

an #AtkLayer which is the layer of the accessible

an #AtkObject

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

Use atk_component_get_mdi_zorder instead.

a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container.

an #AtkObject

Gets the number of accessible children of the accessible.

an integer representing the number of accessible children of the accessible.

an #AtkObject

Gets the accessible name of the accessible.

a character string representing the accessible name of the object.

an #AtkObject

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible.

a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible.

an #AtkObject

an #AtkObject representing the accessible parent of the accessible

an #AtkObject

Gets the role of the accessible.

an #AtkRole which is the role of the accessible

an #AtkObject

a #AtkObject

a #gpointer which identifies the object for which the AtkObject was created.

Emits a state-change signal for the specified state. Note that as a general rule when the state of an existing object changes, emitting a notification is expected.

an #AtkObject

an #AtkState whose state is changed a gboolean which indicates whether the state is being set on or off

Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns %NULL. This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See atk_object_get_parent() for further reference.

an #AtkObject representing the accessible parent of the accessible if assigned

an #AtkObject

Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.

an #AtkObject representing the specified accessible child of the accessible.

an #AtkObject

a gint representing the position of the child, starting from 0

Gets the #AtkRelationSet associated with the object.

an #AtkRelationSet representing the relation set of the object.

an #AtkObject

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

a reference to an #AtkStateSet which is the state set of the accessible

an #AtkObject

Removes a property change handler.

See atk_object_connect_property_change_handler()

an #AtkObject

a guint which identifies the handler to be removed.

Removes a relationship of the specified type with the specified target.

TRUE if the relationship is removed.

The #AtkObject from which an AtkRelation is to be removed.

The #AtkRelationType of the relation The #AtkObject which is the target of the relation to be removed.

Sets 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. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.

an #AtkObject

a character string to be set as the accessible id

an #AtkObject

a character string to be set as the accessible description

Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object. You can't set the help text to NULL. This is reserved for the initial value. If you want to set the name to an empty value, you can use "".

an #AtkObject

a character string to be set as the accessible's help text

an #AtkObject

a character string to be set as the accessible name

Sets the accessible parent of the accessible. @parent can be NULL.

an #AtkObject

an #AtkObject to be set as the accessible parent

Sets the role of the accessible.

an #AtkObject

an #AtkRole to be set as the role

Table caption.

Since 1.3. Use table-caption-object instead.

Accessible table column description.

Since 2.12. Use atk_table_get_column_description() and atk_table_set_column_description() instead.

Accessible table column header.

Since 2.12. Use atk_table_get_column_header() and atk_table_set_column_header() instead.

Accessible table row description.

Since 2.12. Use atk_table_get_row_description() and atk_table_set_row_description() instead.

Accessible table row header.

Since 2.12. Use atk_table_get_row_header() and atk_table_set_row_header() instead.

Numeric value of this object, in case being and AtkValue.

Since 2.12. Use atk_value_get_value_and_text() to get the value, and value-changed signal to be notified on their value changes.

The "active-descendant-changed" signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

the newly focused object. The "announcement" signal can be emitted to pass an announcement on to be read by a screen reader. Depcrecated (2.50): Use AtkObject::notification instead.

the text to be announced. The "attribute-changed" signal should be emitted when one of an object's attributes changes.

the name of the attribute being modified, or %NULL if not available. the attribute's new value, or %null if not available. The signal "children-changed" is emitted when a child is added or removed from an object. It supports two details: "add" and "remove"

The index of the added or removed child. The value can be -1. This is used if the value is not known by the implementor when the child is added/removed or irrelevant. A gpointer to the child AtkObject which was added or removed. If the child was removed, it is possible that it is not available for the implementor. In that case this pointer can be NULL. The signal "focus-event" is emitted when an object gained or lost focus.

Use the #AtkObject::state-change signal instead.

a boolean value which indicates whether the object gained or lost focus. The "notification" signal can be emitted to pass an announcement on to be read by a screen reader.

the text to be announced. an #AtkLive specifying the politeness of the notification. Should be either ATK_LIVE_POLITE or ATK_LIVE_ASSERTIVE. The signal "property-change" is emitted when an object's property value changes. @arg1 contains an #AtkPropertyValues with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not guarantee that the value of the property has actually changed; it may also be emitted when the setter of the property is called to reinstate the previous value. Toolkit implementor note: ATK implementors should use g_object_notify() to emit property-changed notifications. #AtkObject::property-changed is needed by the implementation of atk_add_global_event_listener() because GObject notify doesn't support emission hooks.

an #AtkPropertyValues containing the new value of the property which changed. The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.

The name of the state which has changed A boolean which indicates whether the state has been set or unset. The "visible-data-changed" signal is emitted when the visual appearance of the object changed.

a character string representing the accessible name of the object.

an #AtkObject

a character string representing the accessible description of the accessible.

an #AtkObject

an #AtkObject representing the accessible parent of the accessible

an #AtkObject

an integer which is the index of the accessible in its parent

an #AtkObject

an #AtkRelationSet representing the relation set of the object.

an #AtkObject

an #AtkRole which is the role of the accessible

an #AtkObject

an #AtkLayer which is the layer of the accessible

an #AtkObject

a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container.

an #AtkObject

a reference to an #AtkStateSet which is the state set of the accessible

an #AtkObject

an #AtkObject a character string to be set as the accessible name

an #AtkObject a character string to be set as the accessible description

an #AtkObject an #AtkObject to be set as the accessible parent

an #AtkObject an #AtkRole to be set as the role

specifies a function to be called when a property changes value. This virtual function is deprecated since 2.12 and it should not be overriden. Connect directly to property-change or notify signal instead.

a #guint which is the handler id used in atk_object_remove_property_change_handler()

an #AtkObject a function to be called when a property changes its value

removes a property changed handler as returned by @connect_property_change_handler. This virtual function is deprecated sice 2.12 and it should not be overriden.

an #AtkObject a guint which identifies the handler to be removed.

a #AtkObject a #gpointer which identifies the object for which the AtkObject was created.

An #AtkObject.

a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible.

an #AtkObject

The base object class for a factory used to create accessible objects for objects of a specific GType. This class is the base object class for a factory used to create an accessible object for a specific GType. The function atk_registry_set_factory_type() is normally called to store in the registry the factory type to be used to create an accessible of a particular GType.

Inform @factory that it is no longer being used to create accessibles. When called, @factory may need to inform #AtkObjects which it has created that they need to be re-instantiated. Note: primarily used for runtime replacement of #AtkObjectFactorys in object registries.

an #AtkObjectFactory to invalidate

Provides an #AtkObject that implements an accessibility interface on behalf of @obj

an #AtkObject that implements an accessibility interface on behalf of @obj

The #AtkObjectFactory associated with @obj's object type

a #GObject

Gets the GType of the accessible which is created by the factory.

the type of the accessible which is created by the @factory. The value G_TYPE_INVALID is returned if no type if found.

an #AtkObjectFactory

an #AtkObjectFactory to invalidate

Toplevel for embedding into other processes See [class@AtkSocket]

Creates a new #AtkPlug instance.

the newly created #AtkPlug

Gets the unique ID of an #AtkPlug object, which can be used to embed inside of an #AtkSocket using atk_socket_embed(). Internally, this calls a class function that should be registered by the IPC layer (usually at-spi2-atk). The implementor of an #AtkPlug object should call this function (after atk-bridge is loaded) and pass the value to the process implementing the #AtkSocket, so it could embed the plug.

the unique ID for the plug

an #AtkPlug

Sets @child as accessible child of @plug and @plug as accessible parent of @child. @child can be NULL. In some cases, one can not use the AtkPlug type directly as accessible object for the toplevel widget of the application. For instance in the gtk case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and from AtkPlug. In such a case, one can create, in addition to the standard accessible object for the toplevel widget, an AtkPlug object, and make the former the child of the latter by calling atk_plug_set_child().

an #AtkPlug to be set as accessible parent of @child.

an #AtkObject to be set as accessible child of @plug.

An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to atk_object_connect_property_change_handler().

Since 2.12.

atkobject which property changes values changed

Note: @old_value field of #AtkPropertyValues will not contain a valid value. This is a field defined with the purpose of contain the previous value of the property, but is not used anymore.

The name of the ATK property which has changed. NULL. This field is not used anymore. The new value of the named property.

A given range or subrange, to be used with #AtkValue #AtkRange are used on #AtkValue, in order to represent the full range of a given component (for example an slider or a range control), or to define each individual subrange this full range is splitted if available. See #AtkValue documentation for further details.

Creates a new #AtkRange.

a new #AtkRange

inferior limit for this range superior limit for this range human readable description of this range.

Returns a new #AtkRange that is a exact copy of @src

a new #AtkRange copy of @src

#AtkRange to copy

Free @range

#AtkRange to free

Returns the human readable description of @range

the human-readable description of @range

an #AtkRange

Returns the lower limit of @range

the lower limit of @range

an #AtkRange

Returns the upper limit of @range

the upper limit of @range

an #AtkRange

A data structure for holding a rectangle. Those coordinates are relative to the component top-level parent.

X coordinate of the left side of the rectangle. Y coordinate of the top side of the rectangle. width of the rectangle. height of the rectangle.

An object used to store the GType of the factories used to create an accessible object for an object of a particular GType. The AtkRegistry is normally used to create appropriate ATK "peers" for user interface components. Application developers usually need only interact with the AtkRegistry by associating appropriate ATK implementation classes with GObject classes via the atk_registry_set_factory_type call, passing the appropriate GType for application custom widget classes.

Gets an #AtkObjectFactory appropriate for creating #AtkObjects appropriate for @type.

an #AtkObjectFactory appropriate for creating #AtkObjects appropriate for @type.

an #AtkRegistry

a #GType with which to look up the associated #AtkObjectFactory

Provides a #GType indicating the #AtkObjectFactory subclass associated with @type.

a #GType associated with type @type

an #AtkRegistry

a #GType with which to look up the associated #AtkObjectFactory subclass

Associate an #AtkObjectFactory subclass with a #GType. Note: The associated @factory_type will thereafter be responsible for the creation of new #AtkObject implementations for instances appropriate for @type.

the #AtkRegistry in which to register the type association

an #AtkObject type an #AtkObjectFactory type to associate with @type. Must implement AtkObject appropriate for @type.

An object used to describe a relation between a object and one or more other objects. An AtkRelation describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as an AtkRelationSet, which is a set of AtkRelations.

Create a new relation for the specified key and the specified list of targets. See also atk_object_add_relationship().

a pointer to a new #AtkRelation

an array of pointers to #AtkObjects number of #AtkObjects pointed to by @targets an #AtkRelationType with which to create the new #AtkRelation

Adds the specified AtkObject to the target for the relation, if it is not already present. See also atk_object_add_relationship().

an #AtkRelation

an #AtkObject

Gets the type of @relation

the type of @relation

an #AtkRelation

Gets the target list of @relation

the target list of @relation

an #AtkRelation

Remove the specified AtkObject from the target for the relation.

TRUE if the removal is successful.

an #AtkRelation

an #AtkObject

A set of AtkRelations, normally the set of AtkRelations which an AtkObject has. The AtkRelationSet held by an object establishes its relationships with objects beyond the normal "parent/child" hierarchical relationships that all user interface objects have. AtkRelationSets establish whether objects are labelled or controlled by other components, share group membership with other components (for instance within a radio-button group), or share content which "flows" between them, among other types of possible relationships.

Creates a new empty relation set.

a new #AtkRelationSet

Add a new relation to the current relation set if it is not already present. This function ref's the AtkRelation so the caller of this function should unref it to ensure that it will be destroyed when the AtkRelationSet is destroyed.

an #AtkRelationSet

an #AtkRelation

Add a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. If it is does contain a relation of that typea the target is added to the relation.

an #AtkRelationSet

an #AtkRelationType an #AtkObject

Determines whether the relation set contains a relation that matches the specified type.

%TRUE if @relationship is the relationship type of a relation in @set, %FALSE otherwise

an #AtkRelationSet

an #AtkRelationType

Determines whether the relation set contains a relation that matches the specified pair formed by type @relationship and object @target.

%TRUE if @set contains a relation with the relationship type @relationship with an object @target, %FALSE otherwise

an #AtkRelationSet

an #AtkRelationType an #AtkObject

Determines the number of relations in a relation set.

an integer representing the number of relations in the set.

an #AtkRelationSet

Determines the relation at the specified position in the relation set.

a #AtkRelation, which is the relation at position i in the set.

an #AtkRelationSet

a gint representing a position in the set, starting from 0.

Finds a relation that matches the specified type.

an #AtkRelation, which is a relation matching the specified type.

an #AtkRelationSet

an #AtkRelationType

Removes a relation from the relation set. This function unref's the #AtkRelation so it will be deleted unless there is another reference to it.

an #AtkRelationSet

an #AtkRelation

Describes the type of the relation Not used, represens "no relationship" or an error condition. Indicates an object controlled by one or more target objects. Indicates an object is an controller for one or more target objects. Indicates an object is a label for one or more target objects. Indicates an object is labelled by one or more target objects. Indicates an object is a member of a group of one or more target objects. Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow). Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow). Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component. Indicates that the object visually embeds another object's content, i.e. this object's content flows around another's content. Reciprocal of %ATK_RELATION_EMBEDS, indicates that this object's content is visualy embedded in another object. Indicates that an object is a popup for another object. Indicates that an object is a parent window of another object. Reciprocal of %ATK_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 %ATK_RELATION_LABELLED_BY. For an on-screen error message, use %ATK_RELATION_ERROR_MESSAGE. For lengthy extended descriptive information contained in an on-screen object, consider using %ATK_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 %ATK_RELATION_DESCRIBED_BY. Indicates that this object provides descriptive information about the target object(s). See also %ATK_RELATION_DETAILS_FOR and %ATK_RELATION_ERROR_FOR. Indicates an object is a cell in a treetable and is expanded to display other cells in the same column. Reciprocal of %ATK_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 %ATK_RELATION_DESCRIBED_BY. If the detailed information describes an error condition, %ATK_RELATION_ERROR_FOR should be used instead. @Since: ATK-2.26. Reciprocal of %ATK_RELATION_DETAILS. Indicates that this object provides a detailed or extended description about the target object(s). See also %ATK_RELATION_DESCRIPTION_FOR and %ATK_RELATION_ERROR_FOR. @Since: ATK-2.26. Reciprocal of %ATK_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 %ATK_STATE_INVALID_ENTRY in their #AtkStateSet. @Since: ATK-2.26. Reciprocal of %ATK_RELATION_ERROR_MESSAGE. Indicates that this object contains an error message describing an invalid condition in the target object(s). @Since: ATK_2.26. Not used, this value indicates the end of the enumeration. Get the #AtkRelationType type corresponding to a relation name.

the #AtkRelationType enumerated type corresponding to the specified name, or #ATK_RELATION_NULL if no matching relation type is found.

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

Gets the description string describing the #AtkRelationType @type.

the string describing the AtkRelationType

The #AtkRelationType whose name is required

Associate @name with a new #AtkRelationType

an #AtkRelationType associated with @name

a name string

Describes the role of an object These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= %ATK_ROLE_LAST_DEFINED is not necessarily an error. Invalid role A label which represents an accelerator An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc. An object which is an animated image An arrow in one of the four cardinal directions An object that displays a calendar and allows the user to select a date An 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 with a check box A specialized dialog that lets the user choose a color The header for a column of data A collapsible list of choices the user can select from An object whose purpose is to allow a user to edit a date An inconifed internal frame within a DESKTOP_PANE A pane that supports internal frames and iconified versions of those internal frames An object whose purpose is to allow a user to set a value 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 lets the user choose a file A object that fills up space in a user interface A specialized dialog that lets the user choose a 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 object whose primary purpose is to display an image 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 A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected 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. An object that allows a user to incrementally view a large amount of information 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 A specialized panel that presents two other panels at the same time An object used to get an integer or floating point number from the user An object which reports messages of minor importance to the user An object used to represent information in terms of rows and columns A cell in a table The header for a column of a table The header for a row of a table A menu item used to tear off and reattach its menu An object that represents an accessible terminal. (Since: 0.6) An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For widgets whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see ATK_ROLE_STATIC. A specialized push button that can be checked or unchecked, but does not provide 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 represent hierarchical information to the user An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7) The object contains some Accessible information, but its role is not known An object usually used in a scroll pane A top level window with no title or border. An object that serves as a document header. (Since: 1.1.1) An object that serves as a document footer. (Since: 1.1.1) An object which is contains a paragraph of text content. (Since: 1.1.1) An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1) The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4) 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. (Since: 1.3) The object is an editable text object in a toolbar. (Since: 1.5) The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. (Since: 1.7.2) The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present. (Since: 1.11) The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. (Since: 1.11) The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. (Since: 1.11) The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. (Since: 1.11) 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. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. (Since: 1.11) 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. (Since: 1.11) The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. (Since: 1.11) The object is a container for form controls, for instance as part of a web form or user-input form within a document. This role is primarily a tag/convenience for clients when navigating complex documents, it is not expected that ordinary GUI containers will always have ATK_ROLE_FORM. (Since: 1.12.0) The object is a hypertext anchor, i.e. a "link" in a hypertext document. Such objects are distinct from 'inline' content which may also use the Hypertext/Hyperlink interfaces to indicate the range/location within a text object where an inline or embedded object lies. (Since: 1.12.1) 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." (Since: 1.12.1) A row in a table. (Since: 2.1.0) An object that represents an element of a tree. (Since: 2.1.0) A document frame which contains a spreadsheet. (Since: 2.1.0) A document frame which contains a presentation or slide content. (Since: 2.1.0) A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0) A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0) A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0) 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. (Since: 2.1.0) A non-collapsible list of choices the user can select from. (Since: 2.1.0) A group of related widgets. This group typically has a label. (Since: 2.1.0) 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. (Since: 2.1.0) A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. (Since: 2.1.0) An object designed to present a message to the user within an existing window. (Since: 2.1.0) 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.7.3) 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 AtkValue. (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) An object that represents a list of term-value groups. A term-value group represents a individual description and consist of one or more names (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be more than one group with the same term name. (Since: 2.12) An object that represents a term or phrase with a corresponding definition. (Since: 2.12) An object that represents the description, definition or value of a term. (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 %ATK_ROLE_STATIC is appropriate include the message displayed in a message box and an image used as an alternative means to display text. %ATK_ROLE_STATIC should not be applied to widgets which are traditionally interactive, objects which display a significant amount of content, or any object which has an accessible relation pointing to another object. Implementors should expose the displayed information through the accessible name of the object. If doing so seems inappropriate, it may indicate that a different role should be used. For labels which describe another widget, see %ATK_ROLE_LABEL. For text views, see %ATK_ROLE_TEXT. For generic containers, see %ATK_ROLE_PANEL. For objects whose role is not known by the implementor, see %ATK_ROLE_UNKNOWN. (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 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 %ATK_RELATION_DETAILS should be used on the mark to point to that associated section. In addition, the reciprocal relation %ATK_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. This role should include either %ATK_ROLE_CONTENT_DELETION and/or %ATK_ROLE_CONTENT_INSERTION children, in any order, to indicate what the actual change is. (Since: 2.36) A specialized push button to open a menu. (Since: 2.46) not a valid role, used for finding end of the enumeration Get the #AtkRole type corresponding to a rolew name.

the #AtkRole enumerated type corresponding to the specified name, or #ATK_ROLE_INVALID if no matching role is found.

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

Gets the localized description string describing the #AtkRole @role.

the localized string describing the AtkRole

The #AtkRole whose localized name is required

Gets the description string describing the #AtkRole @role.

the string describing the AtkRole

The #AtkRole whose name is required

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

Since 2.12. If your application/toolkit doesn't find a suitable role for a specific object defined at #AtkRole, please submit a bug in order to add a new role to the specification.

an #AtkRole for the new role if added properly. ATK_ROLE_INVALID in case of error.

a character string describing the new role.

Specifies where an object should be placed on the screen when using scroll_to. Scroll the object vertically and horizontally to bring its top left corner to the top left corner of the window. Scroll the object vertically and horizontally to bring its bottom right corner to the bottom right corner of the window. Scroll the object vertically to bring its top edge to the top edge of the window. Scroll the object vertically to bring its bottom edge to the bottom edge of the window. Scroll the object vertically and horizontally to bring its left edge to the left edge of the window. Scroll the object vertically and horizontally to bring its right edge to the right edge of the window. Scroll the object vertically and horizontally so that as much as possible of the object becomes visible. The exact placement is determined by the application. The ATK interface implemented by container objects whose #AtkObject children can be selected. #AtkSelection should be implemented by UI components with children which are exposed by #atk_object_ref_child and #atk_object_get_n_children, if the use of the parent UI component ordinarily involves selection of one or more of the objects corresponding to those #AtkObject children - for example, selectable lists. Note that other types of "selection" (for instance text selection) are accomplished a other ATK interfaces - #AtkSelection is limited to the selection/deselection of children.

Adds the specified accessible child of the object to the object's selection.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the child index.

Clears the selection in the object so that no children in the object are selected.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

Gets the number of accessible children currently selected. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

a gint representing the number of items selected, or 0 if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

Determines if the current child of this object is selected Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

a gboolean representing the specified child is selected, or 0 if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the child index.

Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

an #AtkObject representing the selected accessible, or %NULL if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Removes the specified child of the object from the object's selection.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Causes every child of the object to be selected if the object supports multiple selections.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

Adds the specified accessible child of the object to the object's selection.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the child index.

Clears the selection in the object so that no children in the object are selected.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

a gint representing the number of items selected, or 0 if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

a gboolean representing the specified child is selected, or 0 if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the child index.

an #AtkObject representing the selected accessible, or %NULL if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Removes the specified child of the object from the object's selection.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Causes every child of the object to be selected if the object supports multiple selections.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

The "selection-changed" signal is emitted by an object which implements AtkSelection interface when the selection changes.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface a #gint specifying the child index.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

an #AtkObject representing the selected accessible, or %NULL if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

a gint representing the number of items selected, or 0 if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface

a gboolean representing the specified child is selected, or 0 if @selection does not implement this interface.

a #GObject instance that implements AtkSelectionIface a #gint specifying the child index.

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

TRUE if success, FALSE otherwise.

a #GObject instance that implements AtkSelectionIface

Container for AtkPlug objects from other processes Together with #AtkPlug, #AtkSocket provides the ability to embed accessibles from one process into another in a fashion that is transparent to assistive technologies. #AtkSocket works as the container of #AtkPlug, embedding it using the method atk_socket_embed(). Any accessible contained in the #AtkPlug will appear to the assistive technologies as being inside the application that created the #AtkSocket. The communication between a #AtkSocket and a #AtkPlug is done by the IPC layer of the accessibility framework, normally implemented by the D-Bus based implementation of AT-SPI (at-spi2). If that is the case, at-spi-atk2 is the responsible to implement the abstract methods atk_plug_get_id() and atk_socket_embed(), so an ATK implementor shouldn't reimplement them. The process that contains the #AtkPlug is responsible to send the ID returned by atk_plug_id() to the process that contains the #AtkSocket, so it could call the method atk_socket_embed() in order to embed it. For the same reasons, an implementor doesn't need to implement atk_object_get_n_accessible_children() and atk_object_ref_accessible_child(). All the logic related to those functions will be implemented by the IPC layer. See [class@AtkPlug]

Creates a new #AtkSocket.

the newly created #AtkSocket instance

Embeds the children of an #AtkPlug as the children of the #AtkSocket. The plug may be in the same process or in a different process. The class item used by this function should be filled in by the IPC layer (usually at-spi2-atk). The implementor of the AtkSocket should call this function and pass the id for the plug as returned by atk_plug_get_id(). It is the responsibility of the application to pass the plug id on to the process implementing the #AtkSocket as needed.

an #AtkSocket

the ID of an #AtkPlug

an #AtkSocket

the ID of an #AtkPlug

Determines whether or not the socket has an embedded plug.

TRUE if a plug is embedded in the socket

an #AtkSocket

an #AtkSocket the ID of an #AtkPlug

An AtkStateSet contains the states of an object. An AtkStateSet is a read-only representation of the full set of #AtkStates that apply to an object at a given time. This set is not meant to be modified, but rather created when #atk_object_ref_state_set() is called.

Creates a new empty state set.

a new #AtkStateSet

Adds the state of the specified type to the state set if it is not already present. Note that because an #AtkStateSet is a read-only object, this method should be used to add a state to a newly-created set which will then be returned by #atk_object_ref_state_set. It should not be used to modify the existing state of an object. See also #atk_object_notify_state_change.

%TRUE if the state for @type is not already in @set.

an #AtkStateSet

an #AtkStateType

Adds the states of the specified types to the state set. Note that because an #AtkStateSet is a read-only object, this method should be used to add states to a newly-created set which will then be returned by #atk_object_ref_state_set. It should not be used to modify the existing state of an object. See also #atk_object_notify_state_change.

an #AtkStateSet

an array of #AtkStateType The number of elements in the array

Constructs the intersection of the two sets, returning %NULL if the intersection is empty.

a new #AtkStateSet which is the intersection of the two sets.

an #AtkStateSet

another #AtkStateSet

Removes all states from the state set.

an #AtkStateSet

Checks whether the state for the specified type is in the specified set.

%TRUE if @type is the state type is in @set.

an #AtkStateSet

an #AtkStateType

Checks whether the states for all the specified types are in the specified set.

%TRUE if all the states for @type are in @set.

an #AtkStateSet

an array of #AtkStateType The number of elements in the array

Checks whether the state set is empty, i.e. has no states set.

%TRUE if @set has no states set, otherwise %FALSE

an #AtkStateType

Constructs the union of the two sets.

a new #AtkStateSet which is the union of the two sets, returning %NULL is empty.

an #AtkStateSet

another #AtkStateSet

Removes the state for the specified type from the state set. Note that because an #AtkStateSet is a read-only object, this method should be used to remove a state to a newly-created set which will then be returned by #atk_object_ref_state_set. It should not be used to modify the existing state of an object. See also #atk_object_notify_state_change.

%TRUE if @type was the state type is in @set.

an #AtkStateSet

an #AtkType

Constructs the exclusive-or of the two sets, returning %NULL is empty. The set returned by this operation contains the states in exactly one of the two sets.

a new #AtkStateSet which contains the states which are in exactly one of the two sets.

an #AtkStateSet

another #AtkStateSet

The possible types of states of an object 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. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_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', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code. Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed. Indicates this object is currently checked, for instance a checkbox is 'non-empty'. Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed) Indicates that this object can contain text, and that the user can change the textual contents of this object by editing those contents directly. For an object which is expected to be editable due to its type, but which cannot be edited due to the application or platform preventing the user from doing so, that object's #AtkStateSet should lack ATK_STATE_EDITABLE and should contain ATK_STATE_READ_ONLY. Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE Indicates this object allows progressive disclosure of its children Indicates this object its expanded - see ATK_STATE_EXPANDABLE above 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 the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful. 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. Indicates this object is currently pressed. Indicates the size of this object 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. STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, but may be found in the absence of STATE_ENABLED if the current visible state of the control is "disconnected" from the application state. In such cases, direct user interaction can often result in the object gaining STATE_SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. @see STATE_ENABLED, STATE_INDETERMINATE. 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 is implied if the object has STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that the index associated with this object has changed since the user accessed the object (in lieu of "index-in-parent-changed" events). Indicates this object is transient, i.e. a snapshot which may not emit events when its state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no notification given when the cached data becomes obsolete. Indicates the orientation of this object is vertical Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. **note**: %ATK_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 %ATK_STATE_VISIBLE and %ATK_STATE_SHOWING. The absence of %ATK_STATE_VISIBLE and %ATK_STATE_SHOWING is semantically equivalent to saying that an object is 'hidden'. See also %ATK_STATE_TRUNCATED, which applies if an object with %ATK_STATE_VISIBLE and %ATK_STATE_SHOWING set lies within a viewport which means that its contents are clipped, e.g. a truncated spreadsheet cell or an image within a scrolling viewport. Mostly useful for screen-review and magnification algorithms. Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e. are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. that the children should not, and need not, be enumerated by the client. Objects implementing this state are expected to provide relevant state notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children. Indicates that the value, or some other quantifiable property, of this AtkObject cannot be fully determined. In the case of a large data set in which the total number of items in that set is unknown (e.g. 1 of 999+), implementors should expose the currently-known set size (999) along with this state. In the case of a check box, this state should be used to indicate that the check box is a tri-state check box which is currently neither checked nor unchecked. Indicates that an object is truncated, e.g. a text value in a speradsheet cell. Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface. Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. Indicates that the object in question implements some form of ¨typeahead¨ or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become selected. Subsequent character input may narrow the selection further as long as one or more sub-elements match the string. This state is normally only useful and encountered on objects that implement Selection. In some cases the typeahead behavior may result in full or partial ¨completion¨ of the data in the input field, in which case these input events may trigger text-changed events from the AtkText interface. This state supplants @ATK_ROLE_AUTOCOMPLETE. Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from @ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations. Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button. Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. **note**: some applications, notably content viewers, may not be able to detect all kinds of animated content. Therefore the absence of this state should not be taken as definitive evidence that the object's visual representation is static; this state is advisory. Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited". Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell. @Since: ATK-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: ATK-2.12 Indicates this object has a tooltip. @Since: ATK-2.16 Indicates that a widget which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user. Note that this state should only be applied to widget types whose value is normally directly user modifiable, such as check boxes, radio buttons, spin buttons, text input fields, and combo boxes, as a means to convey that the expected interaction with that widget is not possible. When the expected interaction with a widget does not include modification by the user, as is the case with labels and containers, ATK_STATE_READ_ONLY should not be applied. See also ATK_STATE_EDITABLE. @Since: ATK-2-16 Indicates this object is collapsed. @Since: ATK-2.38 Not a valid state, used for finding end of enumeration Gets the #AtkStateType corresponding to the description string @name.

an #AtkStateType corresponding to @name

a character string state name

Gets the description string describing the #AtkStateType @type.

the string describing the AtkStateType

The #AtkStateType whose name is required

an #AtkState value for the new state.

a character string describing the new state.

The ATK interface which provides access to streamable content. An interface whereby an object allows its backing content to be streamed to clients. Typical implementors would be images or icons, HTML content, or multimedia display/rendering widgets. Negotiation of content type is allowed. Clients may examine the backing data and transform, convert, or parse the content in order to present it in an alternate form to end-users. The AtkStreamableContent interface is particularly useful for saving, printing, or post-processing entire documents, or for persisting alternate views of a document. If document content itself is being serialized, stored, or converted, then use of the AtkStreamableContent interface can help address performance issues. Unlike most ATK interfaces, this interface is not strongly tied to the current user-agent view of the a particular document, but may in some cases give access to the underlying model data.

Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on.

a gchar* representing the specified mime type; the caller should not free the character string.

a GObject instance that implements AtkStreamableContent

a gint representing the position of the mime type starting from 0

Gets the number of mime types supported by this object.

a gint which is the number of mime types supported by the object.

a GObject instance that implements AtkStreamableContentIface

Gets the content in the specified mime type.

A #GIOChannel which contains the content in the specified mime type.

a GObject instance that implements AtkStreamableContentIface

a gchar* representing the mime type

Get a string representing a URI in IETF standard format (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content may be streamed in the specified mime-type, if one is available. If mime_type is NULL, the URI for the default (and possibly only) mime-type is returned. Note that it is possible for get_uri to return NULL but for get_stream to work nonetheless, since not all GIOChannels connect to URIs.

Returns a string representing a URI, or %NULL if no corresponding URI can be constructed.

a GObject instance that implements AtkStreamableContentIface

a gchar* representing the mime type, or NULL to request a URI for the default mime type.

Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on.

a gchar* representing the specified mime type; the caller should not free the character string.

a GObject instance that implements AtkStreamableContent

a gint representing the position of the mime type starting from 0

Gets the number of mime types supported by this object.

a gint which is the number of mime types supported by the object.

a GObject instance that implements AtkStreamableContentIface

Gets the content in the specified mime type.

A #GIOChannel which contains the content in the specified mime type.

a GObject instance that implements AtkStreamableContentIface

a gchar* representing the mime type

Returns a string representing a URI, or %NULL if no corresponding URI can be constructed.

a GObject instance that implements AtkStreamableContentIface

a gchar* representing the mime type, or NULL to request a URI for the default mime type.

a gint which is the number of mime types supported by the object.

a GObject instance that implements AtkStreamableContentIface

a gchar* representing the specified mime type; the caller should not free the character string.

a GObject instance that implements AtkStreamableContent a gint representing the position of the mime type starting from 0

A #GIOChannel which contains the content in the specified mime type.

a GObject instance that implements AtkStreamableContentIface a gchar* representing the mime type

Returns a string representing a URI, or %NULL if no corresponding URI can be constructed.

a GObject instance that implements AtkStreamableContentIface a gchar* representing the mime type, or NULL to request a URI for the default mime type.

The ATK interface implemented for UI components which contain tabular or row/column information. #AtkTable should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an #AtkTable are typically referred to as "cells". Those cells should implement the interface #AtkTableCell, but #Atk doesn't require them to be direct children of the current #AtkTable. They can be grand-children, grand-grand-children etc. #AtkTable provides the API needed to get a individual cell based on the row and column numbers. Children of #AtkTable are frequently "lightweight" objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient. Since tables are often very complex, #AtkTable includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are #AtkObjects which may implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate. #AtkTable summaries may themselves be (simplified) #AtkTables, etc. Note for implementors: in the past, #AtkTable required that all the cells should be direct children of #AtkTable, and provided some index based methods to request the cells. The practice showed that that forcing made #AtkTable implementation complex, and hard to expose other kind of children, like rows or captions. Right now, index-based methods are deprecated.

Adds the specified @column to the selection.

a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Adds the specified @row to the selection.

a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Gets the caption for the @table.

a AtkObject* representing the table caption, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableInterface

Gets a #gint representing the column at the specified @index_.

Since 2.12.

a gint representing the column at the specified index, or -1 if the table does not implement this method.

a GObject instance that implements AtkTableInterface

a #gint representing an index in @table

Gets the description text of the specified @column in the table

a gchar* representing the column description, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Gets the number of columns occupied by the accessible object at the specified @row and @column in the @table.

a gint representing the column extent at specified position, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Gets the column header of a specified column in an accessible table.

a AtkObject* representing the specified column header, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in the table

Gets a #gint representing the index at the specified @row and @column.

Since 2.12. Use atk_table_ref_at() in order to get the accessible that represents the cell at (@row, @column)

a #gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Gets the number of columns in the table.

a gint representing the number of columns, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

Gets the number of rows in the table.

a gint representing the number of rows, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

Gets a #gint representing the row at the specified @index_.

since 2.12.

a gint representing the row at the specified index, or -1 if the table does not implement this method.

a GObject instance that implements AtkTableInterface

a #gint representing an index in @table

Gets the description text of the specified row in the table

a gchar* representing the row description, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Gets the number of rows occupied by the accessible object at a specified @row and @column in the @table.

a gint representing the row extent at specified position, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Gets the row header of a specified row in an accessible table.

a AtkObject* representing the specified row header, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in the table

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

a gint representing the number of selected columns, or %0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint** that is to contain the selected columns numbers

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

a gint representing the number of selected rows, or zero if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint** that is to contain the selected row numbers

Gets the summary description of the table.

a AtkObject* representing a summary description of the table, or zero if value does not implement this interface.

a GObject instance that implements AtkTableIface

Gets a boolean value indicating whether the specified @column is selected

a gboolean representing if the column is selected, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Gets a boolean value indicating whether the specified @row is selected

a gboolean representing if the row is selected, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Gets a boolean value indicating whether the accessible object at the specified @row and @column is selected

a gboolean representing if the cell is selected, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Get a reference to the table cell at @row, @column. This cell should implement the interface #AtkTableCell

an #AtkObject representing the referred to accessible

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Adds the specified @column to the selection.

a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Removes the specified @row from the selection.

a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Sets the caption for the table.

a GObject instance that implements AtkTableIface

a #AtkObject representing the caption to set for @table

Sets the description text for the specified @column of the @table.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table a #gchar representing the description text to set for the specified @column of the @table

Sets the specified column header to @header.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table an #AtkTable

Sets the description text for the specified @row of @table.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gchar representing the description text to set for the specified @row of @table

Sets the specified row header to @header.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table an #AtkTable

Sets the summary description of the table.

a GObject instance that implements AtkTableIface

an #AtkObject representing the summary description to set for @table

Adds the specified @column to the selection.

a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Adds the specified @row to the selection.

a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Gets the caption for the @table.

a AtkObject* representing the table caption, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableInterface

Gets a #gint representing the column at the specified @index_.

Since 2.12.

a gint representing the column at the specified index, or -1 if the table does not implement this method.

a GObject instance that implements AtkTableInterface

a #gint representing an index in @table

Gets the description text of the specified @column in the table

a gchar* representing the column description, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Gets the number of columns occupied by the accessible object at the specified @row and @column in the @table.

a gint representing the column extent at specified position, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Gets the column header of a specified column in an accessible table.

a AtkObject* representing the specified column header, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in the table

Gets a #gint representing the index at the specified @row and @column.

Since 2.12. Use atk_table_ref_at() in order to get the accessible that represents the cell at (@row, @column)

a #gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Gets the number of columns in the table.

a gint representing the number of columns, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

Gets the number of rows in the table.

a gint representing the number of rows, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

Gets a #gint representing the row at the specified @index_.

since 2.12.

a gint representing the row at the specified index, or -1 if the table does not implement this method.

a GObject instance that implements AtkTableInterface

a #gint representing an index in @table

Gets the description text of the specified row in the table

a gchar* representing the row description, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Gets the number of rows occupied by the accessible object at a specified @row and @column in the @table.

a gint representing the row extent at specified position, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Gets the row header of a specified row in an accessible table.

a AtkObject* representing the specified row header, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in the table

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

a gint representing the number of selected columns, or %0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint** that is to contain the selected columns numbers

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

a gint representing the number of selected rows, or zero if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint** that is to contain the selected row numbers

Gets the summary description of the table.

a AtkObject* representing a summary description of the table, or zero if value does not implement this interface.

a GObject instance that implements AtkTableIface

Gets a boolean value indicating whether the specified @column is selected

a gboolean representing if the column is selected, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Gets a boolean value indicating whether the specified @row is selected

a gboolean representing if the row is selected, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Gets a boolean value indicating whether the accessible object at the specified @row and @column is selected

a gboolean representing if the cell is selected, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Get a reference to the table cell at @row, @column. This cell should implement the interface #AtkTableCell

an #AtkObject representing the referred to accessible

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gint representing a column in @table

Adds the specified @column to the selection.

a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table

Removes the specified @row from the selection.

a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table

Sets the caption for the table.

a GObject instance that implements AtkTableIface

a #AtkObject representing the caption to set for @table

Sets the description text for the specified @column of the @table.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table a #gchar representing the description text to set for the specified @column of the @table

Sets the specified column header to @header.

a GObject instance that implements AtkTableIface

a #gint representing a column in @table an #AtkTable

Sets the description text for the specified @row of @table.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table a #gchar representing the description text to set for the specified @row of @table

Sets the specified row header to @header.

a GObject instance that implements AtkTableIface

a #gint representing a row in @table an #AtkTable

Sets the summary description of the table.

a GObject instance that implements AtkTableIface

an #AtkObject representing the summary description to set for @table

The "column-deleted" signal is emitted by an object which implements the AtkTable interface when a column is deleted.

The index of the first column deleted. The number of columns deleted. The "column-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.

The index of the column inserted. The number of colums inserted. The "column-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.

The "model-changed" signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes.

The "row-deleted" signal is emitted by an object which implements the AtkTable interface when a row is deleted.

The index of the first row deleted. The number of rows deleted. The "row-inserted" signal is emitted by an object which implements the AtkTable interface when a row is inserted.

The index of the first row inserted. The number of rows inserted. The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the rows are reordered.

The ATK interface implemented for a cell inside a two-dimentional #AtkTable Being #AtkTable a component which present elements ordered via rows and columns, an #AtkTableCell is the interface which each of those elements, so "cells" should implement. See [iface@AtkTable]

Returns the column headers as an array of cell accessibles.

a GPtrArray of AtkObjects representing the column header cells.

a GObject instance that implements AtkTableCellIface

Returns the number of columns occupied by this cell accessible.

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 AtkTableCellIface

Retrieves the tabular position of this cell.

TRUE if successful; FALSE otherwise.

a GObject instance that implements AtkTableCellIface

the row of the given cell. the column of the given cell.

Gets the row and column indexes and span of this cell accessible. Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object.

TRUE if successful; FALSE otherwise.

a GObject instance that implements AtkTableCellIface

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 AtkObjects representing the row header cells.

a GObject instance that implements AtkTableCellIface

Returns the number of rows occupied by this cell accessible.

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 AtkTableCellIface

Returns a reference to the accessible of the containing table.

the atk object for the containing table.

a GObject instance that implements AtkTableCellIface

Returns the column headers as an array of cell accessibles.

a GPtrArray of AtkObjects representing the column header cells.

a GObject instance that implements AtkTableCellIface

Returns the number of columns occupied by this cell accessible.

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 AtkTableCellIface

Retrieves the tabular position of this cell.

TRUE if successful; FALSE otherwise.

a GObject instance that implements AtkTableCellIface

the row of the given cell. the column of the given cell.

TRUE if successful; FALSE otherwise.

a GObject instance that implements AtkTableCellIface

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 AtkObjects representing the row header cells.

a GObject instance that implements AtkTableCellIface

Returns the number of rows occupied by this cell accessible.

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 AtkTableCellIface

Returns a reference to the accessible of the containing table.

the atk object for the containing table.

a GObject instance that implements AtkTableCellIface

AtkTableCell is an interface for cells inside an #AtkTable.

virtual function that returns the number of columns occupied by this cell accessible

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 AtkTableCellIface

virtual function that returns the column headers as an array of cell accessibles

a GPtrArray of AtkObjects representing the column header cells.

a GObject instance that implements AtkTableCellIface

virtual function that retrieves the tabular position of this cell

TRUE if successful; FALSE otherwise.

a GObject instance that implements AtkTableCellIface the row of the given cell. the column of the given cell.

virtual function that returns the number of rows occupied by this cell

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 AtkTableCellIface

virtual function that returns the row headers as an array of cell accessibles

a GPtrArray of AtkObjects representing the row header cells.

a GObject instance that implements AtkTableCellIface

virtual function that get the row an column indexes and span of this cell

TRUE if successful; FALSE otherwise.

a GObject instance that implements AtkTableCellIface 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.

virtual function that returns a reference to the accessible of the containing table

the atk object for the containing table.

a GObject instance that implements AtkTableCellIface

an #AtkObject representing the referred to accessible

a GObject instance that implements AtkTableIface a #gint representing a row in @table a #gint representing a column in @table

a #gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a row in @table a #gint representing a column in @table

a gint representing the column at the specified index, or -1 if the table does not implement this method.

a GObject instance that implements AtkTableInterface a #gint representing an index in @table

a gint representing the row at the specified index, or -1 if the table does not implement this method.

a GObject instance that implements AtkTableInterface a #gint representing an index in @table

a gint representing the number of columns, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a gint representing the number of rows, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface

a gint representing the column extent at specified position, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a row in @table a #gint representing a column in @table

a gint representing the row extent at specified position, or 0 if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a row in @table a #gint representing a column in @table

a AtkObject* representing the table caption, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableInterface

a gchar* representing the column description, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a column in @table

a AtkObject* representing the specified column header, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a column in the table

a gchar* representing the row description, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a row in @table

a AtkObject* representing the specified row header, or %NULL if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint representing a row in the table

a AtkObject* representing a summary description of the table, or zero if value does not implement this interface.

a GObject instance that implements AtkTableIface

a GObject instance that implements AtkTableIface a #AtkObject representing the caption to set for @table

a GObject instance that implements AtkTableIface a #gint representing a column in @table a #gchar representing the description text to set for the specified @column of the @table

a GObject instance that implements AtkTableIface a #gint representing a column in @table an #AtkTable

a GObject instance that implements AtkTableIface a #gint representing a row in @table a #gchar representing the description text to set for the specified @row of @table

a GObject instance that implements AtkTableIface a #gint representing a row in @table an #AtkTable

a GObject instance that implements AtkTableIface an #AtkObject representing the summary description to set for @table

a gint representing the number of selected columns, or %0 if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint** that is to contain the selected columns numbers

a gint representing the number of selected rows, or zero if value does not implement this interface.

a GObject instance that implements AtkTableIface a #gint** that is to contain the selected row numbers