From b1428e6ccf8f1bf7fe30f9ade826ab1e22b84b67 Mon Sep 17 00:00:00 2001 From: Brian Cameron Date: Tue, 10 Jul 2001 12:44:02 +0000 Subject: [PATCH] Updated docs. --- ChangeLog | 7 +++ docs/tmpl/atk-unused.sgml | 56 ---------------------- docs/tmpl/atkcomponent.sgml | 13 +---- docs/tmpl/atkeditabletext.sgml | 14 +++++- docs/tmpl/atkimage.sgml | 26 ++++++++-- docs/tmpl/atkselection.sgml | 4 -- docs/tmpl/atkstate.sgml | 1 + docs/tmpl/atkstreamablecontent.sgml | 29 ++++++++++++ docs/tmpl/atktable.sgml | 94 +++++++++++++++++++++++++++---------- docs/tmpl/atktext.sgml | 28 ++++++----- docs/tmpl/atkutil.sgml | 42 +++++++++++++++++ 11 files changed, 204 insertions(+), 110 deletions(-) diff --git a/ChangeLog b/ChangeLog index ffcd21d..4b909d1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2001-07/10 Brian Cameron + * tmpl/atk-unused.sgml tmpl/atkcomponent.sgml tmpl/atkeditabletext.sgml + tmpl/atkimage.sgml tmpl/atkselection.sgml tmpl/atkstate.sgml + tmpl/atkstreamablecontent.sgml tmpl/atktable.sgml + tmpl/atktext.sgml tmpl/atkutil.sgml + Updated docs pages. + Mon Jul 2 06:37:09 2001 Tim Janik * atk/atktext.c (atk_text_base_init): diff --git a/docs/tmpl/atk-unused.sgml b/docs/tmpl/atk-unused.sgml index 1bdf217..5f40b42 100644 --- a/docs/tmpl/atk-unused.sgml +++ b/docs/tmpl/atk-unused.sgml @@ -45,15 +45,6 @@ atk @parent: - - - - - -@listener: -@event_type: -@Returns: - @@ -82,27 +73,6 @@ atk @end_pos: @attributes: - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - @@ -111,15 +81,6 @@ atk @image: @Returns: - - - - - -@image: -@height: -@width: - @@ -128,16 +89,6 @@ atk @image: @Returns: - - - - - -@image: -@x: -@y: -@coord_type: - @@ -146,13 +97,6 @@ atk @image: @Returns: - - - - - -@listener_id: - diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index 2cf7841..24134c6 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -34,7 +34,6 @@ representation of an object. @get_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: @@ -73,9 +71,8 @@ representation of an object. @component: @x: @y: -@Returns: - @coord_type: +@Returns: @@ -88,7 +85,6 @@ representation of an object. @y: @width: @height: - @coord_type: @@ -100,7 +96,6 @@ representation of an object. @component: @x: @y: - @coord_type: @@ -120,7 +115,6 @@ representation of an object. @component: - @Returns: @@ -143,7 +137,6 @@ representation of an object. @y: @width: @height: - @coord_type: @Returns: @@ -156,7 +149,6 @@ representation of an object. @component: @x: @y: - @coord_type: @Returns: @@ -169,7 +161,6 @@ representation of an object. @component: @width: @height: - @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..f564a85 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_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: +@height: +@width: + + 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..8913efc 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -46,6 +46,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 57ceb82..e4665fa 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -29,29 +29,39 @@ two-dimensional table format. @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: @@ -170,9 +180,8 @@ two-dimensional table format. @table: -@Returns: - @column: +@Returns: @@ -181,9 +190,8 @@ two-dimensional table format. @table: -@Returns: - @row: +@Returns: @@ -201,9 +209,9 @@ two-dimensional table format. @table: -@accessible: - @caption: + +@accessible: @@ -213,9 +221,9 @@ two-dimensional table format. @table: @row: -@accessible: - @description: + +@accessible: @@ -225,9 +233,9 @@ two-dimensional table format. @table: @column: -@accessible: - @description: + +@accessible: @@ -265,9 +273,8 @@ two-dimensional table format. @table: -@Returns: - @selected: +@Returns: @@ -276,9 +283,8 @@ two-dimensional table format. @table: -@Returns: - @selected: +@Returns: @@ -312,3 +318,43 @@ two-dimensional table format. @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 c88f4c8..705f801 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -32,7 +32,7 @@ AtkText provides an accessibility interface for text widgets @get_character_at_offset: @get_text_before_offset: @get_caret_offset: -@get_range_attributes: +@ref_run_attributes: @get_character_extents: @get_character_count: @get_offset_at_point: @@ -51,7 +51,6 @@ AtkText provides an accessibility interface for text widgets @ATK_TEXT_BOUNDARY_CHAR: -@ATK_TEXT_BOUNDARY_CURSOR_POS: @ATK_TEXT_BOUNDARY_WORD_START: @ATK_TEXT_BOUNDARY_WORD_END: @ATK_TEXT_BOUNDARY_SENTENCE_START: @@ -88,10 +87,9 @@ AtkText provides an accessibility interface for text widgets @text: @offset: @boundary_type: -@Returns: - @startOffset: @endOffset: +@Returns: @@ -102,10 +100,9 @@ AtkText provides an accessibility interface for text widgets @text: @offset: @boundary_type: -@Returns: - @startOffset: @endOffset: +@Returns: @@ -116,10 +113,9 @@ AtkText provides an accessibility interface for text widgets @text: @offset: @boundary_type: -@Returns: - @startOffset: @endOffset: +@Returns: @@ -142,10 +138,21 @@ AtkText provides an accessibility interface for text widgets @y: @length: @width: - @coords: + + + + + +@text: +@offset: +@start_offset: +@end_offset: +@Returns: + + @@ -163,9 +170,8 @@ AtkText provides an accessibility interface for text widgets @text: @x: @y: -@Returns: - @coords: +@Returns: diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index 062101e..fd269d4 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -47,3 +47,45 @@ The AtkUtility interface provides general purpose utility functions. @object: + + + + + +@listener: +@event_type: +@Returns: + + + + + + + +@listener_id: + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + -- 2.7.4