Added new API for ATK 1.11/1.12.
Minor docs cleanup.
+2005-11-17 Bill Haneman <bill.haneman@sun.com>
+
+ * atk/atkobject.h:
+ (AtkRoleType): Added ATK_ROLE_ENTRY, ATK_ROLE_CHART,
+ ATK_ROLE_CAPTION, ATK_ROLE_DOCUMENT_FRAME, ATK_ROLE_HEADING,
+ ATK_ROLE_PAGE, ATK_ROLE_SECTION, ATK_ROLE_REDUNDANT_OBJECT.
+ (AtkAttributeSet): Moved here from AtkText.
+ (AtkObjectClass): Added get_attributes vfunc pointer.
+ (atk_object_get_attributes): New public method.
+
+ * atk/atkobject.c:
+ (atk_object_get_attributes): New method implementation,
+ uses AtkObjectClass->get_attributes. This method allows
+ the assignment of weakly-type attributes to any AtkObject
+ instance, as name-value pairs.
+ (AtkRoleItem): Added names for the new roles.
+
+ * atk/atkstate.h:
+ (AtkStateType): Added ATK_STATE_INVALID_ENTRY,
+ ATK_STATE_SUPPORTS_AUTOCOMPLETION, ATK_STATE_SELECTABLE_TEXT.
+ Tweaked docs for other states.
+
+ * atk/atkimage.h:
+ (AtkImageClass): Added get_image_locale vfunc.
+ (atk_image_get_image_locale): New method.
+
+ * atk/atkimage.c:
+ (atk_image_get_image_locale): New method.
+
+ * atk/atkcomponent.h:
+ (AtkComponentClass): Added get_alpha vfunc.
+ (atk_component_get_alpha): New method.
+
+ * atk/atkcomponent.c:
+ (atk_component_get_alpha): New method.
+
+ * atk/atkdocument.h:
+ (AtkDocument): Added vfuncs for document locale and
+ document attributes.
+ (atk_document_get_locale): New.
+ (atk_document_get_attributes): New.
+ (atk_document_get_attribute_value): New.
+ (atk_document_set_attribute_value): New.
+
+ * atk/atkdocument.c:
+ (atk_document_get_locale): New.
+ (atk_document_get_attributes): New.
+ (atk_document_get_attribute_value): New.
+ (atk_document_set_attribute_value): New.
+
2005-11-16 Bill Haneman <bill.haneman@sun.com>
* atk/atkimage.c:
+Changes in version 1.11.0:
+=========================
+
+ Added new APIs - minor enhancements to AtkImage,
+ AtkDocument, AtkObject, AtkComponent, AtkState.
+
+ Significant API additions: Added locale attribute to
+ AtkImage instances, and Document instances.
+ Added the ability to assign weakly-typed attributes to
+ AtkObject as name-value pairs; also added similar
+ name-value pairs to AtkDocument for attributes which are
+ intended to be valid over the entire document.
+
+ Minor documentation fixes (thanks to Bill Abt).
+
+ Added 'tt' (Tatar) locale, Simos Xenitellis
+
Changes in version 1.10.3:
=========================
}
/**
+ * atk_component_get_alpha:
+ * @component: an #AtkComponent
+ *
+ * Returns the alpha value (i.e. the opacity) for this
+ * @component, on a scale from 0 (fully transparent) to 1.0
+ * (fully opaque).
+ *
+ * Returns: An alpha value from 0 to 1.0, inclusive.
+ * @Since: ATK 1.12
+ **/
+gdouble
+atk_component_get_alpha (AtkComponent *component)
+{
+ AtkComponentIface *iface;
+
+ g_return_val_if_fail (ATK_IS_COMPONENT (component), G_MININT);
+
+ iface = ATK_COMPONENT_GET_IFACE (component);
+ if (iface->get_alpha)
+ return (iface->get_alpha) (component);
+ else
+ return (gdouble) 1.0;
+}
+
+/**
* atk_component_grab_focus:
* @component: an #AtkComponent
*
atk_component_get_extents (component, &x, &y, width, height, coord_type);
}
+gdouble
+atk_component_real_get_alpha (AtkComponent *component)
+{
+ return (gdouble) 1.0;
+}
+
static AtkRectangle *
atk_rectangle_copy (const AtkRectangle *rectangle)
{
*/
void (* bounds_changed) (AtkComponent *component,
AtkRectangle *bounds);
- AtkFunction pad2;
+ gdouble (* get_alpha) (AtkComponent *component);
};
GType atk_component_get_type (void);
gboolean atk_component_set_size (AtkComponent *component,
gint width,
gint height);
-
+gdouble atk_component_get_alpha (AtkComponent *component);
#ifdef __cplusplus
}
#endif /* __cplusplus */
}
}
+/**
+ * atk_document_get_locale:
+ * @document: 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.
+ *
+ * Returns: 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.
+ **/
+G_CONST_RETURN gchar *
+atk_document_get_locale (AtkDocument *document)
+{
+ AtkDocumentIface *iface;
+
+ g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
+
+ iface = ATK_DOCUMENT_GET_IFACE (document);
+
+ if (iface->get_document_locale)
+ {
+ return (iface->get_document_locale) (document);
+ }
+ else
+ {
+ return NULL;
+ }
+}
+
+
+/**
+ * atk_document_get_attributes:
+ * @document: a #GObject instance that implements AtkDocumentIface
+ *
+ * Gets an AtkAttributeSet which describes document-wide
+ * attributes as name-value pairs.
+ *
+ * Returns: An AtkAttributeSet containing the explicitly
+ * set name-value-pair attributes associated with this document
+ * as a whole.
+ * @Since: ATK 1.12
+ **/
+AtkAttributeSet *
+atk_document_get_attributes (AtkDocument *document)
+{
+ AtkDocumentIface *iface;
+
+ g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
+
+ iface = ATK_DOCUMENT_GET_IFACE (document);
+
+ if (iface->get_document_attributes)
+ {
+ return (iface->get_document_attributes) (document);
+ }
+ else
+ {
+ return NULL;
+ }
+}
+
+/**
+ * atk_document_get_attribute_value:
+ * @document: a #GObject instance that implements AtkDocumentIface
+ * @attribute_name: a character string representing the name of the attribute
+ * whose value is being queried.
+ *
+ * Returns: 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.
+ * @Since: ATK 1.12
+ */
+G_CONST_RETURN gchar *
+atk_document_get_attribute_value (AtkDocument *document,
+ const gchar *attribute_name)
+{
+ AtkDocumentIface *iface;
+
+ g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
+
+ iface = ATK_DOCUMENT_GET_IFACE (document);
+
+ if (iface->get_document_attribute_value)
+ {
+ return (iface->get_document_attribute_value) (document, attribute_name);
+ }
+ else
+ {
+ return NULL;
+ }
+}
+
+/**
+ * atk_document_set_attribute_value:
+ * @document: a #GObject instance that implements AtkDocumentIface
+ * @attribute_name: a character string representing the name of the attribute
+ * whose value is being set.
+ * @value: a string value to be associated with #attribute_name.
+ *
+ * Returns: TRUE if #value is successfully associated with #attribute_name
+ * for this document, FALSE otherwise (e.g. if the document does not
+ * allow the attribute to be modified).
+ * @Since ATK 1.12
+ */
+gboolean
+atk_document_set_attribute_value (AtkDocument *document,
+ const gchar *attribute_name,
+ const gchar *value)
+{
+ AtkDocumentIface *iface;
+
+ g_return_val_if_fail (ATK_IS_DOCUMENT (document), FALSE);
+
+ iface = ATK_DOCUMENT_GET_IFACE (document);
+
+ if (iface->set_document_attribute)
+ {
+ return (iface->set_document_attribute) (document, attribute_name, value);
+ }
+ else
+ {
+ return FALSE;
+ }
+}
#endif /* __cplusplus */
/*
- * The AtkDocument interface should be supported by any object that has an
- * associated document object model (DOM). This interface provides the
- * standard mechanism allowing an assistive technology access to the DOM.
+ * The AtkDocument interface should be supported by any object that is a container
+ * for 'document content' as opposed to a collection of user interface elements.
+ *
*/
#define ATK_TYPE_DOCUMENT (atk_document_get_type ())
G_CONST_RETURN gchar* ( *get_document_type) (AtkDocument *document);
gpointer ( *get_document) (AtkDocument *document);
+ G_CONST_RETURN gchar* ( *get_document_locale) (AtkDocument *document);
+ AtkAttributeSet * ( *get_document_attributes) (AtkDocument *document);
+ G_CONST_RETURN gchar* ( *get_document_attribute_value) (AtkDocument *document,
+ const gchar *attribute_name);
+ gboolean ( *set_document_attribute) (AtkDocument *document,
+ const gchar *attribute_name,
+ const gchar *attribute_value);
AtkFunction pad1;
AtkFunction pad2;
AtkFunction pad3;
AtkFunction pad4;
- AtkFunction pad5;
- AtkFunction pad6;
- AtkFunction pad7;
- AtkFunction pad8;
};
GType atk_document_get_type (void);
G_CONST_RETURN gchar* atk_document_get_document_type (AtkDocument *document);
gpointer atk_document_get_document (AtkDocument *document);
-
+G_CONST_RETURN gchar* atk_document_get_locale (AtkDocument *document);
+AtkAttributeSet* atk_document_get_attributes (AtkDocument *document);
+G_CONST_RETURN gchar* atk_document_get_attribute_value (AtkDocument *document,
+ const gchar *attribute_name);
+gboolean atk_document_set_attribute_value (AtkDocument *document,
+ const gchar *attribute_name,
+ const gchar *attribute_value);
#ifdef __cplusplus
}
#endif /* __cplusplus */
*y = -1;
}
}
+
+/**
+ * Returns a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.
+ * @Since ATK 1.12
+ */
+G_CONST_RETURN gchar*
+atk_image_get_image_locale (AtkImage *image)
+{
+
+ AtkImageIface *iface;
+
+ g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
+
+ iface = ATK_IMAGE_GET_IFACE (image);
+
+ if (iface->get_image_locale)
+ {
+ return (iface->get_image_locale) (image);
+ }
+ else
+ {
+ return NULL;
+ }
+}
gint *height);
gboolean ( *set_image_description) (AtkImage *image,
const gchar *description);
+ G_CONST_RETURN gchar* ( *get_image_locale) (AtkImage *image);
AtkFunction pad1;
- AtkFunction pad2;
+
};
GType atk_image_get_type (void);
gint *y,
AtkCoordType coord_type);
+G_CONST_RETURN gchar* atk_image_get_image_locale (AtkImage *image);
+
#ifdef __cplusplus
}
#endif /* __cplusplus */
{ ATK_ROLE_APPLICATION, N_("application")},
{ ATK_ROLE_AUTOCOMPLETE, N_("autocomplete")},
{ ATK_ROLE_EDITBAR, N_("edit bar")},
- { ATK_ROLE_EMBEDDED, N_("embedded component")}
+ { ATK_ROLE_EMBEDDED, N_("embedded component")},
+ { ATK_ROLE_ENTRY, N_("entry")},
+ { ATK_ROLE_CHART, N_("chart")},
+ { ATK_ROLE_CAPTION, N_("caption")},
+ { ATK_ROLE_DOCUMENT_FRAME, N_("document frame")},
+ { ATK_ROLE_HEADING, N_("heading")},
+ { ATK_ROLE_PAGE, N_("page")},
+ { ATK_ROLE_SECTION, N_("section")},
+ { ATK_ROLE_REDUNDANT_OBJECT, N_("redundant object")}
};
static void atk_object_class_init (AtkObjectClass *klass);
return accessible;
}
+
+/**
+ * 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.
+ * @Since ATK 1.12
+ */
+AtkAttributeSet *
+atk_object_get_attributes (AtkObject *accessible)
+{
+ AtkObjectClass *klass;
+
+ g_return_val_if_fail (ATK_IS_OBJECT (accessible), NULL);
+
+ klass = ATK_OBJECT_GET_CLASS (accessible);
+ if (klass->get_attributes)
+ return (klass->get_attributes) (accessible);
+ else
+ return NULL;
+
+}
+
static AtkRelationSet*
atk_object_real_ref_relation_set (AtkObject *accessible)
{
*@ATK_ROLE_AUTOCOMPLETE: 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.
*@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar
*@ATK_ROLE_EMBEDDED: 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.
- *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of enumeration
+ *@ATK_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present.
+ *@ATK_ROLE_CHART: 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.
+ *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.
+ *@ATK_ROLE_DOCUMENT_FRAME: 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.
+ *@ATK_ROLE_HEADING: 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.
+ *@ATK_ROLE_PAGE: 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.
+ *@ATK_ROLE_SECTION: 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.
+ *@ATK_ROLE_REDUNDANT_OBJECT: 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.
+ *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
*
* Describes the role of an object
*
ATK_ROLE_AUTOCOMPLETE,
ATK_ROLE_EDITBAR,
ATK_ROLE_EMBEDDED,
+ ATK_ROLE_ENTRY,
+ ATK_ROLE_CHART,
+ ATK_ROLE_CAPTION,
+ ATK_ROLE_DOCUMENT_FRAME,
+ ATK_ROLE_HEADING,
+ ATK_ROLE_PAGE,
+ ATK_ROLE_SECTION,
+ ATK_ROLE_REDUNDANT_OBJECT,
ATK_ROLE_LAST_DEFINED
} AtkRole;
ATK_LAYER_WINDOW
} AtkLayer;
+/**
+ * AtkAttributeSet:
+ *
+ * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
+ * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
+ * and atk_editable_text_set_run_attributes()
+ **/
+typedef GSList AtkAttributeSet;
+
+/**
+ * AtkAttribute:
+ * @name: The attribute name. Call atk_text_attr_get_name()
+ * @value: the value of the attribute, represented as a string.
+ * Call atk_text_attr_get_value() for those which are strings.
+ * For values which are numbers, the string representation of the number
+ * is in value.
+ *
+ * A string name/value pair representing a text attribute.
+ **/
+typedef struct _AtkAttribute AtkAttribute;
+
+struct _AtkAttribute {
+ gchar* name;
+ gchar* value;
+};
+
#define ATK_TYPE_OBJECT (atk_object_get_type ())
#define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
#define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
void (*active_descendant_changed) (AtkObject *accessible,
gpointer *child);
+ /*
+ * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
+ * @since ATK 1.12
+ */
+ AtkAttributeSet* (*get_attributes) (AtkObject *accessible);
AtkFunction pad1;
AtkFunction pad2;
- AtkFunction pad3;
-
};
GType atk_object_get_type (void);
AtkRole atk_object_get_role (AtkObject *accessible);
AtkLayer atk_object_get_layer (AtkObject *accessible);
gint atk_object_get_mdi_zorder (AtkObject *accessible);
+AtkAttributeSet* atk_object_get_attributes (AtkObject *accessible);
AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
gint atk_object_get_index_in_parent (AtkObject *accessible);
void atk_object_set_name (AtkObject *accessible,
AtkObject *target);
G_CONST_RETURN gchar* atk_role_get_localized_name (AtkRole role);
+/* */
+
/*
* Note: the properties which are registered with the GType
*AtkStateType:
*@ATK_STATE_INVALID: Indicates an invalid state
*@ATK_STATE_ACTIVE: Indicates a window is currently the active window
- *@ATK_STATE_ARMED: Indicates that the object is armed
- *@ATK_STATE_BUSY: Indicates the current object is busy
+ *@ATK_STATE_ARMED: Indicates that the object is armed.
+ *@ATK_STATE_BUSY: Indicates the current object is busy. This state may be used by implementors of Document to indicate that content loading is in process.
*@ATK_STATE_CHECKED: Indicates this object is currently checked
*@ATK_STATE_DEFUNCT: Indicates the user interface object corresponding to this object no longer exists
*@ATK_STATE_EDITABLE: Indicates the user can change the contents of this object
*@ATK_STATE_MODAL: Indicates something must be done with this object before the user can interact with an object in a different window
*@ATK_STATE_MULTI_LINE: Indicates this (text) object can contain multiple lines of text
*@ATK_STATE_MULTISELECTABLE: Indicates this object allows more than one of its children to be selected at the same time
- *@ATK_STATE_OPAQUE: Indicates this object paints every pixel within its rectangular region
+ *@ATK_STATE_OPAQUE: Indicates this object paints every pixel within its rectangular region.
*@ATK_STATE_PRESSED: Indicates this object is currently pressed
*@ATK_STATE_RESIZABLE: Indicates the size of this object is not fixed
*@ATK_STATE_SELECTABLE: 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
*@ATK_STATE_INDETERMINATE: Indicates that a check box is in a state other than checked or not checked.
*@ATK_STATE_TRUNCATED: Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
*@ATK_STATE_REQUIRED: Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.
+ *@ATK_STATE_INVALID_ENTRY: 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.
+ *@ATK_STATE_SUPPORTS_AUTOCOMPLETION: Indicates that the object may exhibit "typeahead" behavior in response to user keystrokes, e.g. one keystroke may result in the insertion of several characters into an entry, or result in the auto-selection of an item in a list. This state supplants @ATK_ROLE_AUTOCOMPLETE.
+ *@ATK_STATE_SELECTABLE_TEXT: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.
*@ATK_STATE_LAST_DEFINED: Not a valid state, used for finding end of enumeration
*
*The possible types of states of an object
ATK_STATE_INDETERMINATE,
ATK_STATE_TRUNCATED,
ATK_STATE_REQUIRED,
+ ATK_STATE_INVALID_ENTRY,
+ ATK_STATE_SUPPORTS_AUTOCOMPLETION,
+ ATK_STATE_SELECTABLE_TEXT,
+
ATK_STATE_LAST_DEFINED
} AtkStateType;
#endif /* __cplusplus */
/**
- * AtkAttributeSet:
- *
- * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
- * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
- * and atk_editable_text_set_run_attributes()
- **/
-typedef GSList AtkAttributeSet;
-
-/**
- * AtkAttribute:
- * @name: The attribute name. Call atk_text_attr_get_name()
- * @value: the value of the attribute, represented as a string.
- * Call atk_text_attr_get_value() for those which are strings.
- * For values which are numbers, the string representation of the number
- * is in value.
- *
- * A string name/value pair representing a text attribute.
- **/
-typedef struct _AtkAttribute AtkAttribute;
-
-struct _AtkAttribute {
- gchar* name;
- gchar* value;
-};
-
-/**
*AtkTextAttribute
*@ATK_TEXT_ATTR_INVALID: Invalid attribute
*@ATK_TEXT_ATTR_LEFT_MARGIN: The pixel width of the left margin
dnl The triplet
m4_define([atk_major_version], [1])
-m4_define([atk_minor_version], [10])
-m4_define([atk_micro_version], [3])
+m4_define([atk_minor_version], [11])
+m4_define([atk_micro_version], [0])
m4_define([atk_version],
[atk_major_version.atk_minor_version.atk_micro_version])
m4_define([atk_api_version], [1.0])
dnl Number of releases since we've added interfaces
-m4_define([atk_interface_age], [3])
+m4_define([atk_interface_age], [0])
m4_define([atk_binary_age],
[m4_eval(100 * atk_minor_version + 10 + atk_micro_version)])
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkAction ##### -->
<para>
The AtkAction structure does not contain any fields.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkComponent ##### -->
<para>
The AtkComponent structure does not contain any fields.
</para>
+<!-- ##### SIGNAL AtkComponent::bounds-changed ##### -->
+<para>
+The 'bounds-changed" signal is emitted when the bposition or size of the
+a component changes.
+</para>
+
+@atkcomponent: the object which received the signal.
+@arg1: The AtkRectangle giving the new position and size.
+
<!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL AtkComponent::bounds-changed ##### -->
-<para>
-The 'bounds-changed" signal is emitted when the bposition or size of the
-a component changes.
-</para>
-
-@atkcomponent: the object which received the signal.
-@arg1: The AtkRectangle giving the new position and size.
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkDocument ##### -->
<para>
The AtkDocument structure does not contain any fields.
#AtkText
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkEditableText ##### -->
<para>
The AtkEditableText structure does not contain any fields.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkGObjectAccessible ##### -->
<para>
The AtkGObjectAccessible structure should not be accessed directly.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkHyperlink ##### -->
<para>
The AtkHyperlink structure should not be accessed directly.
</para>
+<!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
+<para>
+The signal link-activated is emitted when a link is activated.
+</para>
+
+@atkhyperlink: the object which received the signal.
+
+<!-- ##### ARG AtkHyperlink:end-index ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkHyperlink:selected-link ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkHyperlink:start-index ##### -->
+<para>
+
+</para>
+
<!-- ##### ENUM AtkHyperlinkStateFlags ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
-<para>
-The signal link-activated is emitted when a link is activated.
-</para>
-
-@atkhyperlink: the object which received the signal.
-
-<!-- ##### ARG AtkHyperlink:end-index ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkHyperlink:selected-link ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkHyperlink:start-index ##### -->
-<para>
-
-</para>
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkHypertext ##### -->
<para>
The AtkHypertext structure does not contain any fields.
</para>
+<!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
+<para>
+The "link-selected" signal is emitted by an AtkHyperText object when one of
+the hyperlinks associated with the object is selected.
+</para>
+
+@atkhypertext: the object which received the signal.
+@arg1: the index of the hyperlink which is selected
+
<!-- ##### FUNCTION atk_hypertext_get_link ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
-<para>
-The "link-selected" signal is emitted by an AtkHyperText object when one of
-the hyperlinks associated with the object is selected.
-</para>
-
-@atkhypertext: the object which received the signal.
-@arg1: the index of the hyperlink which is selected
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkImage ##### -->
<para>
The AtkImage structure does not contain any fields.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkNoOpObject ##### -->
<para>
The AtkNoOpObject structure should not be accessed directly.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkNoOpObjectFactory ##### -->
<para>
The AtkNoOpObjectFactory structure should not be accessed directly.
( GTK+ users see also #GtkAccessible).
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkObject ##### -->
<para>
The AtkObject structure should not be accessed directly.
</para>
+<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
+<para>
+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.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: the newly focused object.
+
+<!-- ##### SIGNAL AtkObject::children-changed ##### -->
+<para>
+The signal "children-changed" is emitted when a child is added or
+removed form an object. It supports two details: "add" and "remove"
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The index of the added or removed child
+@arg2: The child which was added or removed
+
+<!-- ##### SIGNAL AtkObject::focus-event ##### -->
+<para>
+The signal "focus-event" is emitted when an object gains or loses focus.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: A boolean value which indicates whether the object gained or lost focus.
+
+<!-- ##### SIGNAL AtkObject::property-change ##### -->
+<para>
+The signal "property-change" is emitted when an object's property
+value changes. The detail identifies the name of the property whose
+value has changed.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The new value of the property which changed.
+
+<!-- ##### SIGNAL AtkObject::state-change ##### -->
+<para>
+The "state-change" signal is emitted when an object's state changes.
+The detail value identifies the state type which has changed.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The name of the state which has changed
+@arg2: A boolean which indicates whether the state has been set or unset.
+
+<!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
+<para>
+The "visible-data-changed" signal is emitted when the visual appearance of
+the object changed.
+</para>
+
+@atkobject: the object which received the signal.
+
+<!-- ##### ARG AtkObject:accessible-component-layer ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-description ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-name ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-parent ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-role ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-caption ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-summary ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-value ##### -->
+<para>
+
+</para>
+
<!-- ##### ENUM AtkRole ##### -->
<para>
</para>
@ATK_ROLE_AUTOCOMPLETE:
@ATK_ROLE_EDITBAR:
@ATK_ROLE_EMBEDDED:
+@ATK_ROLE_ENTRY:
+@ATK_ROLE_CHART:
+@ATK_ROLE_CAPTION:
+@ATK_ROLE_DOCUMENT_FRAME:
+@ATK_ROLE_HEADING:
+@ATK_ROLE_PAGE:
+@ATK_ROLE_SECTION:
+@ATK_ROLE_REDUNDANT_OBJECT:
@ATK_ROLE_LAST_DEFINED:
<!-- ##### FUNCTION atk_role_register ##### -->
atk_object_connect_property_change_handler().
</para>
-@Param1:
-@Param2:
+@Param1: an #AtkObject
+@Param2: an #AtkPropertyValues
<!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
@Returns:
-<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
-<para>
-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.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: the newly focused object.
-
-<!-- ##### SIGNAL AtkObject::children-changed ##### -->
-<para>
-The signal "children-changed" is emitted when a child is added or
-removed form an object. It supports two details: "add" and "remove"
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: The index of the added or removed child
-@arg2: The child which was added or removed
-
-<!-- ##### SIGNAL AtkObject::focus-event ##### -->
-<para>
-The signal "focus-event" is emitted when an object gains or loses focus.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: A boolean value which indicates whether the object gained or lost focus.
-
-<!-- ##### SIGNAL AtkObject::property-change ##### -->
-<para>
-The signal "property-change" is emitted when an object's property
-value changes. The detail identifies the name of the property whose
-value has changed.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: The new value of the property which changed.
-
-<!-- ##### SIGNAL AtkObject::state-change ##### -->
-<para>
-The "state-change" signal is emitted when an object's state changes.
-The detail value identifies the state type which has changed.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: The name of the state which has changed
-@arg2: A boolean which indicates whether the state has been set or unset.
-
-<!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
-<para>
-The "visible-data-changed" signal is emitted when the visual appearance of
-the object changed.
-</para>
-
-@atkobject: the object which received the signal.
-
-<!-- ##### ARG AtkObject:accessible-component-layer ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-description ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-name ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-parent ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-role ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-caption ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-summary ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-value ##### -->
-<para>
-
-</para>
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkObjectFactory ##### -->
<para>
The AtkObjectFactory structure should not be accessed directly.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkRegistry ##### -->
<para>
The AtkRegistry structure should not be accessed directly.
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkRelation ##### -->
<para>
The AtkRelation structure should not be accessed directly.
</para>
+<!-- ##### ARG AtkRelation:relation-type ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkRelation:target ##### -->
+<para>
+
+</para>
+
<!-- ##### ENUM AtkRelationType ##### -->
<para>
@target:
-<!-- ##### ARG AtkRelation:relation-type ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkRelation:target ##### -->
-<para>
-
-</para>
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkRelationSet ##### -->
<para>
The AtkRelationSet structure should not be accessed directly.
#AtkText
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkSelection ##### -->
<para>
The AtkAction structure does not contain any fields.
</para>
+<!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
+<para>
+The "selection-changed" signal is emitted by an object which implements
+AtkSelection interface when the selection changes.
+</para>
+
+@atkselection: the object which received the signal.
+
<!-- ##### FUNCTION atk_selection_add_selection ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
-<para>
-The "selection-changed" signal is emitted by an object which implements
-AtkSelection interface when the selection changes.
-</para>
-
-@atkselection: the object which received the signal.
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### ENUM AtkStateType ##### -->
<para>
@ATK_STATE_MANAGES_DESCENDANTS:
@ATK_STATE_INDETERMINATE:
@ATK_STATE_TRUNCATED:
+@ATK_STATE_REQUIRED:
+@ATK_STATE_INVALID_ENTRY:
+@ATK_STATE_SUPPORTS_AUTOCOMPLETION:
+@ATK_STATE_SELECTABLE_TEXT:
@ATK_STATE_LAST_DEFINED:
<!-- ##### TYPEDEF AtkState ##### -->
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### FUNCTION atk_state_set_new ##### -->
<para>
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkStreamableContent ##### -->
<para>
The AtkStreamableContent structure does not contain any fields.
#AtkObject, #ATK_STATE_TRANSIENT
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkTable ##### -->
<para>
The AtkTable structure does not contain any fields.
</para>
+<!-- ##### SIGNAL AtkTable::column-deleted ##### -->
+<para>
+The "column-deleted" signal is emitted by an object which implements the
+AtkTable interface when a column is deleted.
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the first column deleted.
+@arg2: The number of columns deleted.
+
+<!-- ##### SIGNAL AtkTable::column-inserted ##### -->
+<para>
+The "column-inserted" signal is emitted by an object which implements the
+AtkTable interface when a column is inserted.
+
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the column inserted.
+@arg2: The number of colums inserted.
+
+<!-- ##### SIGNAL AtkTable::column-reordered ##### -->
+<para>
+The "column-reordered" signal is emitted by an object which implements the
+AtkTable interface when the columns are reordered.
+</para>
+
+@atktable: the object which received the signal.
+
+<!-- ##### SIGNAL AtkTable::model-changed ##### -->
+<para>
+The "model-changed" signal is emitted by an object which implements the
+AtkTable interface when the model displayed by the table changes.
+</para>
+
+@atktable: the object which received the signal.
+
+<!-- ##### SIGNAL AtkTable::row-deleted ##### -->
+<para>
+The "row-deleted" signal is emitted by an object which implements the
+AtkTable interface when a column is inserted.
+
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the first row deleted.
+@arg2: The number of rows deleted.
+
+<!-- ##### SIGNAL AtkTable::row-inserted ##### -->
+<para>
+The "row-inserted" signal is emitted by an object which implements the
+AtkTable interface when a column is inserted.
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the first row deleted.
+@arg2: The number of rows deleted.
+
+<!-- ##### SIGNAL AtkTable::row-reordered ##### -->
+<para>
+The "row-reordered" signal is emitted by an object which implements the
+AtkTable interface when the columns are reordered.
+</para>
+
+@atktable: the object which received the signal.
+
<!-- ##### FUNCTION atk_table_ref_at ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL AtkTable::column-deleted ##### -->
-<para>
-The "column-deleted" signal is emitted by an object which implements the
-AtkTable interface when a column is deleted.
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the first column deleted.
-@arg2: The number of columns deleted.
-
-<!-- ##### SIGNAL AtkTable::column-inserted ##### -->
-<para>
-The "column-inserted" signal is emitted by an object which implements the
-AtkTable interface when a column is inserted.
-
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the column inserted.
-@arg2: The number of colums inserted.
-
-<!-- ##### SIGNAL AtkTable::column-reordered ##### -->
-<para>
-The "column-reordered" signal is emitted by an object which implements the
-AtkTable interface when the columns are reordered.
-</para>
-
-@atktable: the object which received the signal.
-
-<!-- ##### SIGNAL AtkTable::model-changed ##### -->
-<para>
-The "model-changed" signal is emitted by an object which implements the
-AtkTable interface when the model displayed by the table changes.
-</para>
-
-@atktable: the object which received the signal.
-
-<!-- ##### SIGNAL AtkTable::row-deleted ##### -->
-<para>
-The "row-deleted" signal is emitted by an object which implements the
-AtkTable interface when a column is inserted.
-
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the first row deleted.
-@arg2: The number of rows deleted.
-
-<!-- ##### SIGNAL AtkTable::row-inserted ##### -->
-<para>
-The "row-inserted" signal is emitted by an object which implements the
-AtkTable interface when a column is inserted.
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the first row deleted.
-@arg2: The number of rows deleted.
-
-<!-- ##### SIGNAL AtkTable::row-reordered ##### -->
-<para>
-The "row-reordered" signal is emitted by an object which implements the
-AtkTable interface when the columns are reordered.
-</para>
-
-@atktable: the object which received the signal.
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkText ##### -->
<para>
The AtkText structure does not contain any fields.
</para>
+<!-- ##### SIGNAL AtkText::text-attributes-changed ##### -->
+<para>
+The "text-attributes-changed" signal is emitted when the text attributes of
+the text of an object which implements AtkText changes.
+</para>
+
+@atktext: the object which received the signal.
+
+<!-- ##### SIGNAL AtkText::text-caret-moved ##### -->
+<para>
+The "text-caret-moved" signal is emitted when the caret position of
+the text of an object which implements AtkText changes.
+</para>
+
+@atktext: the object which received the signal.
+@arg1: The new position of the text caret.
+
+<!-- ##### SIGNAL AtkText::text-changed ##### -->
+<para>
+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
+</para>
+
+@atktext: the object which received the signal.
+@arg1: The position of the insertion or deletion.
+@arg2: The length of text inserted or deleted.
+
+<!-- ##### SIGNAL AtkText::text-selection-changed ##### -->
+<para>
+The "text-selection-changed" signal is emitted when the selected text of
+an object which implements AtkText changes.
+
+</para>
+
+@atktext: the object which received the signal.
+
<!-- ##### ENUM AtkTextBoundary ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL AtkText::text-attributes-changed ##### -->
-<para>
-The "text-attributes-changed" signal is emitted when the text attributes of
-the text of an object which implements AtkText changes.
-</para>
-
-@atktext: the object which received the signal.
-
-<!-- ##### SIGNAL AtkText::text-caret-moved ##### -->
-<para>
-The "text-caret-moved" signal is emitted when the caret position of
-the text of an object which implements AtkText changes.
-</para>
-
-@atktext: the object which received the signal.
-@arg1: The new position of the text caret.
-
-<!-- ##### SIGNAL AtkText::text-changed ##### -->
-<para>
-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
-</para>
-
-@atktext: the object which received the signal.
-@arg1: The position of the insertion or deletion.
-@arg2: The length of text inserted or deleted.
-
-<!-- ##### SIGNAL AtkText::text-selection-changed ##### -->
-<para>
-The "text-selection-changed" signal is emitted when the selected text of
-an object which implements AtkText changes.
-
-</para>
-
-@atktext: the object which received the signal.
-
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkValue ##### -->
<para>
The AtkValue structure does not contain any fields.
projects / platform / upstream / atk.git / commitdiff