diff options
author | Padraig O'Briain <padraigo@src.gnome.org> | 2002-06-20 08:29:33 +0000 |
---|---|---|
committer | Padraig O'Briain <padraigo@src.gnome.org> | 2002-06-20 08:29:33 +0000 |
commit | ef4fa5802b67f612ead021178ddd9b60687c63a7 (patch) | |
tree | 01250bd5d0f40f37cfe7e7f379bd99b94a6e3827 /docs | |
parent | 71c9d436d433643ccc1616cbf9b6a0547bc57cdb (diff) | |
download | atk-ef4fa5802b67f612ead021178ddd9b60687c63a7.tar.gz |
atk/atkutil.h atk/docs/atk-docs.sgml atk/docs/tmpl/atk-component.sgml
* atk/atkutil.h atk/docs/atk-docs.sgml atk/docs/tmpl/atk-component.sgml
atk/docs/atkdocument.sgml atk/docs/tmpl/atkeditabletext.sgml
atk/docs/tmpl/atkgobjectaccessible.sgml atk/docs/tmpl/atkhyperlink.sgml
atk/docs/tmpl/atkhypertext.sgml atk/docs/tmpl/atkimage.sgml
atk/docs/atknoopobject.sgml atk/docs/tmpl/atknoopobjectfactory.sgml
atk/docs/tmpl/atkobjectfactory.sgml atk/docs/tmpl/atkregistry.sgml
atk/docs/tmpl/atkregistry.sgml atk/docs/tmpl/atkrelationset.sgml
atk/docs/tmpl/atkselection.sgml atk/docs/tmpl/atkstate.sgml
atk/docs/tmpl/atkstateset.sgml atk/docs/tmpl/atkstreamablecontent.sgml
atk/docs/tmpl/atktable.sgml atk/docs/tmpl/atktext.sgml
atk/docs/tmpl/atkutil.sgml atk/docs/tmpl/atkvalue.sgml
Update documentation.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/atk-docs.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkcomponent.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkdocument.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atkeditabletext.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkgobjectaccessible.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atkhyperlink.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atkhypertext.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkimage.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atknoopobject.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atknoopobjectfactory.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atkobjectfactory.sgml | 10 | ||||
-rw-r--r-- | docs/tmpl/atkregistry.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkrelation.sgml | 7 | ||||
-rw-r--r-- | docs/tmpl/atkrelationset.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkselection.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkstate.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atkstateset.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atkstreamablecontent.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atktable.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atktext.sgml | 2 | ||||
-rw-r--r-- | docs/tmpl/atkutil.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atkvalue.sgml | 2 |
22 files changed, 59 insertions, 27 deletions
diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml index 07773dc..3345b41 100644 --- a/docs/atk-docs.sgml +++ b/docs/atk-docs.sgml @@ -3,6 +3,7 @@ <!entity atk-AtkComponent SYSTEM "sgml/atkcomponent.sgml"> <!entity atk-AtkDocument SYSTEM "sgml/atkdocument.sgml"> <!entity atk-AtkEditabletext SYSTEM "sgml/atkeditabletext.sgml"> +<!entity atk-AtkGObjectAccessible SYSTEM "sgml/atkgobjectaccessible.sgml"> <!entity atk-AtkHyperlink SYSTEM "sgml/atkhyperlink.sgml"> <!entity atk-AtkHypertext SYSTEM "sgml/atkhypertext.sgml"> <!entity atk-AtkImage SYSTEM "sgml/atkimage.sgml"> @@ -34,6 +35,7 @@ &atk-AtkComponent; &atk-AtkDocument; &atk-AtkEditabletext; + &atk-AtkGObjectAccessible; &atk-AtkHyperlink; &atk-AtkHypertext; &atk-AtkImage; diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index 3113221..f5ae969 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -2,7 +2,7 @@ AtkComponent <!-- ##### SECTION Short_Description ##### --> -ATK Interface provided by UI components which occupy a physical area on +The ATK interface provided by UI components which occupy a physical area on the screen. <!-- ##### SECTION Long_Description ##### --> diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml index 4a7bb0e..a344719 100644 --- a/docs/tmpl/atkdocument.sgml +++ b/docs/tmpl/atkdocument.sgml @@ -2,11 +2,13 @@ AtkDocument <!-- ##### SECTION Short_Description ##### --> - +The ATK interface which allows access to a DOM associated with on object. <!-- ##### SECTION Long_Description ##### --> <para> - +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. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml index 7c1f44d..609d9c9 100644 --- a/docs/tmpl/atkeditabletext.sgml +++ b/docs/tmpl/atkeditabletext.sgml @@ -2,7 +2,7 @@ AtkEditableText <!-- ##### SECTION Short_Description ##### --> -ATK Interface implemented by components containing user-editable text content. +The ATK interface implemented by components containing user-editable text content. <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/tmpl/atkgobjectaccessible.sgml b/docs/tmpl/atkgobjectaccessible.sgml index 9925450..de94f7a 100644 --- a/docs/tmpl/atkgobjectaccessible.sgml +++ b/docs/tmpl/atkgobjectaccessible.sgml @@ -2,10 +2,16 @@ AtkGObjectAccessible <!-- ##### SECTION Short_Description ##### --> +This object class is derived from AtkObject and can be used as a basis +implementing accessible objects. <!-- ##### SECTION Long_Description ##### --> <para> +This object class is derived from AtkObject. It can be used as a basis for +implementing accessible objects for GObjects which are not derived from +GtkWidget. One example of its use is in providing an accessible object +for GnomeCanvasItem in the GAIL library. </para> diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml index 6a55e80..198a13c 100644 --- a/docs/tmpl/atkhyperlink.sgml +++ b/docs/tmpl/atkhyperlink.sgml @@ -2,11 +2,12 @@ AtkHyperlink <!-- ##### SECTION Short_Description ##### --> - +An ATK object which encapsulates a link or set of links in a hypertext document. <!-- ##### SECTION Long_Description ##### --> <para> - +An ATK object which encapsulates a link or set of links in a hypertext document. +It implements the AtkAction interface. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml index ff6a5fe..9a4a1e2 100644 --- a/docs/tmpl/atkhypertext.sgml +++ b/docs/tmpl/atkhypertext.sgml @@ -2,7 +2,7 @@ AtkHypertext <!-- ##### SECTION Short_Description ##### --> - +The ATK interface which provides standard mechanism for manipulating hyperlinks. <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/tmpl/atkimage.sgml b/docs/tmpl/atkimage.sgml index 749bc09..1e5c709 100644 --- a/docs/tmpl/atkimage.sgml +++ b/docs/tmpl/atkimage.sgml @@ -2,7 +2,7 @@ AtkImage <!-- ##### SECTION Short_Description ##### --> -ATK Interface implemented by components which expose image or pixmap +The ATK Interface implemented by components which expose image or pixmap content on-screen. <!-- ##### SECTION Long_Description ##### --> diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml index 05f545e..cab81a0 100644 --- a/docs/tmpl/atknoopobject.sgml +++ b/docs/tmpl/atknoopobject.sgml @@ -2,11 +2,13 @@ AtkNoOpObject <!-- ##### SECTION Short_Description ##### --> - +An AtkObject which purports to implement all ATK interfaces. <!-- ##### SECTION Long_Description ##### --> <para> - +An AtkNoOpObject is an AtkObject which purports to implement all ATK +interfaces. It is the type of AtkObject which is created if an accessible +object is requested for an object type for which no factory type is specified. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml index ccac1bb..e49db92 100644 --- a/docs/tmpl/atknoopobjectfactory.sgml +++ b/docs/tmpl/atknoopobjectfactory.sgml @@ -2,11 +2,13 @@ AtkNoOpObjectFactory <!-- ##### SECTION Short_Description ##### --> - +The AtkObjectFactory which creates an AtkNoOpObject. <!-- ##### SECTION Long_Description ##### --> <para> - +The AtkObjectFactory which creates an AtkNoOpObject. An instance of this is +created by an AtkRegistry if no factory type has not been specified to +create an accessible object of a particular type. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml index 4f4eb38..fa8134b 100644 --- a/docs/tmpl/atkobjectfactory.sgml +++ b/docs/tmpl/atkobjectfactory.sgml @@ -2,15 +2,21 @@ AtkObjectFactory <!-- ##### SECTION Short_Description ##### --> - +The base object class for a factory used to create accessible objects for +objects of a specific GType. <!-- ##### SECTION Long_Description ##### --> <para> - +This class is the base object class for a factory used to create an +accessible object for a specific GType. The function +atk_registry_set_factory_type() is normally called to store +in the registry the factory type to be used to create an accessible of a +particular GType. </para> <!-- ##### SECTION See_Also ##### --> <para> +AtkRegistry </para> diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml index b561a11..3caa019 100644 --- a/docs/tmpl/atkregistry.sgml +++ b/docs/tmpl/atkregistry.sgml @@ -2,7 +2,8 @@ AtkRegistry <!-- ##### SECTION Short_Description ##### --> - +An object used to store the GType of a factory used to create an accessible +object for an object of a particluar GType. <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index f0041ae..b841c40 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -2,10 +2,15 @@ AtkRelation <!-- ##### SECTION Short_Description ##### --> - +An object usaed to describe a relation between a object and one or more +other objects. <!-- ##### SECTION Long_Description ##### --> <para> +An AtkRelation describes a relation between the 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. + </para> diff --git a/docs/tmpl/atkrelationset.sgml b/docs/tmpl/atkrelationset.sgml index b04560d..deef40a 100644 --- a/docs/tmpl/atkrelationset.sgml +++ b/docs/tmpl/atkrelationset.sgml @@ -2,7 +2,7 @@ AtkRelationSet <!-- ##### SECTION Short_Description ##### --> - +A set of AtkRelations, normally the set of AtkRelations which an AtkObject has. <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index d1daf2c..b321184 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -3,7 +3,7 @@ AtkSelection <!-- ##### SECTION Short_Description ##### --> -ATK Interface implemented by container objects whose #AtkObject children +The ATK interface implemented by container objects whose #AtkObject children can be selected. <!-- ##### SECTION Long_Description ##### --> diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml index e29a4da..2dcf68b 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -2,11 +2,12 @@ AtkState <!-- ##### SECTION Short_Description ##### --> - +An AtkState describes a component's particular state. <!-- ##### SECTION Long_Description ##### --> <para> - +An AtkState describes a component's particular state. The actual state of +an component is described by its AtkStateSet, which is a set of AtkStates. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkstateset.sgml b/docs/tmpl/atkstateset.sgml index 08afaa7..c06bd66 100644 --- a/docs/tmpl/atkstateset.sgml +++ b/docs/tmpl/atkstateset.sgml @@ -2,11 +2,12 @@ AtkStateSet <!-- ##### SECTION Short_Description ##### --> - +An AtkStateSet determines a component's state set. <!-- ##### SECTION Long_Description ##### --> <para> - +An AtkStateSet determines a component's state set. It is composed of a set +of AtkStates. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkstreamablecontent.sgml b/docs/tmpl/atkstreamablecontent.sgml index ee4d96c..8d52d49 100644 --- a/docs/tmpl/atkstreamablecontent.sgml +++ b/docs/tmpl/atkstreamablecontent.sgml @@ -2,7 +2,7 @@ AtkStreamableContent <!-- ##### SECTION Short_Description ##### --> - +The ATK interface which provides access to streamable content. <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index c591e4e..d7ad300 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -2,7 +2,7 @@ AtkTable <!-- ##### SECTION Short_Description ##### --> -ATK Interface implemented for UI components which contain tabular or +The ATK interface implemented for UI components which contain tabular or row/column information. <!-- ##### SECTION Long_Description ##### --> diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index 4c64847..3001200 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -2,7 +2,7 @@ AtkText <!-- ##### SECTION Short_Description ##### --> -ATK Interface provided by components with text content. +The ATK interface implemented by components with text content. <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index fd370eb..6ce5e0c 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -2,10 +2,13 @@ AtkUtil <!-- ##### SECTION Short_Description ##### --> - +This is a utility class which supports the adding and removal of event listeners. <!-- ##### SECTION Long_Description ##### --> <para> +This is a utility class which supports the adding and removal of event +listeners. The adding and removing of the listeners must be done in the +same thread. The file also contains a number of utility functions. </para> diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml index 0e17efd..0dc59a3 100644 --- a/docs/tmpl/atkvalue.sgml +++ b/docs/tmpl/atkvalue.sgml @@ -2,7 +2,7 @@ AtkValue <!-- ##### SECTION Short_Description ##### --> -ATK Interface implemented by valuators and components which display or +The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. <!-- ##### SECTION Long_Description ##### --> |