diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 17 | ||||
-rw-r--r-- | docs/atk.types | 25 | ||||
-rw-r--r-- | docs/tmpl/atkgobjectaccessible.sgml | 1 | ||||
-rw-r--r-- | docs/tmpl/atkhyperlink.sgml | 1 | ||||
-rw-r--r-- | docs/tmpl/atknoopobject.sgml | 1 | ||||
-rw-r--r-- | docs/tmpl/atknoopobjectfactory.sgml | 1 | ||||
-rw-r--r-- | docs/tmpl/atkobject.sgml | 117 | ||||
-rw-r--r-- | docs/tmpl/atkobjectfactory.sgml | 1 | ||||
-rw-r--r-- | docs/tmpl/atkregistry.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkrelation.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkselection.sgml | 7 | ||||
-rw-r--r-- | docs/tmpl/atktable.sgml | 57 | ||||
-rw-r--r-- | docs/tmpl/atktext.sgml | 25 | ||||
-rw-r--r-- | docs/tmpl/atkutil.sgml | 1 |
14 files changed, 239 insertions, 21 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 1218321..b85551b 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -27,6 +27,23 @@ content_files = # Other files to distribute extra_files = +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +GTKDOC_CFLAGS = @STRIP_BEGIN@ \ + @CFLAGS@ \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + @DEP_CFLAGS@ \ +@STRIP_END@ + +GTKDOC_LIBS = @STRIP_BEGIN@ \ + $(top_builddir)/atk/@atktargetlib@ \ +@STRIP_END@ + +GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) + + dist-hook-local: all-local #################################### diff --git a/docs/atk.types b/docs/atk.types index e69de29..a219397 100644 --- a/docs/atk.types +++ b/docs/atk.types @@ -0,0 +1,25 @@ +#include <atk/atk.h> + +atk_action_get_type +atk_component_get_type +atk_document_get_type +atk_editable_text_get_type +atk_gobject_accessible_get_type +atk_hyperlink_get_type +atk_hypertext_get_type +atk_image_get_type +atk_implementor_get_type +atk_no_op_object_get_type +atk_no_op_object_factory_get_type +atk_object_get_type +atk_object_factory_get_type +atk_registry_get_type +atk_relation_get_type +atk_relation_set_get_type +atk_selection_get_type +atk_state_set_get_type +atk_streamable_content_get_type +atk_table_get_type +atk_text_get_type +atk_util_get_type +atk_value_get_type diff --git a/docs/tmpl/atkgobjectaccessible.sgml b/docs/tmpl/atkgobjectaccessible.sgml index 0c174c5..f3d2073 100644 --- a/docs/tmpl/atkgobjectaccessible.sgml +++ b/docs/tmpl/atkgobjectaccessible.sgml @@ -24,7 +24,6 @@ for GnomeCanvasItem in the GAIL library. </para> -@parent: <!-- ##### FUNCTION atk_gobject_accessible_for_object ##### --> <para> diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml index 198a13c..40cbfe7 100644 --- a/docs/tmpl/atkhyperlink.sgml +++ b/docs/tmpl/atkhyperlink.sgml @@ -20,7 +20,6 @@ It implements the AtkAction interface. </para> -@parent: <!-- ##### FUNCTION atk_hyperlink_get_uri ##### --> <para> diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml index cab81a0..8ada5fa 100644 --- a/docs/tmpl/atknoopobject.sgml +++ b/docs/tmpl/atknoopobject.sgml @@ -21,7 +21,6 @@ object is requested for an object type for which no factory type is specified. </para> -@parent: <!-- ##### FUNCTION atk_no_op_object_new ##### --> <para> diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml index e49db92..5d5299f 100644 --- a/docs/tmpl/atknoopobjectfactory.sgml +++ b/docs/tmpl/atknoopobjectfactory.sgml @@ -21,7 +21,6 @@ create an accessible object of a particular type. </para> -@parent: <!-- ##### FUNCTION atk_no_op_object_factory_new ##### --> <para> diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index e823bf0..6f7eda5 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -36,13 +36,6 @@ See also: #AtkObjectFactory, #AtkRegistry. </para> -@parent: -@description: -@name: -@accessible_parent: -@role: -@relation_set: -@layer: <!-- ##### ENUM AtkRole ##### --> <para> @@ -167,8 +160,6 @@ provides ATK functionality. </para> -@parent: -@relations: <!-- ##### STRUCT AtkPropertyValues ##### --> <para> @@ -398,3 +389,111 @@ provides ATK functionality. @Returns: +<!-- ##### 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-name ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-description ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-parent ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-value ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-role ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-component-layer ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-caption ##### --> +<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> + diff --git a/docs/tmpl/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml index fa8134b..7bd7acb 100644 --- a/docs/tmpl/atkobjectfactory.sgml +++ b/docs/tmpl/atkobjectfactory.sgml @@ -25,7 +25,6 @@ AtkRegistry </para> -@parent: <!-- ##### FUNCTION atk_object_factory_create_accessible ##### --> <para> diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml index 3caa019..99ac0bc 100644 --- a/docs/tmpl/atkregistry.sgml +++ b/docs/tmpl/atkregistry.sgml @@ -20,9 +20,6 @@ object for an object of a particluar GType. </para> -@parent: -@factory_type_registry: -@factory_singleton_cache: <!-- ##### FUNCTION atk_registry_set_factory_type ##### --> <para> diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index b841c40..44611d9 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -24,9 +24,6 @@ are defined as an AtkRelationSet, which is a set of AtkRelations. </para> -@parent: -@target: -@relationship: <!-- ##### ENUM AtkRelationType ##### --> <para> diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index b321184..148e0f2 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -115,3 +115,10 @@ selection/deselection of children. @Returns: +<!-- ##### SIGNAL AtkSelection::selection-changed ##### --> +<para> + +</para> + +@atkselection: the object which received the signal. + diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index d7ad300..cdd2c15 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -383,3 +383,60 @@ implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate. @Returns: +<!-- ##### SIGNAL AtkTable::column-deleted ##### --> +<para> + +</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> + +</para> + +@atktable: the object which received the signal. +@arg1: The index of the column inserted. +@arg2: The number of colums inserteda. + +<!-- ##### SIGNAL AtkTable::column-reordered ##### --> +<para> + +</para> + +@atktable: the object which received the signal. + +<!-- ##### SIGNAL AtkTable::model-changed ##### --> +<para> + +</para> + +@atktable: the object which received the signal. + +<!-- ##### SIGNAL AtkTable::row-deleted ##### --> +<para> + +</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> + +</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> + +</para> + +@atktable: the object which received the signal. + diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index 3001200..25f1c28 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -366,3 +366,28 @@ glyph-to-offset mapping may be complex for languages which use ligatures. @Returns: +<!-- ##### SIGNAL AtkText::text-caret-moved ##### --> +<para> + +</para> + +@atktext: the object which received the signal. +@arg1: The new position of the text caret. + +<!-- ##### SIGNAL AtkText::text-changed ##### --> +<para> +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> + +</para> + +@atktext: the object which received the signal. + diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index 6ce5e0c..d15e314 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -22,7 +22,6 @@ same thread. The file also contains a number of utility functions. </para> -@parent: <!-- ##### ENUM AtkCoordType ##### --> <para> |