diff options
author | Padraig O'Briain <padraigo@src.gnome.org> | 2001-11-22 15:58:58 +0000 |
---|---|---|
committer | Padraig O'Briain <padraigo@src.gnome.org> | 2001-11-22 15:58:58 +0000 |
commit | 904c325f06e97a4c2cf376f294b95bc23d0793d8 (patch) | |
tree | e7f4534e104092ab64ac96a8cf058fa982493323 /docs | |
parent | 77626512f3d262bf2eb3986f5d42cb567184554d (diff) | |
download | atk-904c325f06e97a4c2cf376f294b95bc23d0793d8.tar.gz |
Change atk_relation_type_from_string to atk_relation_type_for_name Add
* atk/atk.def, atk/atkrelationtype.h, docs/atk-sections.txt,
docs/tmpl/atkrelation.sgml:
Change atk_relation_type_from_string to atk_relation_type_for_name
Add atk_relation_type_get_name
* atk/atkrelationtype.c:
Change atk_relation_type_from_string to atk_relation_type_for_name
Add atk_relation_type_get_name
Update atk_relation_type_register() to correctly register new
relation types
* atk/atkstate.c:
Changed name of static variable type to last_type
Changed name of paremeter if atk_state_type_get_name to type to match
comments
* docs/tmpl/*sgml
Updated files
* tests/README, tests/Makefile.am
Add new test file testrelation.c
Diffstat (limited to 'docs')
-rw-r--r-- | docs/atk-sections.txt | 3 | ||||
-rw-r--r-- | docs/tmpl/atk-unused.sgml | 182 | ||||
-rw-r--r-- | docs/tmpl/atkaction.sgml | 8 | ||||
-rw-r--r-- | docs/tmpl/atkcomponent.sgml | 7 | ||||
-rw-r--r-- | docs/tmpl/atkeditabletext.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atkhypertext.sgml | 9 | ||||
-rw-r--r-- | docs/tmpl/atkimage.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atknoopobject.sgml | 4 | ||||
-rw-r--r-- | docs/tmpl/atknoopobjectfactory.sgml | 4 | ||||
-rw-r--r-- | docs/tmpl/atkobject.sgml | 11 | ||||
-rw-r--r-- | docs/tmpl/atkobjectfactory.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkregistry.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkrelation.sgml | 15 | ||||
-rw-r--r-- | docs/tmpl/atkrelationset.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atkselection.sgml | 8 | ||||
-rw-r--r-- | docs/tmpl/atkstate.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atkstateset.sgml | 6 | ||||
-rw-r--r-- | docs/tmpl/atkstreamablecontent.sgml | 5 | ||||
-rw-r--r-- | docs/tmpl/atktable.sgml | 8 | ||||
-rw-r--r-- | docs/tmpl/atktext.sgml | 11 | ||||
-rw-r--r-- | docs/tmpl/atkutil.sgml | 4 | ||||
-rw-r--r-- | docs/tmpl/atkvalue.sgml | 10 |
22 files changed, 45 insertions, 278 deletions
diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt index c65deff..c2f5474 100644 --- a/docs/atk-sections.txt +++ b/docs/atk-sections.txt @@ -227,7 +227,8 @@ ATK_REGISTRY_GET_CLASS AtkRelation AtkRelationType atk_relation_type_register -atk_relation_type_from_string +atk_relation_type_get_name +atk_relation_type_for_name atk_relation_new atk_relation_get_relation_type atk_relation_get_target diff --git a/docs/tmpl/atk-unused.sgml b/docs/tmpl/atk-unused.sgml index 4ca20da..e69de29 100644 --- a/docs/tmpl/atk-unused.sgml +++ b/docs/tmpl/atk-unused.sgml @@ -1,182 +0,0 @@ -<!-- ##### SECTION ./tmpl/atk.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/atk.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/atk.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/atk.sgml:Title ##### --> -atk - - -<!-- ##### MACRO ATK_ATTRIBUTE_BG_COLOR ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_BG_FULL_HEIGHT ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_BG_STIPPLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_DIRECTION ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_EDITABLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_FAMILY_NAME ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_FG_COLOR ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_FG_STIPPLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_INDENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_INVISIBLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_JUSTIFICATION ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_LANGUAGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_LEFT_MARGIN ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_PIXELS_ABOVE_LINES ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_PIXELS_BELOW_LINES ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_PIXELS_INSIDE_WRAP ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_RIGHT_MARGIN ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_RISE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_SCALE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_SIZE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_STRETCH ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_STRIKETHROUGH ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_STYLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_UNDERLINE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_VARIANT ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_WEIGHT ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATK_ATTRIBUTE_WRAP_MODE ##### --> -<para> - -</para> - - diff --git a/docs/tmpl/atkaction.sgml b/docs/tmpl/atkaction.sgml index f744c7d..668cdb9 100644 --- a/docs/tmpl/atkaction.sgml +++ b/docs/tmpl/atkaction.sgml @@ -2,15 +2,11 @@ AtkAction <!-- ##### SECTION Short_Description ##### --> -accessibility interface for objects that can perform actions + <!-- ##### SECTION Long_Description ##### --> <para> -The interface AtkAction should be supported by any object that can -perform one or more actions. The interface provides the standard -mechanism for an assistive technology to determine what those actions -are as well as tell the object to perform them. Any object that can -be manipulated should support this interface. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index bde93a5..046d8d4 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -2,14 +2,11 @@ AtkComponent <!-- ##### SECTION Short_Description ##### --> -accessibility interface for objects that are rendered on the screen + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkComponent interface should be supported by any object that is -rendered on the screen. The interface provides the standard mechanism -for an assistive technology to determine and set the graphical -representation of an object. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml index 1f9d147..c577880 100644 --- a/docs/tmpl/atkeditabletext.sgml +++ b/docs/tmpl/atkeditabletext.sgml @@ -2,12 +2,11 @@ AtkEditableText <!-- ##### SECTION Short_Description ##### --> -accessibility interface for editable text widgets + <!-- ##### SECTION Long_Description ##### --> <para> -AtkEditableText is used to support access in an "accessibility" context -to editing features of editable text widgets. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml index f410f78..f96dbbf 100644 --- a/docs/tmpl/atkhypertext.sgml +++ b/docs/tmpl/atkhypertext.sgml @@ -2,16 +2,11 @@ AtkHypertext <!-- ##### SECTION Short_Description ##### --> -the base class for all classes that present hypertext information -on the display + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkHypertext class is the base class for all classes that present -hypertext information on the display. This class provides the standard -mechanism for an assistive technology to access that text via its -content, attributes, and spatial location. It also provides standard -mechanisms for manipulating hyperlinks. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkimage.sgml b/docs/tmpl/atkimage.sgml index 8d0a6bc..e6558cc 100644 --- a/docs/tmpl/atkimage.sgml +++ b/docs/tmpl/atkimage.sgml @@ -2,13 +2,11 @@ AtkImage <!-- ##### SECTION Short_Description ##### --> -accessibility interface for objects that have an associated image + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkImage interface should be supported by any object that has an -associated image. This interface provides the standard mechanism for -an assistive technology to get descriptive information about images. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml index 2a6a21e..05f545e 100644 --- a/docs/tmpl/atknoopobject.sgml +++ b/docs/tmpl/atknoopobject.sgml @@ -2,11 +2,11 @@ AtkNoOpObject <!-- ##### SECTION Short_Description ##### --> -provides non-functioning stub #AtkObjects + <!-- ##### SECTION Long_Description ##### --> <para> -Provides non-functioning stub #AtkObjects. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml index 38c2c3e..ccac1bb 100644 --- a/docs/tmpl/atknoopobjectfactory.sgml +++ b/docs/tmpl/atknoopobjectfactory.sgml @@ -2,11 +2,11 @@ AtkNoOpObjectFactory <!-- ##### SECTION Short_Description ##### --> -an #AtkObjectFactory which creates non-functioning stub #AtkObjects + <!-- ##### SECTION Long_Description ##### --> <para> -An #AtkObjectFactory which creates non-functioning stub #AtkObjects. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 5c895d7..164a459 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -2,16 +2,11 @@ AtkObject <!-- ##### SECTION Short_Description ##### --> -represents the minimum information all accessible objects return + <!-- ##### SECTION Long_Description ##### --> <para> -AtkObject represents the minimum information all accessible objects -return. This information includes accessible name, accessible -description, role and state of the object, as well information about -its parent and children. It is also possible to obtain more specific -accessibility information about a component if it supports one or more -of the other ATK interfaces: + </para> <!-- ##### SECTION See_Also ##### --> @@ -250,8 +245,6 @@ of the other ATK interfaces: @accessible: @Returns: -<!-- # Unused Parameters # --> -@acessible: <!-- ##### FUNCTION atk_object_get_role ##### --> diff --git a/docs/tmpl/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml index 77b6827..740c1a9 100644 --- a/docs/tmpl/atkobjectfactory.sgml +++ b/docs/tmpl/atkobjectfactory.sgml @@ -2,11 +2,10 @@ AtkObjectFactory <!-- ##### SECTION Short_Description ##### --> -factory for creating #AtkObjects + <!-- ##### SECTION Long_Description ##### --> <para> -A factory for creating #AtkObjects. </para> diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml index 61d2dfb..b561a11 100644 --- a/docs/tmpl/atkregistry.sgml +++ b/docs/tmpl/atkregistry.sgml @@ -2,11 +2,10 @@ AtkRegistry <!-- ##### SECTION Short_Description ##### --> -registry for registering new #AtkObject factories + <!-- ##### SECTION Long_Description ##### --> <para> -A registry for registering new #AtkObject factories. </para> diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index 04d11da..f0041ae 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -2,11 +2,11 @@ AtkRelation <!-- ##### SECTION Short_Description ##### --> -defines the functional relationship between two #AtkObjects + <!-- ##### SECTION Long_Description ##### --> <para> -Defines the functional relationship between two #AtkObjects. + </para> <!-- ##### SECTION See_Also ##### --> @@ -46,7 +46,16 @@ Defines the functional relationship between two #AtkObjects. @Returns: -<!-- ##### FUNCTION atk_relation_type_from_string ##### --> +<!-- ##### FUNCTION atk_relation_type_get_name ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION atk_relation_type_for_name ##### --> <para> </para> diff --git a/docs/tmpl/atkrelationset.sgml b/docs/tmpl/atkrelationset.sgml index 6a12432..b04560d 100644 --- a/docs/tmpl/atkrelationset.sgml +++ b/docs/tmpl/atkrelationset.sgml @@ -2,13 +2,10 @@ AtkRelationSet <!-- ##### SECTION Short_Description ##### --> -a set of #AtkRelations, which define the functional relationships -between #AtkObjects + <!-- ##### SECTION Long_Description ##### --> <para> -A set of #AtkRelations, which define the functional relationships -between #AtkObjects. </para> diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index 609b356..fdeb7b7 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -2,15 +2,11 @@ AtkSelection <!-- ##### SECTION Short_Description ##### --> -accessibility interface for determining what the current selected -children are, as well as modify the selection set + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkSelection interface provides the standard mechanism for an -assistive technology to determine what the current selected children are, -as well as modify the selection set. Any object that has children that -can be selected should support the AtkSelection interface. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml index 28087e9..e29a4da 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -2,13 +2,11 @@ AtkState <!-- ##### SECTION Short_Description ##### --> -describes an objects particular state + <!-- ##### SECTION Long_Description ##### --> <para> -AtkState describes an objects particular state. The actual state of the -object is defined as an #AtkStateSet, which is a composed set of -AtkStates. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkstateset.sgml b/docs/tmpl/atkstateset.sgml index 972f435..08afaa7 100644 --- a/docs/tmpl/atkstateset.sgml +++ b/docs/tmpl/atkstateset.sgml @@ -2,13 +2,11 @@ AtkStateSet <!-- ##### SECTION Short_Description ##### --> -determines an object's state set + <!-- ##### SECTION Long_Description ##### --> <para> -AtkStateSet determines an object's state set. The state set of an object -is a set of AtkState objects and describes the current -overall state of the object, such as whether it is active, has focus, etc. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkstreamablecontent.sgml b/docs/tmpl/atkstreamablecontent.sgml index 8eab311..5cef56f 100644 --- a/docs/tmpl/atkstreamablecontent.sgml +++ b/docs/tmpl/atkstreamablecontent.sgml @@ -2,12 +2,11 @@ AtkStreamableContent <!-- ##### SECTION Short_Description ##### --> -accessibility interface for objects that contain streamable content + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkStreamableContent interface should be supported by any object -that contains streamable content. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index 25dc585..0ed4e6d 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -172,8 +172,6 @@ AtkTable @table: @row: @Returns: -<!-- # Unused Parameters # --> -@r: <!-- ##### FUNCTION atk_table_get_column_header ##### --> @@ -212,8 +210,6 @@ AtkTable @table: @caption: -<!-- # Unused Parameters # --> -@accessible: <!-- ##### FUNCTION atk_table_set_row_description ##### --> @@ -224,8 +220,6 @@ AtkTable @table: @row: @description: -<!-- # Unused Parameters # --> -@accessible: <!-- ##### FUNCTION atk_table_set_column_description ##### --> @@ -236,8 +230,6 @@ AtkTable @table: @column: @description: -<!-- # Unused Parameters # --> -@accessible: <!-- ##### FUNCTION atk_table_set_row_header ##### --> diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index 5e157ba..1922edb 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -139,9 +139,6 @@ AtkText @start_offset: @end_offset: @Returns: -<!-- # Unused Parameters # --> -@startOffset: -@endOffset: <!-- ##### FUNCTION atk_text_get_text_at_offset ##### --> @@ -155,9 +152,6 @@ AtkText @start_offset: @end_offset: @Returns: -<!-- # Unused Parameters # --> -@startOffset: -@endOffset: <!-- ##### FUNCTION atk_text_get_text_before_offset ##### --> @@ -171,9 +165,6 @@ AtkText @start_offset: @end_offset: @Returns: -<!-- # Unused Parameters # --> -@startOffset: -@endOffset: <!-- ##### FUNCTION atk_text_get_caret_offset ##### --> @@ -197,8 +188,6 @@ AtkText @width: @height: @coords: -<!-- # Unused Parameters # --> -@length: <!-- ##### FUNCTION atk_text_get_run_attributes ##### --> diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index bd03dde..fd370eb 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -2,11 +2,11 @@ AtkUtil <!-- ##### SECTION Short_Description ##### --> -general purpose utility class + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkUtility interface provides general purpose utility functions. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml index 611271c..0dc4e18 100644 --- a/docs/tmpl/atkvalue.sgml +++ b/docs/tmpl/atkvalue.sgml @@ -2,17 +2,11 @@ AtkValue <!-- ##### SECTION Short_Description ##### --> -the standard mechanism for an assistive technology to -determine and set numerical values as well as get minimum -and maximum values + <!-- ##### SECTION Long_Description ##### --> <para> -The AtkValue interface should be supported by any object that -supports a numerical value (e.g., a scroll bar). This interface -provides the standard mechanism for an assistive technology to -determine and set the numerical value as well as get the minimum -and maximum values. + </para> <!-- ##### SECTION See_Also ##### --> |