Add property accessible-table-caption-object. This addresses bug #74814.
[platform/upstream/atk.git] / docs / tmpl / atkobject.sgml
index bdcffdf..1dee081 100644 (file)
@@ -33,22 +33,13 @@ See also: #AtkObjectFactory, #AtkRegistry.
 
 <!-- ##### STRUCT AtkObject ##### -->
 <para>
+The AtkObject structure should not be accessed directly.
 
 </para>
 
-@parent: 
-@description: 
-@name: 
-@accessible_parent: 
-@role: 
-@relation_set: 
-@layer: 
 
 <!-- ##### ENUM AtkRole ##### -->
 <para>
-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.
 </para>
 
 @ATK_ROLE_INVALID: 
@@ -120,6 +111,11 @@ ATK_ROLE_LAST_DEFINED is not necessarily an error.
 @ATK_ROLE_UNKNOWN: 
 @ATK_ROLE_VIEWPORT: 
 @ATK_ROLE_WINDOW: 
+@ATK_ROLE_HEADER: 
+@ATK_ROLE_FOOTER: 
+@ATK_ROLE_PARAGRAPH: 
+@ATK_ROLE_RULER: 
+@ATK_ROLE_APPLICATION: 
 @ATK_ROLE_LAST_DEFINED: 
 
 <!-- ##### FUNCTION atk_role_register ##### -->
@@ -133,9 +129,6 @@ ATK_ROLE_LAST_DEFINED is not necessarily an error.
 
 <!-- ##### ENUM AtkLayer ##### -->
 <para>
-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.
 </para>
 
 @ATK_LAYER_INVALID: 
@@ -145,43 +138,47 @@ determinations of when components occlude one another.
 @ATK_LAYER_MDI: 
 @ATK_LAYER_POPUP: 
 @ATK_LAYER_OVERLAY: 
+@ATK_LAYER_WINDOW: 
 
 <!-- ##### STRUCT AtkImplementor ##### -->
 <para>
+The AtkImplementor structure does not contain any fields.
 
 </para>
 
 
-<!-- ##### STRUCT AtkImplementorIface ##### -->
-<para>
-This interface provides an alternative means of obtaining AtkObjects
-from a GOBject instance, and for querying whether a GObject instance
-provides ATK functionality.
-</para>
-
-@parent: 
-@ref_accessible: 
-
-<!-- ##### STRUCT AtkRelationSet ##### -->
+<!-- ##### STRUCT AtkPropertyValues ##### -->
 <para>
+The Atk PropertyValue structure is used when notifying a change in property.
+Currently, the only property for which old_value is used is
+accessible-state; for instance if there is a focus change the
+property change handler will be called for the object which lost the focus
+with the old_value containing the AtkState value corresponding to focused
+and the property change handler will be called for the object which
+received the focus with the new_value containing the AtkState value
+corresponding to focused.
 
 </para>
 
-@parent: 
-@relations: 
+@property_name: 
+@old_value: 
+@new_value: 
 
-<!-- ##### STRUCT AtkPropertyValues ##### -->
+<!-- ##### USER_FUNCTION AtkFunction ##### -->
 <para>
+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.
 
 </para>
 
-@property_name
-@old_value
-@new_value: 
+@data
+@Returns
+
 
 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
 <para>
-
+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().
 </para>
 
 @Param1: 
@@ -371,6 +368,28 @@ provides ATK functionality.
 @data: 
 
 
+<!-- ##### FUNCTION atk_object_add_relationship ##### -->
+<para>
+
+</para>
+
+@object: 
+@relationship: 
+@target: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_object_remove_relationship ##### -->
+<para>
+
+</para>
+
+@object: 
+@relationship: 
+@target: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_role_get_name ##### -->
 <para>
 
@@ -380,6 +399,15 @@ provides ATK functionality.
 @Returns: 
 
 
+<!-- ##### FUNCTION atk_role_get_localized_name ##### -->
+<para>
+
+</para>
+
+@role: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_role_for_name ##### -->
 <para>
 
@@ -389,3 +417,124 @@ provides ATK functionality.
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
+<para>
+
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL AtkObject::children-changed ##### -->
+<para>
+The children_changed signal supports two details, "add" and "remove" which
+indicate whether a child was added or removed
+</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>
+
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: A boolean value which indicates whether or not the focus event is is or out.
+
+<!-- ##### SIGNAL AtkObject::property-change ##### -->
+<para>
+This signal support a detail which identifies the property which has
+changed.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The new value of the property which changed.
+
+<!-- ##### SIGNAL AtkObject::state-change ##### -->
+<para>
+This signal support, which may be any of the accessible state types.
+</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>
+
+</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-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>
+