Updated docs.
authorBrian Cameron <bcameron@src.gnome.org>
Tue, 10 Jul 2001 12:44:02 +0000 (12:44 +0000)
committerBrian Cameron <bcameron@src.gnome.org>
Tue, 10 Jul 2001 12:44:02 +0000 (12:44 +0000)
ChangeLog
docs/tmpl/atk-unused.sgml
docs/tmpl/atkcomponent.sgml
docs/tmpl/atkeditabletext.sgml
docs/tmpl/atkimage.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

index ffcd21d..4b909d1 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2001-07/10  Brian Cameron <brian.cameron@sun.com>
+       * 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  <timj@gtk.org>
 
        * atk/atktext.c (atk_text_base_init): 
index 1bdf217..5f40b42 100644 (file)
@@ -45,15 +45,6 @@ atk
 
 @parent: 
 
-<!-- ##### FUNCTION atk_add_global_event_listener ##### -->
-<para>
-
-</para>
-
-@listener: 
-@event_type: 
-@Returns: 
-
 <!-- ##### FUNCTION atk_component_get_position_on_screen ##### -->
 <para>
 
@@ -82,27 +73,6 @@ atk
 @end_pos: 
 @attributes: 
 
-<!-- ##### FUNCTION atk_get_root ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION atk_get_toolkit_name ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### FUNCTION atk_get_toolkit_version ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
 <!-- ##### FUNCTION atk_image_get_image_height ##### -->
 <para>
 
@@ -111,15 +81,6 @@ atk
 @image: 
 @Returns: 
 
-<!-- ##### FUNCTION atk_image_get_image_size ##### -->
-<para>
-
-</para>
-
-@image: 
-@height: 
-@width: 
-
 <!-- ##### FUNCTION atk_image_get_image_width ##### -->
 <para>
 
@@ -128,16 +89,6 @@ atk
 @image: 
 @Returns: 
 
-<!-- ##### FUNCTION atk_image_get_position ##### -->
-<para>
-
-</para>
-
-@image: 
-@x: 
-@y: 
-@coord_type: 
-
 <!-- ##### FUNCTION atk_image_get_storage_type ##### -->
 <para>
 
@@ -146,13 +97,6 @@ atk
 @image: 
 @Returns: 
 
-<!-- ##### FUNCTION atk_remove_global_event_listener ##### -->
-<para>
-
-</para>
-
-@listener_id: 
-
 <!-- ##### FUNCTION atk_streamable_content_get_type ##### -->
 <para>
 
index 2cf7841..24134c6 100644 (file)
@@ -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: 
-<!-- # Unused Parameters # -->
 @coord_type: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_component_get_accessible_at_point ##### -->
@@ -73,9 +71,8 @@ representation of an object.
 @component: 
 @x: 
 @y: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @coord_type: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_component_get_extents ##### -->
@@ -88,7 +85,6 @@ representation of an object.
 @y: 
 @width: 
 @height: 
-<!-- # Unused Parameters # -->
 @coord_type: 
 
 
@@ -100,7 +96,6 @@ representation of an object.
 @component: 
 @x: 
 @y: 
-<!-- # Unused Parameters # -->
 @coord_type: 
 
 
@@ -120,7 +115,6 @@ representation of an object.
 </para>
 
 @component: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -143,7 +137,6 @@ representation of an object.
 @y: 
 @width: 
 @height: 
-<!-- # Unused Parameters # -->
 @coord_type: 
 @Returns: 
 
@@ -156,7 +149,6 @@ representation of an object.
 @component: 
 @x: 
 @y: 
-<!-- # Unused Parameters # -->
 @coord_type: 
 @Returns: 
 
@@ -169,7 +161,6 @@ representation of an object.
 @component: 
 @width: 
 @height: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
index 84327f7..1f9d147 100644 (file)
@@ -27,7 +27,7 @@ to editing features of editable text widgets.
 </para>
 
 @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: 
 
+<!-- ##### FUNCTION atk_editable_text_set_run_attributes ##### -->
+<para>
+
+</para>
+
+@text: 
+@attrib_set: 
+@start_offset: 
+@end_offset: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_editable_text_set_text_contents ##### -->
 <para>
 
index 7045bda..f564a85 100644 (file)
@@ -28,12 +28,22 @@ an assistive technology to get descriptive information about images.
 </para>
 
 @parent: 
-@get_storage_type
+@get_position
 @get_image_description: 
-@get_image_height: 
-@get_image_width: 
+@get_image_size: 
 @set_image_description: 
 
+<!-- ##### FUNCTION atk_image_get_position ##### -->
+<para>
+
+</para>
+
+@image: 
+@x: 
+@y: 
+@coord_type: 
+
+
 <!-- ##### FUNCTION atk_image_get_image_description ##### -->
 <para>
 
@@ -53,3 +63,13 @@ an assistive technology to get descriptive information about images.
 @Returns: 
 
 
+<!-- ##### FUNCTION atk_image_get_image_size ##### -->
+<para>
+
+</para>
+
+@image: 
+@height: 
+@width: 
+
+
index 0169daa..300a0d8 100644 (file)
@@ -45,7 +45,6 @@ can be selected should support the AtkSelection interface.
 
 @selection: 
 @i: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -55,7 +54,6 @@ can be selected should support the AtkSelection interface.
 </para>
 
 @selection: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -95,7 +93,6 @@ can be selected should support the AtkSelection interface.
 
 @selection: 
 @i: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -105,7 +102,6 @@ can be selected should support the AtkSelection interface.
 </para>
 
 @selection: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
index b7027f3..8913efc 100644 (file)
@@ -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: 
index c58b53b..65bcdfe 100644 (file)
@@ -15,3 +15,32 @@ that contains streamable content.
 
 </para>
 
+<!-- ##### FUNCTION atk_streamable_content_get_n_mime_types ##### -->
+<para>
+
+</para>
+
+@streamable: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_streamable_content_get_mime_type ##### -->
+<para>
+
+</para>
+
+@streamable: 
+@i: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_streamable_content_get_stream ##### -->
+<para>
+
+</para>
+
+@streamable: 
+@mime_type: 
+@Returns: 
+
+
index 57ceb82..e4665fa 100644 (file)
@@ -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: 
 
 <!-- ##### FUNCTION atk_table_ref_at ##### -->
 <para>
@@ -170,9 +180,8 @@ two-dimensional table format.
 </para>
 
 @table: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @column: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_table_get_row_header ##### -->
@@ -181,9 +190,8 @@ two-dimensional table format.
 </para>
 
 @table: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @row: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_table_get_summary ##### -->
@@ -201,9 +209,9 @@ two-dimensional table format.
 </para>
 
 @table: 
-@accessible: 
-<!-- # Unused Parameters # -->
 @caption: 
+<!-- # Unused Parameters # -->
+@accessible: 
 
 
 <!-- ##### FUNCTION atk_table_set_row_description ##### -->
@@ -213,9 +221,9 @@ two-dimensional table format.
 
 @table: 
 @row: 
-@accessible: 
-<!-- # Unused Parameters # -->
 @description: 
+<!-- # Unused Parameters # -->
+@accessible: 
 
 
 <!-- ##### FUNCTION atk_table_set_column_description ##### -->
@@ -225,9 +233,9 @@ two-dimensional table format.
 
 @table: 
 @column: 
-@accessible: 
-<!-- # Unused Parameters # -->
 @description: 
+<!-- # Unused Parameters # -->
+@accessible: 
 
 
 <!-- ##### FUNCTION atk_table_set_row_header ##### -->
@@ -265,9 +273,8 @@ two-dimensional table format.
 </para>
 
 @table: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @selected: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
@@ -276,9 +283,8 @@ two-dimensional table format.
 </para>
 
 @table: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @selected: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_table_is_column_selected ##### -->
@@ -312,3 +318,43 @@ two-dimensional table format.
 @Returns: 
 
 
+<!-- ##### FUNCTION atk_table_add_column_selection ##### -->
+<para>
+
+</para>
+
+@table: 
+@column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_table_add_row_selection ##### -->
+<para>
+
+</para>
+
+@table: 
+@row: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
+<para>
+
+</para>
+
+@table: 
+@column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
+<para>
+
+</para>
+
+@table: 
+@row: 
+@Returns: 
+
+
index c88f4c8..705f801 100644 (file)
@@ -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
 </para>
 
 @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: 
-<!-- # Unused Parameters # -->
 @startOffset: 
 @endOffset: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
@@ -102,10 +100,9 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @offset: 
 @boundary_type: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @startOffset: 
 @endOffset: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
@@ -116,10 +113,9 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @offset: 
 @boundary_type: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @startOffset: 
 @endOffset: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
@@ -142,10 +138,21 @@ AtkText provides an accessibility interface for text widgets
 @y: 
 @length: 
 @width: 
-<!-- # Unused Parameters # -->
 @coords: 
 
 
+<!-- ##### FUNCTION atk_text_ref_run_attributes ##### -->
+<para>
+
+</para>
+
+@text: 
+@offset: 
+@start_offset: 
+@end_offset: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 <para>
 
@@ -163,9 +170,8 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @x: 
 @y: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @coords: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
index 062101e..fd269d4 100644 (file)
@@ -47,3 +47,45 @@ The AtkUtility interface provides general purpose utility functions.
 @object: 
 
 
+<!-- ##### FUNCTION atk_add_global_event_listener ##### -->
+<para>
+
+</para>
+
+@listener: 
+@event_type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_remove_global_event_listener ##### -->
+<para>
+
+</para>
+
+@listener_id: 
+
+
+<!-- ##### FUNCTION atk_get_root ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_get_toolkit_name ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_get_toolkit_version ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+