Add property accessible-table-caption-object. This addresses bug #74814.

[platform/upstream/atk.git] / docs / tmpl / atkobject.sgml

diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml
index 6f7eda5..1dee081 100644 (file)
--- a/docs/tmpl/atkobject.sgml
+++ b/docs/tmpl/atkobject.sgml
@@ -33,15 +33,13 @@ See also: #AtkObjectFactory, #AtkRegistry.
 
 <!-- ##### STRUCT AtkObject ##### -->
 <para>
+The AtkObject structure should not be accessed directly.
 
 </para>
 
 
 <!-- ##### 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: 
@@ -113,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 ##### -->
@@ -126,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: 
@@ -138,31 +138,25 @@ determinations of when components occlude one another.
 @ATK_LAYER_MDI: 
 @ATK_LAYER_POPUP: 
 @ATK_LAYER_OVERLAY: 
+@ATK_LAYER_WINDOW: 
 
 <!-- ##### STRUCT AtkImplementor ##### -->
 <para>
-
-</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 ##### -->
-<para>
+The AtkImplementor structure does not contain any fields.
 
 </para>
 
 
 <!-- ##### 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>
 
@@ -172,6 +166,8 @@ provides ATK functionality.
 
 <!-- ##### 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>
 
@@ -181,7 +177,8 @@ provides ATK functionality.
 
 <!-- ##### 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,6 +417,14 @@ 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
@@ -432,42 +468,42 @@ This signal support, which may be any of the accessible state types.
 
 @atkobject: the object which received the signal.
 
-<!-- ##### ARG AtkObject:accessible-name ##### -->
+<!-- ##### ARG AtkObject:accessible-component-layer ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-description ##### -->
+<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-parent ##### -->
+<!-- ##### ARG AtkObject:accessible-description ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-value ##### -->
+<!-- ##### ARG AtkObject:accessible-name ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-role ##### -->
+<!-- ##### ARG AtkObject:accessible-parent ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-component-layer ##### -->
+<!-- ##### ARG AtkObject:accessible-role ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
+<!-- ##### ARG AtkObject:accessible-table-caption ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG AtkObject:accessible-table-caption ##### -->
+<!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
 <para>
 
 </para>
@@ -497,3 +533,8 @@ This signal support, which may be any of the accessible state types.
 
 </para>
 
+<!-- ##### ARG AtkObject:accessible-value ##### -->
+<para>
+
+</para>
+