From b4705a4e003191d84043be8e7c27a2a3a34472e2 Mon Sep 17 00:00:00 2001 From: Padraig O'Briain Date: Thu, 5 Sep 2002 12:49:21 +0000 Subject: [PATCH] Add documentation for AtkKeyEventType * atk/atkutil.h: Add documentation for AtkKeyEventType * docs/tmpl/action.sgml docs/tmpl/atkcomponent.sgml docs/tmpl/atkdocument.sgml docs/tmpl/atkeditabletext.sgml docs/tmpl/atkgobjectaccessible.sgml docs/tmpl/atkhyperlink.sgml docs/tmpl/atkhypertext.sgml docs/tmpl/atkimage.sgml docs/tmpl/atknoopobject.sgml docs/tmp[l/atknoopobjectfactory.sgml docs/tmpl/atkobject.sgml docs/tmpl/atkobjectfacory.sgml docs/tmpl/atkregistry.sgml docs/tmpl/atkrelation.sgml docs/tmpl/atkselection.sgml docs/tmpl/atkstate.sgml docs/tmpl/atkstreamablecontent.sgml docs/tmpl/atktable.sgml docs/tmpl/atktext.sml docs/tmpl/atkutil.sgml docs/tmpl/atkutil.sgml: Reduce number of undocumented symbols --- ChangeLog | 19 ++++++++++++++++++- atk/atkutil.h | 8 ++++++++ docs/tmpl/atkaction.sgml | 2 +- docs/tmpl/atkcomponent.sgml | 1 + docs/tmpl/atkdocument.sgml | 2 ++ docs/tmpl/atkeditabletext.sgml | 1 + docs/tmpl/atkgobjectaccessible.sgml | 2 +- docs/tmpl/atkhyperlink.sgml | 1 + docs/tmpl/atkhypertext.sgml | 2 +- docs/tmpl/atkimage.sgml | 1 + docs/tmpl/atknoopobject.sgml | 2 +- docs/tmpl/atknoopobjectfactory.sgml | 1 + docs/tmpl/atkobject.sgml | 18 ++++++++++++++++-- docs/tmpl/atkobjectfactory.sgml | 1 + docs/tmpl/atkregistry.sgml | 5 +++-- docs/tmpl/atkrelation.sgml | 5 +++-- docs/tmpl/atkselection.sgml | 1 + docs/tmpl/atkstate.sgml | 1 + docs/tmpl/atkstreamablecontent.sgml | 1 + docs/tmpl/atktable.sgml | 1 + docs/tmpl/atktext.sgml | 1 + docs/tmpl/atkutil.sgml | 12 +++++++++--- docs/tmpl/atkvalue.sgml | 1 + 23 files changed, 75 insertions(+), 14 deletions(-) diff --git a/ChangeLog b/ChangeLog index bd6983b..b49efa8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,20 @@ +2002-09-05 Padraig O'Briain + + * atk/atkutil.h: Add documentation for AtkKeyEventType + + * docs/tmpl/action.sgml docs/tmpl/atkcomponent.sgml + docs/tmpl/atkdocument.sgml docs/tmpl/atkeditabletext.sgml + docs/tmpl/atkgobjectaccessible.sgml docs/tmpl/atkhyperlink.sgml + docs/tmpl/atkhypertext.sgml docs/tmpl/atkimage.sgml + docs/tmpl/atknoopobject.sgml docs/tmp[l/atknoopobjectfactory.sgml + docs/tmpl/atkobject.sgml docs/tmpl/atkobjectfacory.sgml + docs/tmpl/atkregistry.sgml docs/tmpl/atkrelation.sgml + docs/tmpl/atkselection.sgml docs/tmpl/atkstate.sgml + docs/tmpl/atkstreamablecontent.sgml docs/tmpl/atktable.sgml + docs/tmpl/atktext.sml docs/tmpl/atkutil.sgml + docs/tmpl/atkutil.sgml: + Reduce number of undocumented symbols + 2002-08-26 Padraig O'Briain * atk/atknoopobjectfactory.c: @@ -17,7 +34,7 @@ information about properties and signals. * configure.in: - Add atktargetlibi, STRIP_BEGIN, STRIP_END and STRIP_DUMMY for + Add atktargetlib, STRIP_BEGIN, STRIP_END and STRIP_DUMMY for use in docs Makefile.am * atk/atk.h: diff --git a/atk/atkutil.h b/atk/atkutil.h index 771235c..7654156 100755 --- a/atk/atkutil.h +++ b/atk/atkutil.h @@ -60,6 +60,14 @@ struct _AtkKeyEventStruct { guint32 timestamp; }; +/** + *AtkKeyEventType: + *@ATK_KEY_EVENT_PRESS: specifies a key press event + *@ATK_KEY_EVENT_RELEASE: specifies a key release event + *@ATK_KEY_EVENT_LAST_DEFINED: Not a valid value; specifies end of enumeration + * + *Specifies the type of a keyboard evemt. + **/ typedef enum { ATK_KEY_EVENT_PRESS, diff --git a/docs/tmpl/atkaction.sgml b/docs/tmpl/atkaction.sgml index bc6692f..3e57cff 100644 --- a/docs/tmpl/atkaction.sgml +++ b/docs/tmpl/atkaction.sgml @@ -43,7 +43,7 @@ terminology for #AtkAction names. - +The AtkAction structure does not contain any fields. diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index f5ae969..0411d9e 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -27,6 +27,7 @@ provided by #AtkText. +The AtkComponent structure does not contain any fields. diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml index a344719..db9451f 100644 --- a/docs/tmpl/atkdocument.sgml +++ b/docs/tmpl/atkdocument.sgml @@ -18,6 +18,8 @@ standard mechanism allowing an assistive technology access to the DOM. +The AtkDocument structure does not contain any fields. + diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml index 609d9c9..229fa9f 100644 --- a/docs/tmpl/atkeditabletext.sgml +++ b/docs/tmpl/atkeditabletext.sgml @@ -22,6 +22,7 @@ implements #AtkEditableText is by definition an #AtkText implementor as well. +The AtkEditableText structure does not contain any fields. diff --git a/docs/tmpl/atkgobjectaccessible.sgml b/docs/tmpl/atkgobjectaccessible.sgml index f3d2073..460512b 100644 --- a/docs/tmpl/atkgobjectaccessible.sgml +++ b/docs/tmpl/atkgobjectaccessible.sgml @@ -21,7 +21,7 @@ for GnomeCanvasItem in the GAIL library. - +The AtkGObjectAccessible structure should not be accessed directly. diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml index 40cbfe7..6875c79 100644 --- a/docs/tmpl/atkhyperlink.sgml +++ b/docs/tmpl/atkhyperlink.sgml @@ -17,6 +17,7 @@ It implements the AtkAction interface. +The AtkHyperlink structure should not be accessed directly. diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml index 9a4a1e2..fd06f31 100644 --- a/docs/tmpl/atkhypertext.sgml +++ b/docs/tmpl/atkhypertext.sgml @@ -16,7 +16,7 @@ The ATK interface which provides standard mechanism for manipulating hyperlinks. - +The AtkHypertext structure does not contain any fields. diff --git a/docs/tmpl/atkimage.sgml b/docs/tmpl/atkimage.sgml index 1e5c709..c48c690 100644 --- a/docs/tmpl/atkimage.sgml +++ b/docs/tmpl/atkimage.sgml @@ -28,6 +28,7 @@ most significant information present in the image. +The AtkImage structure does not contain any fields. diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml index 8ada5fa..f0fc084 100644 --- a/docs/tmpl/atknoopobject.sgml +++ b/docs/tmpl/atknoopobject.sgml @@ -18,7 +18,7 @@ object is requested for an object type for which no factory type is specified. - +The AtkNoOpObject structure should not be accessed directly. diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml index 5d5299f..6733264 100644 --- a/docs/tmpl/atknoopobjectfactory.sgml +++ b/docs/tmpl/atknoopobjectfactory.sgml @@ -18,6 +18,7 @@ create an accessible object of a particular type. +The AtkNoOpObjectFactory structure should not be accessed directly. diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 6f7eda5..c62817e 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -33,6 +33,7 @@ See also: #AtkObjectFactory, #AtkRegistry. +The AtkObject structure should not be accessed directly. @@ -141,6 +142,7 @@ determinations of when components occlude one another. +The AtkImplementor structure does not contain any fields. @@ -148,7 +150,7 @@ determinations of when components occlude one another. This interface provides an alternative means of obtaining AtkObjects -from a GOBject instance, and for querying whether a GObject instance +from a GObject instance, and for querying whether a GObject instance provides ATK functionality. @@ -157,12 +159,21 @@ provides ATK functionality. +The AtkRelationSet structure should not be accessed directly. +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. @@ -172,6 +183,8 @@ provides ATK functionality. +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. @@ -181,7 +194,8 @@ provides ATK functionality. - +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(). @Param1: diff --git a/docs/tmpl/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml index 7bd7acb..63c56cf 100644 --- a/docs/tmpl/atkobjectfactory.sgml +++ b/docs/tmpl/atkobjectfactory.sgml @@ -22,6 +22,7 @@ AtkRegistry +The AtkObjectFactory structure should not be accessed directly. diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml index 99ac0bc..45098af 100644 --- a/docs/tmpl/atkregistry.sgml +++ b/docs/tmpl/atkregistry.sgml @@ -2,8 +2,8 @@ AtkRegistry -An object used to store the GType of a factory used to create an accessible -object for an object of a particluar GType. +An object used to store the GType of the factories used to create an accessible +object for an object of a particular GType. @@ -17,6 +17,7 @@ object for an object of a particluar GType. +The AtkRegistry structure should not be accessed directly. diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index 44611d9..dffe854 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -2,12 +2,12 @@ AtkRelation -An object usaed to describe a relation between a object and one or more +An object used to describe a relation between a object and one or more other objects. -An AtkRelation describes a relation between the object and one or more +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. @@ -21,6 +21,7 @@ are defined as an AtkRelationSet, which is a set of AtkRelations. +The AtkRelation structure should not be accessed directly. diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index 148e0f2..2075fb9 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -27,6 +27,7 @@ selection/deselection of children. +The AtkAction structure does not contain any fields. diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml index 2dcf68b..a2bc71e 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -53,6 +53,7 @@ an component is described by its AtkStateSet, which is a set of AtkStates. +The AtkState value should not be referenceed directly. diff --git a/docs/tmpl/atkstreamablecontent.sgml b/docs/tmpl/atkstreamablecontent.sgml index 8d52d49..9851f55 100644 --- a/docs/tmpl/atkstreamablecontent.sgml +++ b/docs/tmpl/atkstreamablecontent.sgml @@ -16,6 +16,7 @@ The ATK interface which provides access to streamable content. +The AtkStreamableContent structure does not contain any fields. diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index cdd2c15..dbd9227 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -35,6 +35,7 @@ implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate. +The AtkTable structure does not contain any fields. diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index 25f1c28..1b1f758 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -33,6 +33,7 @@ glyph-to-offset mapping may be complex for languages which use ligatures. +The AtkText structure does not contain any fields. diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index d15e314..334a43f 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -19,6 +19,7 @@ same thread. The file also contains a number of utility functions. +The AtkObject structure should not be accessed directly. @@ -66,7 +67,9 @@ same thread. The file also contains a number of utility functions. - +An AtkEventListener is user specified function which is called when an event, +such as receiving focus, occurs. The parameter of the AtkEventListener is the +AtkObject on which the event occurred. @Param1: @@ -74,6 +77,9 @@ same thread. The file also contains a number of utility functions. +An AtkEventListenerInit is an initialization function in an implementation +of the ATK interface used to perform implementation-specific initialization +when enabling focus tracking. @@ -99,7 +105,7 @@ same thread. The file also contains a number of utility functions. - +The AtkKeyEventStruct describes a keyboard event. @type: @@ -121,7 +127,7 @@ same thread. The file also contains a number of utility functions. - +An AtkKeySnoopFunc is a function which is called when a keyboard event occurs. @event: diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml index 0dc59a3..14ac1c0 100644 --- a/docs/tmpl/atkvalue.sgml +++ b/docs/tmpl/atkvalue.sgml @@ -23,6 +23,7 @@ indicate failure. +The AtkValue structure does not contain any fields. -- 2.7.4