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() #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 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 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) #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 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 The 'bounds-changed" signal is emitted when the bposition 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. 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 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 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 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 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 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. 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 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 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 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. 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. a string indicating the document type a #GObject instance that implements AtkDocumentIface a %gpointer that points to an instance of the DOM. a #GObject instance that implements AtkDocumentIface 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 An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole. a #GObject instance that implements AtkDocumentIface 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. %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. the current page number inside @document, or -1 if not implemented, not know by the implementor, or irrelevant. the #AtkDocument total page count of @document, or -1 if not implemented, not know by the implementor or irrelevant. the #AtkDocument #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 also: #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 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 %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 start position end position 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 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 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. 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 (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 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 Indicates whether the link currently displays some or all of its content inline. Ordinary HTML links will usually return %FALSE, but an inline &lt;src&gt; 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 AtkHyperlinkImpl allows AtkObjects to refer to their associated AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas AtkHyperlink is a object type. The AtkHyperlinkImpl interface allows a client to query an AtkObject for the availability of an associated AtkHyperlink instance, and obtain that instance. It is thus particularly useful in cases where embedded content or inline content within a text object is present, since the embedding text object implements AtkHypertext and the inline/embedded objects are exposed as children which implement AtkHyperlinkImpl, in addition to their being obtainable via AtkHypertext:getLink followed by AtkHyperlink:getObject. The AtkHyperlinkImpl interface should be supported by objects exposed within the hierarchy as children of an AtkHypertext container which correspond to "links" or embedded content within the text. HTML anchors are not, for instance, normally exposed this way, but embedded images and components which appear inline in the content of a text object are. The AtkHyperlinkIface interface allows a means of determining which children are hyperlinks in this sense of the word, and for obtaining their corresponding AtkHyperlink object, from which the embedding range, URI, etc. can be obtained. To some extent this interface exists because, for historical reasons, AtkHyperlink was defined as an object type, not an interface. Thus, in order to interact with AtkObjects via AtkHyperlink semantics, a new interface was required. 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 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. #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 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 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 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. 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 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. 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. Usage of AtkMisc is deprecated since 2.12 and heavily discouraged. an AtkMisc instance for this application. an AtkMisc instance for this application. 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. 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 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 also: #AtkObjectFactory, #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 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 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 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 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. 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 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 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 signal "children-changed" is emitted when a child is added or removed form 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 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 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 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 #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. a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of @accessible. an #AtkObject 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 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 an #AtkObjectFactory to invalidate See #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 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. #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. 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 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 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) 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. #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 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 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 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. 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 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 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 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 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 Register a new object state. an #AtkState value for the new state. a character string describing the new state. 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 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. 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. #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. 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 also #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. 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 AtkTableCell is an interface for cells inside an #AtkTable. 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 a GPtrArray of AtkObjects representing the column header cells. a GObject instance that implements AtkTableCellIface TRUE if successful; FALSE otherwise. a GObject instance that implements AtkTableCellIface the row of the given cell. the column of the given 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 a GPtrArray of AtkObjects representing the row header cells. a GObject instance that implements AtkTableCellIface 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. 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 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 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 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 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 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 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 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 #AtkText should be implemented by #AtkObjects on behalf of widgets that have text content which is either attributed or otherwise non-trivial. #AtkObjects whose text content is simple, unattributed, and very brief may expose that content via #atk_object_get_name instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, the #AtkText interface should be used to expose the text content. In the case of editable text content, #AtkEditableText (a subtype of the #AtkText interface) should be implemented instead. #AtkText provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures. Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated. A pointer to an array of #AtkTextRange which is to be freed. Adds a selection bounded by the specified offsets. %TRUE if successful, %FALSE otherwise an #AtkText the starting character offset of the selected region the offset of the first character after the selected region. Get the ranges of text in the specified bounding box. Array of AtkTextRange. The last element of the array returned by this function will be NULL. an #AtkText An AtkTextRectangle giving the dimensions of the bounding box. Specify whether coordinates are relative to the screen or widget window. Specify the horizontal clip type. Specify the vertical clip type. Gets the offset of the position of the caret (cursor). the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. an #AtkText Gets the specified text. the character at @offset or 0 in the case of failure. an #AtkText a character offset within @text Gets the character count. the number of characters or -1 in case of failure. an #AtkText If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1. Get the bounding box containing the glyph representing the character at a particular text offset. an #AtkText The offset of the text character for which bounding information is required. Pointer for the x coordinate of the bounding box Pointer for the y coordinate of the bounding box Pointer for the width of the bounding box Pointer for the height of the bounding box specify whether coordinates are relative to the screen or widget window Creates an #AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. an #AtkAttributeSet which contains the default text attributes for this #AtkText. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). an #AtkText Gets the number of selected regions. The number of selected regions, or -1 in the case of failure. an #AtkText Gets the offset of the character located at coordinates @x and @y. @x and @y are interpreted as being relative to the screen or this widget's window depending on @coords. the offset to the character which is located at the specified @x and @y coordinates of -1 in case of failure. an #AtkText screen x-position of character screen y-position of character specify whether coordinates are relative to the screen or widget window Get the bounding box for text within the specified range. If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1. an #AtkText The offset of the first text character for which boundary information is required. The offset of the text character after the last character for which boundary information is required. Specify whether coordinates are relative to the screen or widget window. A pointer to a AtkTextRectangle which is filled in by this function. Creates an #AtkAttributeSet which consists of the attributes explicitly set at the position @offset in the text. @start_offset and @end_offset are set to the start and end of the range around @offset where the attributes are invariant. Note that @end_offset is the offset of the first character after the range. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. an #AtkAttributeSet which contains the attributes explicitly set at @offset. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). an #AtkText the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. the address to put the start offset of the range the address to put the end offset of the range Gets the text from the specified selection. a newly allocated string containing the selected text. Use g_free() to free the returned string. an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. passes back the starting character offset of the selected region passes back the ending character offset (offset immediately past) of the selected region Gets a portion of the text exposed through an #AtkText according to a given @offset and a specific @granularity, along with the start and end offsets defining the boundaries of such a portion of text. If @granularity is ATK_TEXT_GRANULARITY_CHAR the character at the offset is returned. If @granularity is ATK_TEXT_GRANULARITY_WORD the returned string is from the word start at or before the offset to the word start after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word. If @granularity is ATK_TEXT_GRANULARITY_SENTENCE the returned string is from the sentence start at or before the offset to the sentence start after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence. If @granularity is ATK_TEXT_GRANULARITY_LINE the returned string is from the line start at or before the offset to the line start after the offset. If @granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. an #AtkText position An #AtkTextGranularity the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) Gets the specified text. a newly allocated string containing the text from @start_offset up to, but not including @end_offset. Use g_free() to free the returned string. an #AtkText a starting character offset within @text an ending character offset within @text, or -1 for the end of the string. Gets the specified text. Please use atk_text_get_string_at_offset() instead. a newly allocated string containing the text after @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start at or before the offset to the word start after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word. If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start at or before the offset to the sentence start after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence. If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset. This method is deprecated since ATK version 2.9.4. Please use atk_text_get_string_at_offset() instead. a newly allocated string containing the text at @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring Gets the specified text. Please use atk_text_get_string_at_offset() instead. a newly allocated string containing the text before @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring Removes the specified selection. %TRUE if successful, %FALSE otherwise an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. Makes a substring of @text visible on the screen by scrolling all necessary parents. whether scrolling was successful. an #AtkText start offset in the @text end offset in the @text, or -1 for the end of the text. specify where the object should be made visible. Move the top-left of a substring of @text to a given position of the screen by scrolling all necessary parents. whether scrolling was successful. an #AtkText start offset in the @text end offset in the @text, or -1 for the end of the text. 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 caret (cursor) position to the specified @offset. %TRUE if successful, %FALSE otherwise. an #AtkText the character offset of the new caret position Changes the start and end offset of the specified selection. %TRUE if successful, %FALSE otherwise an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. the new starting character offset of the selection the new end position of (e.g. offset immediately past) the selection Adds a selection bounded by the specified offsets. %TRUE if successful, %FALSE otherwise an #AtkText the starting character offset of the selected region the offset of the first character after the selected region. Get the ranges of text in the specified bounding box. Array of AtkTextRange. The last element of the array returned by this function will be NULL. an #AtkText An AtkTextRectangle giving the dimensions of the bounding box. Specify whether coordinates are relative to the screen or widget window. Specify the horizontal clip type. Specify the vertical clip type. Gets the offset of the position of the caret (cursor). the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. an #AtkText Gets the specified text. the character at @offset or 0 in the case of failure. an #AtkText a character offset within @text Gets the character count. the number of characters or -1 in case of failure. an #AtkText If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1. Get the bounding box containing the glyph representing the character at a particular text offset. an #AtkText The offset of the text character for which bounding information is required. Pointer for the x coordinate of the bounding box Pointer for the y coordinate of the bounding box Pointer for the width of the bounding box Pointer for the height of the bounding box specify whether coordinates are relative to the screen or widget window Creates an #AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. an #AtkAttributeSet which contains the default text attributes for this #AtkText. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). an #AtkText Gets the number of selected regions. The number of selected regions, or -1 in the case of failure. an #AtkText Gets the offset of the character located at coordinates @x and @y. @x and @y are interpreted as being relative to the screen or this widget's window depending on @coords. the offset to the character which is located at the specified @x and @y coordinates of -1 in case of failure. an #AtkText screen x-position of character screen y-position of character specify whether coordinates are relative to the screen or widget window Get the bounding box for text within the specified range. If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1. an #AtkText The offset of the first text character for which boundary information is required. The offset of the text character after the last character for which boundary information is required. Specify whether coordinates are relative to the screen or widget window. A pointer to a AtkTextRectangle which is filled in by this function. Creates an #AtkAttributeSet which consists of the attributes explicitly set at the position @offset in the text. @start_offset and @end_offset are set to the start and end of the range around @offset where the attributes are invariant. Note that @end_offset is the offset of the first character after the range. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. an #AtkAttributeSet which contains the attributes explicitly set at @offset. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). an #AtkText the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. the address to put the start offset of the range the address to put the end offset of the range Gets the text from the specified selection. a newly allocated string containing the selected text. Use g_free() to free the returned string. an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. passes back the starting character offset of the selected region passes back the ending character offset (offset immediately past) of the selected region Gets a portion of the text exposed through an #AtkText according to a given @offset and a specific @granularity, along with the start and end offsets defining the boundaries of such a portion of text. If @granularity is ATK_TEXT_GRANULARITY_CHAR the character at the offset is returned. If @granularity is ATK_TEXT_GRANULARITY_WORD the returned string is from the word start at or before the offset to the word start after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word. If @granularity is ATK_TEXT_GRANULARITY_SENTENCE the returned string is from the sentence start at or before the offset to the sentence start after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence. If @granularity is ATK_TEXT_GRANULARITY_LINE the returned string is from the line start at or before the offset to the line start after the offset. If @granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. an #AtkText position An #AtkTextGranularity the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) Gets the specified text. a newly allocated string containing the text from @start_offset up to, but not including @end_offset. Use g_free() to free the returned string. an #AtkText a starting character offset within @text an ending character offset within @text, or -1 for the end of the string. Gets the specified text. Please use atk_text_get_string_at_offset() instead. a newly allocated string containing the text after @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start at or before the offset to the word start after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word. If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start at or before the offset to the sentence start after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence. If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset. This method is deprecated since ATK version 2.9.4. Please use atk_text_get_string_at_offset() instead. a newly allocated string containing the text at @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring Gets the specified text. Please use atk_text_get_string_at_offset() instead. a newly allocated string containing the text before @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring Removes the specified selection. %TRUE if successful, %FALSE otherwise an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. Makes a substring of @text visible on the screen by scrolling all necessary parents. whether scrolling was successful. an #AtkText start offset in the @text end offset in the @text, or -1 for the end of the text. specify where the object should be made visible. Move the top-left of a substring of @text to a given position of the screen by scrolling all necessary parents. whether scrolling was successful. an #AtkText start offset in the @text end offset in the @text, or -1 for the end of the text. 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 caret (cursor) position to the specified @offset. %TRUE if successful, %FALSE otherwise. an #AtkText the character offset of the new caret position Changes the start and end offset of the specified selection. %TRUE if successful, %FALSE otherwise an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. the new starting character offset of the selection the new end position of (e.g. offset immediately past) the selection The "text-attributes-changed" signal is emitted when the text attributes of the text of an object which implements AtkText changes. The "text-caret-moved" signal is emitted when the caret position of the text of an object which implements AtkText changes. The new position of the text caret. The "text-changed" signal is emitted when the text of the object which implements the AtkText interface changes, This signal will have a detail which is either "insert" or "delete" which identifies whether the text change was an insertion or a deletion. Use #AtkObject::text-insert or #AtkObject::text-remove instead. The position (character offset) of the insertion or deletion. The length (in characters) of text inserted or deleted. The "text-insert" signal is emitted when a new text is inserted. If the signal was not triggered by the user (e.g. typing or pasting text), the "system" detail should be included. The position (character offset) of the insertion. The length (in characters) of text inserted. The new text inserted The "text-remove" signal is emitted when a new text is removed. If the signal was not triggered by the user (e.g. typing or pasting text), the "system" detail should be included. The position (character offset) of the removal. The length (in characters) of text removed. The old text removed The "text-selection-changed" signal is emitted when the selected text of an object which implements AtkText changes. Describes the text attributes supported Invalid attribute, like bad spelling or grammar. The pixel width of the left margin The pixel width of the right margin The number of pixels that the text is indented Either "true" or "false" indicating whether text is visible or not Either "true" or "false" indicating whether text is editable or not Pixels of blank space to leave above each newline-terminated line. Pixels of blank space to leave below each newline-terminated line. Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. Number of pixels that the characters are risen above the baseline "none", "single", "double", "low", or "error" "true" or "false" whether the text is strikethrough The size of the characters in points. eg: 10 The scale of the characters. The value is a string representation of a double The weight of the characters. The language used The font family name The background color. The value is an RGB value of the format "%u,%u,%u" The foreground color. The value is an RGB value of the format "%u,%u,%u" "true" if a #GdkBitmap is set for stippling the background color. "true" if a #GdkBitmap is set for stippling the foreground color. The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char". The direction of the text, if set. Values are "none", "ltr" or "rtl" The justification of the text, if set. Values are "left", "right", "center" or "fill" The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded" The capitalization variant of the text, if set. Values are "normal" or "small_caps" The slant style of the text, if set. Values are "normal", "oblique" or "italic" not a valid text attribute, used for finding end of enumeration Get the #AtkTextAttribute type corresponding to a text attribute name. the #AtkTextAttribute enumerated type corresponding to the specified name, or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found. a string which is the (non-localized) name of an ATK text attribute. Gets the name corresponding to the #AtkTextAttribute a string containing the name; this string should not be freed The #AtkTextAttribute whose name is required Gets the value for the index of the #AtkTextAttribute a string containing the value; this string should not be freed; %NULL is returned if there are no values maintained for the attr value. The #AtkTextAttribute for which a value is required The index of the required value Associate @name with a new #AtkTextAttribute an #AtkTextAttribute associated with @name a name string Text boundary types used for specifying boundaries for regions of text. This enumeration is deprecated since 2.9.4 and should not be used. Use AtkTextGranularity with #atk_text_get_string_at_offset instead. Boundary is the boundary between characters (including non-printing characters) Boundary is the start (i.e. first character) of a word. Boundary is the end (i.e. last character) of a word. Boundary is the first character in a sentence. Boundary is the last (terminal) character in a sentence; in languages which use "sentence stop" punctuation such as English, the boundary is thus the '.', '?', or similar terminal punctuation character. Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character. Boundary is the linefeed, or return character. Describes the type of clipping required. No clipping to be done Text clipped by min coordinate is omitted Text clipped by max coordinate is omitted Only text fully within mix/max bound is retained Text granularity types used for specifying the granularity of the region of text we are interested in. Granularity is defined by the boundaries between characters (including non-printing characters) Granularity is defined by the boundaries of a word, starting at the beginning of the current word and finishing at the beginning of the following one, if present. Granularity is defined by the boundaries of a sentence, starting at the beginning of the current sentence and finishing at the beginning of the following one, if present. Granularity is defined by the boundaries of a line, starting at the beginning of the current line and finishing at the beginning of the following one, if present. Granularity is defined by the boundaries of a paragraph, starting at the beginning of the current paragraph and finishing at the beginning of the following one, if present. a newly allocated string containing the text from @start_offset up to, but not including @end_offset. Use g_free() to free the returned string. an #AtkText a starting character offset within @text an ending character offset within @text, or -1 for the end of the string. a newly allocated string containing the text after @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring a newly allocated string containing the text at @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring the character at @offset or 0 in the case of failure. an #AtkText a character offset within @text a newly allocated string containing the text before @offset bounded by the specified @boundary_type. Use g_free() to free the returned string. an #AtkText position An #AtkTextBoundary the starting character offset of the returned string the offset of the first character after the returned substring the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. an #AtkText an #AtkAttributeSet which contains the attributes explicitly set at @offset. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). an #AtkText the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. the address to put the start offset of the range the address to put the end offset of the range an #AtkAttributeSet which contains the default text attributes for this #AtkText. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free(). an #AtkText an #AtkText The offset of the text character for which bounding information is required. Pointer for the x coordinate of the bounding box Pointer for the y coordinate of the bounding box Pointer for the width of the bounding box Pointer for the height of the bounding box specify whether coordinates are relative to the screen or widget window the number of characters or -1 in case of failure. an #AtkText the offset to the character which is located at the specified @x and @y coordinates of -1 in case of failure. an #AtkText screen x-position of character screen y-position of character specify whether coordinates are relative to the screen or widget window The number of selected regions, or -1 in the case of failure. an #AtkText a newly allocated string containing the selected text. Use g_free() to free the returned string. an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. passes back the starting character offset of the selected region passes back the ending character offset (offset immediately past) of the selected region %TRUE if successful, %FALSE otherwise an #AtkText the starting character offset of the selected region the offset of the first character after the selected region. %TRUE if successful, %FALSE otherwise an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. %TRUE if successful, %FALSE otherwise an #AtkText The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. the new starting character offset of the selection the new end position of (e.g. offset immediately past) the selection %TRUE if successful, %FALSE otherwise. an #AtkText the character offset of the new caret position an #AtkText The offset of the first text character for which boundary information is required. The offset of the text character after the last character for which boundary information is required. Specify whether coordinates are relative to the screen or widget window. A pointer to a AtkTextRectangle which is filled in by this function. Array of AtkTextRange. The last element of the array returned by this function will be NULL. an #AtkText An AtkTextRectangle giving the dimensions of the bounding box. Specify whether coordinates are relative to the screen or widget window. Specify the horizontal clip type. Specify the vertical clip type. a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. an #AtkText position An #AtkTextGranularity the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) whether scrolling was successful. an #AtkText start offset in the @text end offset in the @text, or -1 for the end of the text. specify where the object should be made visible. whether scrolling was successful. an #AtkText start offset in the @text end offset in the @text, or -1 for the end of the text. 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 A structure used to describe a text range. A rectangle giving the bounds of the text range The start offset of a AtkTextRange The end offset of a AtkTextRange The text in the text range A structure used to store a rectangle used by AtkText. The horizontal coordinate of a rectangle The vertical coordinate of a rectangle The width of a rectangle The height of a rectangle A set of ATK utility functions which are used to support event registration of various types, and obtaining the 'root' accessible of a process and information about the current ATK implementation and toolkit version. A macro that should be defined by the user prior to including the atk/atk.h header. The definition should be one of the predefined ATK version macros: %ATK_VERSION_2_12, %ATK_VERSION_2_14,... This macro defines the earliest version of ATK that the package is required to be able to compile against. If the compiler is configured to warn about the use of deprecated functions, then using functions that were deprecated in version %ATK_VERSION_MIN_REQUIRED or earlier will cause warnings (but using functions deprecated in later releases will not). #AtkValue should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have #AtkObject representations which implement #AtkValue on the component's behalf. #AtKValues may be read-only, in which case attempts to alter the value return would fail. <refsect1 id="current-value-text"> <title>On the subject of current value text</title> <para> In addition to providing the current value, implementors can optionally provide an end-user-consumable textual description associated with this value. This description should be included when the numeric value fails to convey the full, on-screen representation seen by users. </para> <example> <title>Password strength</title> A password strength meter whose value changes as the user types their new password. Red is used for values less than 4.0, yellow for values between 4.0 and 7.0, and green for values greater than 7.0. In this instance, value text should be provided by the implementor. Appropriate value text would be "weak", "acceptable," and "strong" respectively. </example> A level bar whose value changes to reflect the battery charge. The color remains the same regardless of the charge and there is no on-screen text reflecting the fullness of the battery. In this case, because the position within the bar is the only indication the user has of the current charge, value text should not be provided by the implementor. <refsect2 id="implementor-notes"> <title>Implementor Notes</title> <para> Implementors should bear in mind that assistive technologies will likely prefer the value text provided over the numeric value when presenting a widget's value. As a result, strings not intended for end users should not be exposed in the value text, and strings which are exposed should be localized. In the case of widgets which display value text on screen, for instance through a separate label in close proximity to the value-displaying widget, it is still expected that implementors will expose the value text using the above API. </para> <para> #AtkValue should NOT be implemented for widgets whose displayed value is not reflective of a meaningful amount. For instance, a progress pulse indicator whose value alternates between 0.0 and 1.0 to indicate that some process is still taking place should not implement #AtkValue because the current value does not reflect progress towards completion. </para> </refsect2> </refsect1> <refsect1 id="ranges"> <title>On the subject of ranges</title> <para> In addition to providing the minimum and maximum values, implementors can optionally provide details about subranges associated with the widget. These details should be provided by the implementor when both of the following are communicated visually to the end user: </para> <itemizedlist> <listitem>The existence of distinct ranges such as "weak", "acceptable", and "strong" indicated by color, bar tick marks, and/or on-screen text.</listitem> <listitem>Where the current value stands within a given subrange, for instance illustrating progression from very "weak" towards nearly "acceptable" through changes in shade and/or position on the bar within the "weak" subrange.</listitem> </itemizedlist> <para> If both of the above do not apply to the widget, it should be sufficient to expose the numeric value, along with the value text if appropriate, to make the widget accessible. </para> <refsect2 id="ranges-implementor-notes"> <title>Implementor Notes</title> <para> If providing subrange details is deemed necessary, all possible values of the widget are expected to fall within one of the subranges defined by the implementor. </para> </refsect2> </refsect1> <refsect1 id="localization"> <title>On the subject of localization of end-user-consumable text values</title> <para> Because value text and subrange descriptors are human-consumable, implementors are expected to provide localized strings which can be directly presented to end users via their assistive technology. In order to simplify this for implementors, implementors can use atk_value_type_get_localized_name() with the following already-localized constants for commonly-needed values can be used: </para> <itemizedlist> <listitem>ATK_VALUE_VERY_WEAK</listitem> <listitem>ATK_VALUE_WEAK</listitem> <listitem>ATK_VALUE_ACCEPTABLE</listitem> <listitem>ATK_VALUE_STRONG</listitem> <listitem>ATK_VALUE_VERY_STRONG</listitem> <listitem>ATK_VALUE_VERY_LOW</listitem> <listitem>ATK_VALUE_LOW</listitem> <listitem>ATK_VALUE_MEDIUM</listitem> <listitem>ATK_VALUE_HIGH</listitem> <listitem>ATK_VALUE_VERY_HIGH</listitem> <listitem>ATK_VALUE_VERY_BAD</listitem> <listitem>ATK_VALUE_BAD</listitem> <listitem>ATK_VALUE_GOOD</listitem> <listitem>ATK_VALUE_VERY_GOOD</listitem> <listitem>ATK_VALUE_BEST</listitem> <listitem>ATK_VALUE_SUBSUBOPTIMAL</listitem> <listitem>ATK_VALUE_SUBOPTIMAL</listitem> <listitem>ATK_VALUE_OPTIMAL</listitem> </itemizedlist> <para> Proposals for additional constants, along with their use cases, should be submitted to the GNOME Accessibility Team. </para> </refsect1> <refsect1 id="changes"> <title>On the subject of changes</title> <para> Note that if there is a textual description associated with the new numeric value, that description should be included regardless of whether or not it has also changed. </para> </refsect1> Gets the value of this object. Since 2.12. Use atk_value_get_value_and_text() instead. a GObject instance that implements AtkValueIface a #GValue representing the current accessible value Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. the minimum increment by which the value of this object may be changed. zero if undefined. a GObject instance that implements AtkValueIface Gets the maximum value of this object. Since 2.12. Use atk_value_get_range() instead. a GObject instance that implements AtkValueIface a #GValue representing the maximum accessible value Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. Since 2.12. Use atk_value_get_increment() instead. a GObject instance that implements AtkValueIface a #GValue representing the minimum increment by which the accessible value may be changed Gets the minimum value of this object. Since 2.12. Use atk_value_get_range() instead. a GObject instance that implements AtkValueIface a #GValue representing the minimum accessible value Gets the range of this object. a newly allocated #AtkRange that represents the minimum, maximum and descriptor (if available) of @obj. NULL if that range is not defined. a GObject instance that implements AtkValueIface Gets the list of subranges defined for this object. See #AtkValue introduction for examples of subranges and when to expose them. an #GSList of #AtkRange which each of the subranges defined for this object. Free the returns list with g_slist_free(). a GObject instance that implements AtkValueIface Gets the current value and the human readable text alternative of @obj. @text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. a GObject instance that implements AtkValueIface address of #gdouble to put the current value of @obj address of #gchar to put the human readable text alternative for @value Sets the value of this object. Since 2.12. Use atk_value_set_value() instead. %TRUE if new value is successfully set, %FALSE otherwise. a GObject instance that implements AtkValueIface a #GValue which is the desired new accessible value. Sets the value of this object. This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an #AtkValue::value-changed signal emission. Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not. a GObject instance that implements AtkValueIface a double which is the desired new accessible value. Gets the value of this object. Since 2.12. Use atk_value_get_value_and_text() instead. a GObject instance that implements AtkValueIface a #GValue representing the current accessible value Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. the minimum increment by which the value of this object may be changed. zero if undefined. a GObject instance that implements AtkValueIface Gets the maximum value of this object. Since 2.12. Use atk_value_get_range() instead. a GObject instance that implements AtkValueIface a #GValue representing the maximum accessible value Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. Since 2.12. Use atk_value_get_increment() instead. a GObject instance that implements AtkValueIface a #GValue representing the minimum increment by which the accessible value may be changed Gets the minimum value of this object. Since 2.12. Use atk_value_get_range() instead. a GObject instance that implements AtkValueIface a #GValue representing the minimum accessible value Gets the range of this object. a newly allocated #AtkRange that represents the minimum, maximum and descriptor (if available) of @obj. NULL if that range is not defined. a GObject instance that implements AtkValueIface Gets the list of subranges defined for this object. See #AtkValue introduction for examples of subranges and when to expose them. an #GSList of #AtkRange which each of the subranges defined for this object. Free the returns list with g_slist_free(). a GObject instance that implements AtkValueIface Gets the current value and the human readable text alternative of @obj. @text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. a GObject instance that implements AtkValueIface address of #gdouble to put the current value of @obj address of #gchar to put the human readable text alternative for @value Sets the value of this object. Since 2.12. Use atk_value_set_value() instead. %TRUE if new value is successfully set, %FALSE otherwise. a GObject instance that implements AtkValueIface a #GValue which is the desired new accessible value. Sets the value of this object. This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an #AtkValue::value-changed signal emission. Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not. a GObject instance that implements AtkValueIface a double which is the desired new accessible value. The 'value-changed' signal is emitted when the current value that represent the object changes. @value is the numerical representation of this new value. @text is the human readable text alternative of @value, and can be NULL if it is not available. Note that if there is a textual description associated with the new numeric value, that description should be included regardless of whether or not it has also changed. Example: a password meter whose value changes as the user types their new password. Appropiate value text would be "weak", "acceptable" and "strong". the new value in a numerical form. human readable text alternative (also called description) of this object. NULL if not available. a GObject instance that implements AtkValueIface a #GValue representing the current accessible value a GObject instance that implements AtkValueIface a #GValue representing the maximum accessible value a GObject instance that implements AtkValueIface a #GValue representing the minimum accessible value %TRUE if new value is successfully set, %FALSE otherwise. a GObject instance that implements AtkValueIface a #GValue which is the desired new accessible value. a GObject instance that implements AtkValueIface a #GValue representing the minimum increment by which the accessible value may be changed a GObject instance that implements AtkValueIface address of #gdouble to put the current value of @obj address of #gchar to put the human readable text alternative for @value a newly allocated #AtkRange that represents the minimum, maximum and descriptor (if available) of @obj. NULL if that range is not defined. a GObject instance that implements AtkValueIface the minimum increment by which the value of this object may be changed. zero if undefined. a GObject instance that implements AtkValueIface an #GSList of #AtkRange which each of the subranges defined for this object. Free the returns list with g_slist_free(). a GObject instance that implements AtkValueIface a GObject instance that implements AtkValueIface a double which is the desired new accessible value. Default types for a given value. Those are defined in order to easily get localized strings to describe a given value or a given subrange, using atk_value_type_get_localized_name(). Gets the localized description string describing the #AtkValueType @value_type. the localized string describing the #AtkValueType The #AtkValueType whose localized name is required Gets the description string describing the #AtkValueType @value_type. the string describing the #AtkValueType The #AtkValueType whose name is required #AtkWindow should be implemented by the UI elements that represent a top-level window, such as the main window of an application or dialog. The signal #AtkWindow::activate is emitted when a window becomes the active window of the application or session. The signal #AtkWindow::create is emitted when a new window is created. The signal #AtkWindow::deactivate is emitted when a window is no longer the active window of the application or session. The signal #AtkWindow::destroy is emitted when a window is destroyed. The signal #AtkWindow::maximize is emitted when a window is maximized. The signal #AtkWindow::minimize is emitted when a window is minimized. The signal #AtkWindow::move is emitted when a window is moved. The signal #AtkWindow::resize is emitted when a window is resized. The signal #AtkWindow::restore is emitted when a window is restored. Adds the specified function to the list of functions to be called when an object receives focus. Focus tracking has been dropped as a feature to be implemented by ATK itself. If you need focus tracking on your implementation, subscribe to the #AtkObject::state-change "focused" signal. added focus tracker id, or 0 on failure. Function to be added to the list of functions to be called when an object receives focus. Adds the specified function to the list of functions to be called when an ATK event of type event_type occurs. The format of event_type is the following: "ATK:&lt;atk_type&gt;:&lt;atk_event&gt;:&lt;atk_event_detail&gt; Where "ATK" works as the namespace, &lt;atk_interface&gt; is the name of the ATK type (interface or object), &lt;atk_event&gt; is the name of the signal defined on that interface and &lt;atk_event_detail&gt; is the gsignal detail of that signal. You can find more info about gsignal details here: http://developer.gnome.org/gobject/stable/gobject-Signals.html The first three parameters are mandatory. The last one is optional. For example: ATK:AtkObject:state-change ATK:AtkText:text-selection-changed ATK:AtkText:text-insert:system Toolkit implementor note: ATK provides a default implementation for this virtual method. ATK implementors are discouraged from reimplementing this method. Toolkit implementor note: this method is not intended to be used by ATK implementors but by ATK consumers. ATK consumers note: as this method adds a listener for a given ATK type, that type should be already registered on the GType system before calling this method. A simple way to do that is creating an instance of #AtkNoOpObject. This class implements all ATK interfaces, so creating the instance will register all ATK types as a collateral effect. added event listener id, or 0 on failure. the listener to notify the type of event for which notification is requested Adds the specified function to the list of functions to be called when a key event occurs. The @data element will be passed to the #AtkKeySnoopFunc (@listener) as the @func_data param, on notification. added event listener id, or 0 on failure. the listener to notify a #gpointer that points to a block of data that should be sent to the registered listeners, along with the event notification, when it occurs. Frees the memory used by an #AtkAttributeSet, including all its #AtkAttributes. The #AtkAttributeSet to free Specifies the function to be called for focus tracker initialization. This function should be called by an implementation of the ATK interface if any specific work needs to be done to enable focus tracking. Focus tracking has been dropped as a feature to be implemented by ATK itself. Function to be called for focus tracker initialization Cause the focus tracker functions which have been specified to be executed for the object. Focus tracking has been dropped as a feature to be implemented by ATK itself. As #AtkObject::focus-event was deprecated in favor of a #AtkObject::state-change signal, in order to notify a focus change on your implementation, you can use atk_object_notify_state_change() instead. an #AtkObject Returns the binary age as passed to libtool when building the ATK library the process is running against. the binary age of the ATK library Gets a default implementation of the #AtkObjectFactory/type registry. Note: For most toolkit maintainers, this will be the correct registry for registering new #AtkObject factories. Following a call to this function, maintainers may call atk_registry_set_factory_type() to associate an #AtkObjectFactory subclass with the GType of objects for whom accessibility information will be provided. a default implementation of the #AtkObjectFactory/type registry Gets the currently focused object. the currently focused object for the current application Returns the interface age as passed to libtool when building the ATK library the process is running against. the interface age of the ATK library Returns the major version number of the ATK library. (e.g. in ATK version 2.7.4 this is 2.) This function is in the library, so it represents the ATK library your code is running against. In contrast, the #ATK_MAJOR_VERSION macro represents the major version of the ATK headers you have included when compiling your code. the major version number of the ATK library Returns the micro version number of the ATK library. (e.g. in ATK version 2.7.4 this is 4.) This function is in the library, so it represents the ATK library your code is are running against. In contrast, the #ATK_MICRO_VERSION macro represents the micro version of the ATK headers you have included when compiling your code. the micro version number of the ATK library Returns the minor version number of the ATK library. (e.g. in ATK version 2.7.4 this is 7.) This function is in the library, so it represents the ATK library your code is are running against. In contrast, the #ATK_MINOR_VERSION macro represents the minor version of the ATK headers you have included when compiling your code. the minor version number of the ATK library Gets the root accessible container for the current application. the root accessible container for the current application Gets name string for the GUI toolkit implementing ATK for this application. name string for the GUI toolkit implementing ATK for this application Gets version string for the GUI toolkit implementing ATK for this application. version string for the GUI toolkit implementing ATK for this application Gets the current version for ATK. version string for ATK 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 Removes the specified focus tracker from the list of functions to be called when any object receives focus. Focus tracking has been dropped as a feature to be implemented by ATK itself. If you need focus tracking on your implementation, subscribe to the #AtkObject::state-change "focused" signal. the id of the focus tracker to remove @listener_id is the value returned by #atk_add_global_event_listener when you registered that event listener. Toolkit implementor note: ATK provides a default implementation for this virtual method. ATK implementors are discouraged from reimplementing this method. Toolkit implementor note: this method is not intended to be used by ATK implementors but by ATK consumers. Removes the specified event listener the id of the event listener to remove @listener_id is the value returned by #atk_add_key_event_listener when you registered that event listener. Removes the specified event listener. the id of the event listener to remove 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. 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 Register a new object state. an #AtkState value for the new state. a character string describing the new state. Get the #AtkTextAttribute type corresponding to a text attribute name. the #AtkTextAttribute enumerated type corresponding to the specified name, or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found. a string which is the (non-localized) name of an ATK text attribute. Gets the name corresponding to the #AtkTextAttribute a string containing the name; this string should not be freed The #AtkTextAttribute whose name is required Gets the value for the index of the #AtkTextAttribute a string containing the value; this string should not be freed; %NULL is returned if there are no values maintained for the attr value. The #AtkTextAttribute for which a value is required The index of the required value Associate @name with a new #AtkTextAttribute an #AtkTextAttribute associated with @name a name string Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated. A pointer to an array of #AtkTextRange which is to be freed. Gets the localized description string describing the #AtkValueType @value_type. the localized string describing the #AtkValueType The #AtkValueType whose localized name is required Gets the description string describing the #AtkValueType @value_type. the string describing the #AtkValueType The #AtkValueType whose name is required