From ead4c1608e541fbd0635f36694011492ed30226c Mon Sep 17 00:00:00 2001 From: Padraig O'Briain Date: Mon, 5 Nov 2001 12:42:21 +0000 Subject: [PATCH] Add role ATK_ROLE_TREE_TABLE * atk/atkobject.h: Add role ATK_ROLE_TREE_TABLE * atk/atkrelation.h: Remove ATK_RELATION_NODE_CHILDREN and ATK_RELATION_NODE_PARENT and added ATK_RELATION_NODE_CHILD_OF; this is for use by TreeTable * docs/tmpl/atk-unused.sgml, docs/tmpl/atkaction.smgl, docs/tmpl/atkcomponent.sgml, docs/tmpl/atkdocument.sgml, docs/tmpl/atkeditabletext.tmpl, docs/tmpl/atkimage.tmpl, docs/tmpl/atkobject.sgml, docs/tmpl/atkrelation.sgml, docs/tmpl/atkselection.sgml, docs/tmpl/atkstate.sgml, docs/tmpl/atkstreamablecontent.sgml, docs/tmpl/atktable.sgml, docs/tmpl/atktext.sgml, docs/tmpl/atkutil.sgml: Update to reflect the current state of the documentation in the code. --- ChangeLog | 18 +++ atk/atkobject.h | 2 + atk/atkrelation.h | 6 +- docs/tmpl/atk-unused.sgml | 297 ------------------------------------ docs/tmpl/atkaction.sgml | 24 ++- docs/tmpl/atkcomponent.sgml | 24 +-- docs/tmpl/atkdocument.sgml | 33 ++++ docs/tmpl/atkeditabletext.sgml | 14 +- docs/tmpl/atkimage.sgml | 26 +++- docs/tmpl/atkobject.sgml | 12 ++ docs/tmpl/atkrelation.sgml | 3 +- docs/tmpl/atkselection.sgml | 4 - docs/tmpl/atkstate.sgml | 2 + docs/tmpl/atkstreamablecontent.sgml | 29 ++++ docs/tmpl/atktable.sgml | 98 ++++++++---- docs/tmpl/atktext.sgml | 118 ++++++++++++-- docs/tmpl/atkutil.sgml | 50 ++++++ 17 files changed, 400 insertions(+), 360 deletions(-) diff --git a/ChangeLog b/ChangeLog index 20d4310..d4cef9e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,21 @@ +2001-11-05 Padraig O'Briain + + * atk/atkobject.h: + Add role ATK_ROLE_TREE_TABLE + + * atk/atkrelation.h: + Remove ATK_RELATION_NODE_CHILDREN and ATK_RELATION_NODE_PARENT + and added ATK_RELATION_NODE_CHILD_OF; this is for use by TreeTable + + * docs/tmpl/atk-unused.sgml, docs/tmpl/atkaction.smgl, + docs/tmpl/atkcomponent.sgml, docs/tmpl/atkdocument.sgml, + docs/tmpl/atkeditabletext.tmpl, docs/tmpl/atkimage.tmpl, + docs/tmpl/atkobject.sgml, docs/tmpl/atkrelation.sgml, + docs/tmpl/atkselection.sgml, docs/tmpl/atkstate.sgml, + docs/tmpl/atkstreamablecontent.sgml, docs/tmpl/atktable.sgml, + docs/tmpl/atktext.sgml, docs/tmpl/atkutil.sgml: + Update to reflect the current state of the documentation in the code. + 2001-10-31 Padraig O'Briain * atk/relation.h, docs/tmpl/atkrelation.sgml: diff --git a/atk/atkobject.h b/atk/atkobject.h index 37b9387..9d042e1 100755 --- a/atk/atkobject.h +++ b/atk/atkobject.h @@ -104,6 +104,7 @@ extern "C" { *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons *@ATK_ROLE_TOOL_TIP: An object that provides information about another object *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user + *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane *@ATK_ROLE_WINDOW: A top level window with no title or border @@ -178,6 +179,7 @@ typedef enum ATK_ROLE_TOOL_BAR, ATK_ROLE_TOOL_TIP, ATK_ROLE_TREE, + ATK_ROLE_TREE_TABLE, ATK_ROLE_UNKNOWN, ATK_ROLE_VIEWPORT, ATK_ROLE_WINDOW, diff --git a/atk/atkrelation.h b/atk/atkrelation.h index b4f3c69..ba39ec2 100755 --- a/atk/atkrelation.h +++ b/atk/atkrelation.h @@ -40,8 +40,7 @@ extern "C" { *@ATK_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects. *@ATK_RELATION_LABELLED_BY: Indicates an object is labelled by one or more target objects. *@ATK_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or more target objects. - *@ATK_RELATION_NODE_CHILDREN: Indicates an object is a node in a tree or table and a compound object which more than one subobject - *@ATK_RELATION_NODE_PARENT: Indicates an object is a subobject of a compound object which is a node in a tree or table. + *@ATK_RELATION_NODE_CHILD_OF: Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. *@ATK_RELATION_LAST_DEFINED: * *Describes the type of the relation @@ -54,8 +53,7 @@ typedef enum ATK_RELATION_LABEL_FOR, ATK_RELATION_LABELLED_BY, ATK_RELATION_MEMBER_OF, - ATK_RELATION_NODE_CHILDREN, - ATK_RELATION_NODE_PARENT, + ATK_RELATION_NODE_CHILD_OF, ATK_RELATION_LAST_DEFINED } AtkRelationType; diff --git a/docs/tmpl/atk-unused.sgml b/docs/tmpl/atk-unused.sgml index 66e0c4a..4ca20da 100644 --- a/docs/tmpl/atk-unused.sgml +++ b/docs/tmpl/atk-unused.sgml @@ -180,300 +180,3 @@ atk - - - - - -@name: -@value: - - - - - - - - - - - - -@ATK_XY_SCREEN: -@ATK_XY_WINDOW: - - - - - - - - - - - - -@parent: -@get_document_type: -@get_document: - - - - - - -@ATK_TEXT_ATTR_LEFT_MARGIN: -@ATK_TEXT_ATTR_RIGHT_MARGIN: -@ATK_TEXT_ATTR_INDENT: -@ATK_TEXT_ATTR_INVISIBLE: -@ATK_TEXT_ATTR_EDITABLE: -@ATK_TEXT_ATTR_PIXELS_ABOVE_LINES: -@ATK_TEXT_ATTR_PIXELS_BELOW_LINES: -@ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP: -@ATK_TEXT_ATTR_BG_FULL_HEIGHT: -@ATK_TEXT_ATTR_RISE: -@ATK_TEXT_ATTR_UNDERLINE: -@ATK_TEXT_ATTR_STRIKETHROUGH: -@ATK_TEXT_ATTR_SIZE: -@ATK_TEXT_ATTR_SCALE: -@ATK_TEXT_ATTR_WEIGHT: -@ATK_TEXT_ATTR_LANGUAGE: -@ATK_TEXT_ATTR_FAMILY_NAME: -@ATK_TEXT_ATTR_BG_COLOR: -@ATK_TEXT_ATTR_FG_COLOR: -@ATK_TEXT_ATTR_BG_STIPPLE: -@ATK_TEXT_ATTR_FG_STIPPLE: -@ATK_TEXT_ATTR_WRAP_MODE: -@ATK_TEXT_ATTR_DIRECTION: -@ATK_TEXT_ATTR_JUSTIFICATION: -@ATK_TEXT_ATTR_STRETCH: -@ATK_TEXT_ATTR_VARIANT: -@ATK_TEXT_ATTR_STYLE: - - - - - - -@action: -@i: -@Returns: - - - - - - -@action: -@i: -@desc: -@Returns: - - - - - - -@listener: -@event_type: -@Returns: - - - - - - -@attr: -@Returns: - - - - - - -@attr: -@index: -@Returns: - - - - - - -@attrib_set: - - - - - - -@component: -@x: -@y: -@coord_type: -@Returns: - - - - - - -@document: -@Returns: - - - - - - -@document: -@Returns: - - - - - - -@text: -@attrib_set: -@start_offset: -@end_offset: -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@image: -@x: -@y: -@coord_type: - - - - - - -@image: -@width: -@height: - - - - - - -@accessible: -@state: -@value: - - - - - - -@listener_id: - - - - - - -@streamable: -@i: -@Returns: - - - - - - -@streamable: -@Returns: - - - - - - -@streamable: -@mime_type: -@Returns: - - - - - - -@table: -@column: -@Returns: - - - - - - -@table: -@row: -@Returns: - - - - - - -@table: -@column: -@Returns: - - - - - - -@table: -@row: -@Returns: - - - - - - -@text: -@Returns: - - - - - - -@text: -@offset: -@start_offset: -@end_offset: -@Returns: - diff --git a/docs/tmpl/atkaction.sgml b/docs/tmpl/atkaction.sgml index 689dd42..f744c7d 100644 --- a/docs/tmpl/atkaction.sgml +++ b/docs/tmpl/atkaction.sgml @@ -33,7 +33,9 @@ be manipulated should support this interface. @do_action: @get_n_actions: @get_description: +@get_name: @get_keybinding: +@set_description: @@ -42,7 +44,6 @@ be manipulated should support this interface. @action: @i: - @Returns: @@ -65,6 +66,16 @@ be manipulated should support this interface. @Returns: + + + + + +@action: +@i: +@Returns: + + @@ -75,3 +86,14 @@ be manipulated should support this interface. @Returns: + + + + + +@action: +@i: +@desc: +@Returns: + + diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index 9da63e1..bde93a5 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -31,10 +31,9 @@ representation of an object. @parent: @add_focus_handler: @contains: -@get_accessible_at_point: +@ref_accessible_at_point: @get_extents: @get_position: -@get_position_on_screen: @get_size: @grab_focus: @remove_focus_handler: @@ -60,9 +59,8 @@ representation of an object. @component: @x: @y: -@Returns: - @coord_type: +@Returns: @@ -75,7 +73,6 @@ representation of an object. @y: @width: @height: - @coord_type: @@ -87,7 +84,6 @@ representation of an object. @component: @x: @y: - @coord_type: @@ -107,7 +103,18 @@ representation of an object. @component: - +@Returns: + + + + + + + +@component: +@x: +@y: +@coord_type: @Returns: @@ -130,7 +137,6 @@ representation of an object. @y: @width: @height: - @coord_type: @Returns: @@ -143,7 +149,6 @@ representation of an object. @component: @x: @y: - @coord_type: @Returns: @@ -156,7 +161,6 @@ representation of an object. @component: @width: @height: - @Returns: diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml index 5d7ef8d..5972540 100644 --- a/docs/tmpl/atkdocument.sgml +++ b/docs/tmpl/atkdocument.sgml @@ -14,3 +14,36 @@ AtkDocument + + + + + + + + + + + +@parent: +@get_document_type: +@get_document: + + + + + + +@document: +@Returns: + + + + + + + +@document: +@Returns: + + diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml index 84327f7..1f9d147 100644 --- a/docs/tmpl/atkeditabletext.sgml +++ b/docs/tmpl/atkeditabletext.sgml @@ -27,7 +27,7 @@ to editing features of editable text widgets. @parent_interface: -@set_attributes: +@set_run_attributes: @set_text_contents: @insert_text: @copy_text: @@ -35,6 +35,18 @@ to editing features of editable text widgets. @delete_text: @paste_text: + + + + + +@text: +@attrib_set: +@start_offset: +@end_offset: +@Returns: + + diff --git a/docs/tmpl/atkimage.sgml b/docs/tmpl/atkimage.sgml index 7045bda..8d0a6bc 100644 --- a/docs/tmpl/atkimage.sgml +++ b/docs/tmpl/atkimage.sgml @@ -28,12 +28,22 @@ an assistive technology to get descriptive information about images. @parent: -@get_storage_type: +@get_image_position: @get_image_description: -@get_image_height: -@get_image_width: +@get_image_size: @set_image_description: + + + + + +@image: +@x: +@y: +@coord_type: + + @@ -53,3 +63,13 @@ an assistive technology to get descriptive information about images. @Returns: + + + + + +@image: +@width: +@height: + + diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 9b1cb09..37091eb 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -83,11 +83,13 @@ of the other ATK interfaces: @ATK_ROLE_TABLE_COLUMN_HEADER: @ATK_ROLE_TABLE_ROW_HEADER: @ATK_ROLE_TEAR_OFF_MENU_ITEM: +@ATK_ROLE_TERMINAL: @ATK_ROLE_TEXT: @ATK_ROLE_TOGGLE_BUTTON: @ATK_ROLE_TOOL_BAR: @ATK_ROLE_TOOL_TIP: @ATK_ROLE_TREE: +@ATK_ROLE_TREE_TABLE: @ATK_ROLE_UNKNOWN: @ATK_ROLE_VIEWPORT: @ATK_ROLE_WINDOW: @@ -288,3 +290,13 @@ of the other ATK interfaces: @handler_id: + + + + + +@accessible: +@state: +@value: + + diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index 8d32646..8b6969a 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -25,8 +25,7 @@ Defines the functional relationship between two #AtkObjects. @ATK_RELATION_LABEL_FOR: @ATK_RELATION_LABELLED_BY: @ATK_RELATION_MEMBER_OF: -@ATK_RELATION_NODE_CHILDREN: -@ATK_RELATION_NODE_PARENT: +@ATK_RELATION_NODE_CHILD_OF: @ATK_RELATION_LAST_DEFINED: diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index 0169daa..300a0d8 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -45,7 +45,6 @@ can be selected should support the AtkSelection interface. @selection: @i: - @Returns: @@ -55,7 +54,6 @@ can be selected should support the AtkSelection interface. @selection: - @Returns: @@ -95,7 +93,6 @@ can be selected should support the AtkSelection interface. @selection: @i: - @Returns: @@ -105,7 +102,6 @@ can be selected should support the AtkSelection interface. @selection: - @Returns: diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml index b7027f3..a881058 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -29,6 +29,7 @@ AtkStates. @ATK_STATE_COLLAPSED: @ATK_STATE_DEFUNCT: @ATK_STATE_EDITABLE: +@ATK_STATE_ENABLED: @ATK_STATE_EXPANDABLE: @ATK_STATE_EXPANDED: @ATK_STATE_FOCUSABLE: @@ -46,6 +47,7 @@ AtkStates. @ATK_STATE_SENSITIVE: @ATK_STATE_SHOWING: @ATK_STATE_SINGLE_LINE: +@ATK_STATE_STALE: @ATK_STATE_TRANSIENT: @ATK_STATE_VERTICAL: @ATK_STATE_VISIBLE: diff --git a/docs/tmpl/atkstreamablecontent.sgml b/docs/tmpl/atkstreamablecontent.sgml index c58b53b..65bcdfe 100644 --- a/docs/tmpl/atkstreamablecontent.sgml +++ b/docs/tmpl/atkstreamablecontent.sgml @@ -15,3 +15,32 @@ that contains streamable content. + + + + + +@streamable: +@Returns: + + + + + + + +@streamable: +@i: +@Returns: + + + + + + + +@streamable: +@mime_type: +@Returns: + + diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index a1b1fcc..9dbab84 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -28,29 +28,39 @@ AtkTable @parent: @ref_at: @get_index_at: -@get_row_at_index: @get_column_at_index: -@get_caption: +@get_row_at_index: @get_n_columns: -@get_column_description: +@get_n_rows: @get_column_extent_at: +@get_row_extent_at: +@get_caption: +@get_column_description: @get_column_header: -@get_n_rows: @get_row_description: -@get_row_extent_at: @get_row_header: @get_summary: -@get_selected_columns: -@get_selected_rows: -@is_column_selected: -@is_row_selected: -@is_selected: @set_caption: @set_column_description: @set_column_header: @set_row_description: @set_row_header: @set_summary: +@get_selected_columns: +@get_selected_rows: +@is_column_selected: +@is_row_selected: +@is_selected: +@add_row_selection: +@remove_row_selection: +@add_column_selection: +@remove_column_selection: +@row_inserted: +@column_inserted: +@row_deleted: +@column_deleted: +@row_reordered: +@column_reordered: @@ -159,10 +169,10 @@ AtkTable @table: -@r: +@row: @Returns: -@row: +@r: @@ -171,9 +181,8 @@ AtkTable @table: -@Returns: - @column: +@Returns: @@ -182,9 +191,8 @@ AtkTable @table: -@Returns: - @row: +@Returns: @@ -202,9 +210,9 @@ AtkTable @table: -@accessible: - @caption: + +@accessible: @@ -214,9 +222,9 @@ AtkTable @table: @row: -@accessible: - @description: + +@accessible: @@ -226,9 +234,9 @@ AtkTable @table: @column: -@accessible: - @description: + +@accessible: @@ -266,9 +274,8 @@ AtkTable @table: -@Returns: - @selected: +@Returns: @@ -277,9 +284,8 @@ AtkTable @table: -@Returns: - @selected: +@Returns: @@ -313,3 +319,43 @@ AtkTable @Returns: + + + + + +@table: +@column: +@Returns: + + + + + + + +@table: +@row: +@Returns: + + + + + + + +@table: +@column: +@Returns: + + + + + + + +@table: +@row: +@Returns: + + diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index f06b944..95b3dd4 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -32,7 +32,8 @@ AtkText @get_character_at_offset: @get_text_before_offset: @get_caret_offset: -@get_range_attributes: +@get_run_attributes: +@get_default_attributes: @get_character_extents: @get_character_count: @get_offset_at_point: @@ -51,7 +52,6 @@ AtkText @ATK_TEXT_BOUNDARY_CHAR: -@ATK_TEXT_BOUNDARY_CURSOR_POS: @ATK_TEXT_BOUNDARY_WORD_START: @ATK_TEXT_BOUNDARY_WORD_END: @ATK_TEXT_BOUNDARY_SENTENCE_START: @@ -59,6 +59,53 @@ AtkText @ATK_TEXT_BOUNDARY_LINE_START: @ATK_TEXT_BOUNDARY_LINE_END: + + + + + +@name: +@value: + + + + + + + + + + + + +@ATK_TEXT_ATTR_LEFT_MARGIN: +@ATK_TEXT_ATTR_RIGHT_MARGIN: +@ATK_TEXT_ATTR_INDENT: +@ATK_TEXT_ATTR_INVISIBLE: +@ATK_TEXT_ATTR_EDITABLE: +@ATK_TEXT_ATTR_PIXELS_ABOVE_LINES: +@ATK_TEXT_ATTR_PIXELS_BELOW_LINES: +@ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP: +@ATK_TEXT_ATTR_BG_FULL_HEIGHT: +@ATK_TEXT_ATTR_RISE: +@ATK_TEXT_ATTR_UNDERLINE: +@ATK_TEXT_ATTR_STRIKETHROUGH: +@ATK_TEXT_ATTR_SIZE: +@ATK_TEXT_ATTR_SCALE: +@ATK_TEXT_ATTR_WEIGHT: +@ATK_TEXT_ATTR_LANGUAGE: +@ATK_TEXT_ATTR_FAMILY_NAME: +@ATK_TEXT_ATTR_BG_COLOR: +@ATK_TEXT_ATTR_FG_COLOR: +@ATK_TEXT_ATTR_BG_STIPPLE: +@ATK_TEXT_ATTR_FG_STIPPLE: +@ATK_TEXT_ATTR_WRAP_MODE: +@ATK_TEXT_ATTR_DIRECTION: +@ATK_TEXT_ATTR_JUSTIFICATION: +@ATK_TEXT_ATTR_STRETCH: +@ATK_TEXT_ATTR_VARIANT: +@ATK_TEXT_ATTR_STYLE: + @@ -88,10 +135,10 @@ AtkText @text: @offset: @boundary_type: -@Returns: - @start_offset: @end_offset: +@Returns: + @startOffset: @endOffset: @@ -104,10 +151,10 @@ AtkText @text: @offset: @boundary_type: -@Returns: - @start_offset: @end_offset: +@Returns: + @startOffset: @endOffset: @@ -120,10 +167,10 @@ AtkText @text: @offset: @boundary_type: -@Returns: - @start_offset: @end_offset: +@Returns: + @startOffset: @endOffset: @@ -146,11 +193,32 @@ AtkText @offset: @x: @y: -@length: @width: - @height: @coords: + +@length: + + + + + + + +@text: +@offset: +@start_offset: +@end_offset: +@Returns: + + + + + + + +@text: +@Returns: @@ -170,9 +238,8 @@ AtkText @text: @x: @y: -@Returns: - @coords: +@Returns: @@ -239,3 +306,30 @@ AtkText @Returns: + + + + + +@attrib_set: + + + + + + + +@attr: +@Returns: + + + + + + + +@attr: +@index: +@Returns: + + diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index 062101e..027f90e 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -14,6 +14,14 @@ The AtkUtility interface provides general purpose utility functions. + + + + + +@ATK_XY_SCREEN: +@ATK_XY_WINDOW: + @@ -47,3 +55,45 @@ The AtkUtility interface provides general purpose utility functions. @object: + + + + + +@listener: +@event_type: +@Returns: + + + + + + + +@listener_id: + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + -- 2.7.4