summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPadraig O'Briain <padraigo@src.gnome.org>2001-10-09 14:11:13 +0000
committerPadraig O'Briain <padraigo@src.gnome.org>2001-10-09 14:11:13 +0000
commitfe7216faf6aa68762572964ad0b3a4903ba3eb2c (patch)
tree055fb3376e2dc6a649de766ad3b17c6cdf16dc62 /docs
parent159e654dbcc452614c67e2c7e58d3dbf44ba4fc5 (diff)
downloadatk-fe7216faf6aa68762572964ad0b3a4903ba3eb2c.tar.gz
docs/tmpl.atk*.sgml Updated to reflect current APIs.
* docs/tmpl.atk*.sgml Updated to reflect current APIs.
Diffstat (limited to 'docs')
-rw-r--r--docs/tmpl/atkaction.sgml24
-rw-r--r--docs/tmpl/atkcomponent.sgml24
-rw-r--r--docs/tmpl/atkdocument.sgml33
-rw-r--r--docs/tmpl/atkeditabletext.sgml14
-rw-r--r--docs/tmpl/atkimage.sgml26
-rw-r--r--docs/tmpl/atkselection.sgml4
-rw-r--r--docs/tmpl/atkstate.sgml2
-rw-r--r--docs/tmpl/atkstreamablecontent.sgml29
-rw-r--r--docs/tmpl/atktable.sgml98
-rw-r--r--docs/tmpl/atktext.sgml245
-rw-r--r--docs/tmpl/atkutil.sgml50
11 files changed, 492 insertions, 57 deletions
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:
<!-- ##### FUNCTION atk_action_do_action ##### -->
<para>
@@ -42,7 +44,6 @@ be manipulated should support this interface.
@action:
@i:
-<!-- # Unused Parameters # -->
@Returns:
@@ -65,6 +66,16 @@ be manipulated should support this interface.
@Returns:
+<!-- ##### FUNCTION atk_action_get_name ##### -->
+<para>
+
+</para>
+
+@action:
+@i:
+@Returns:
+
+
<!-- ##### FUNCTION atk_action_get_keybinding ##### -->
<para>
@@ -75,3 +86,14 @@ be manipulated should support this interface.
@Returns:
+<!-- ##### FUNCTION atk_action_set_description ##### -->
+<para>
+
+</para>
+
+@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:
-<!-- # Unused Parameters # -->
@coord_type:
+@Returns:
<!-- ##### FUNCTION atk_component_get_extents ##### -->
@@ -75,7 +73,6 @@ representation of an object.
@y:
@width:
@height:
-<!-- # Unused Parameters # -->
@coord_type:
@@ -87,7 +84,6 @@ representation of an object.
@component:
@x:
@y:
-<!-- # Unused Parameters # -->
@coord_type:
@@ -107,7 +103,18 @@ representation of an object.
</para>
@component:
-<!-- # Unused Parameters # -->
+@Returns:
+
+
+<!-- ##### FUNCTION atk_component_ref_accessible_at_point ##### -->
+<para>
+
+</para>
+
+@component:
+@x:
+@y:
+@coord_type:
@Returns:
@@ -130,7 +137,6 @@ representation of an object.
@y:
@width:
@height:
-<!-- # Unused Parameters # -->
@coord_type:
@Returns:
@@ -143,7 +149,6 @@ representation of an object.
@component:
@x:
@y:
-<!-- # Unused Parameters # -->
@coord_type:
@Returns:
@@ -156,7 +161,6 @@ representation of an object.
@component:
@width:
@height:
-<!-- # Unused Parameters # -->
@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
</para>
+<!-- ##### STRUCT AtkDocument ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT AtkDocumentIface ##### -->
+<para>
+
+</para>
+
+@parent:
+@get_document_type:
+@get_document:
+
+<!-- ##### FUNCTION atk_document_get_document_type ##### -->
+<para>
+
+</para>
+
+@document:
+@Returns:
+
+
+<!-- ##### FUNCTION atk_document_get_document ##### -->
+<para>
+
+</para>
+
+@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.
</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>
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.
</para>
@parent:
-@get_storage_type:
+@get_image_position:
@get_image_description:
-@get_image_height:
-@get_image_width:
+@get_image_size:
@set_image_description:
+<!-- ##### FUNCTION atk_image_get_image_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:
+@width:
+@height:
+
+
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:
-<!-- # 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:
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.
</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:
+
+
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:
<!-- ##### FUNCTION atk_table_ref_at ##### -->
<para>
@@ -159,10 +169,10 @@ AtkTable
</para>
@table:
-@r:
+@row:
@Returns:
<!-- # Unused Parameters # -->
-@row:
+@r:
<!-- ##### FUNCTION atk_table_get_column_header ##### -->
@@ -171,9 +181,8 @@ AtkTable
</para>
@table:
-@Returns:
-<!-- # Unused Parameters # -->
@column:
+@Returns:
<!-- ##### FUNCTION atk_table_get_row_header ##### -->
@@ -182,9 +191,8 @@ AtkTable
</para>
@table:
-@Returns:
-<!-- # Unused Parameters # -->
@row:
+@Returns:
<!-- ##### FUNCTION atk_table_get_summary ##### -->
@@ -202,9 +210,9 @@ AtkTable
</para>
@table:
-@accessible:
-<!-- # Unused Parameters # -->
@caption:
+<!-- # Unused Parameters # -->
+@accessible:
<!-- ##### FUNCTION atk_table_set_row_description ##### -->
@@ -214,9 +222,9 @@ AtkTable
@table:
@row:
-@accessible:
-<!-- # Unused Parameters # -->
@description:
+<!-- # Unused Parameters # -->
+@accessible:
<!-- ##### FUNCTION atk_table_set_column_description ##### -->
@@ -226,9 +234,9 @@ AtkTable
@table:
@column:
-@accessible:
-<!-- # Unused Parameters # -->
@description:
+<!-- # Unused Parameters # -->
+@accessible:
<!-- ##### FUNCTION atk_table_set_row_header ##### -->
@@ -266,9 +274,8 @@ AtkTable
</para>
@table:
-@Returns:
-<!-- # Unused Parameters # -->
@selected:
+@Returns:
<!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
@@ -277,9 +284,8 @@ AtkTable
</para>
@table:
-@Returns:
-<!-- # Unused Parameters # -->
@selected:
+@Returns:
<!-- ##### FUNCTION atk_table_is_column_selected ##### -->
@@ -313,3 +319,43 @@ AtkTable
@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:
+
+
diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml
index f06b944..8b23ecc 100644
--- a/docs/tmpl/atktext.sgml
+++ b/docs/tmpl/atktext.sgml
@@ -32,7 +32,7 @@ AtkText
@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
</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:
@@ -59,6 +58,20 @@ AtkText
@ATK_TEXT_BOUNDARY_LINE_START:
@ATK_TEXT_BOUNDARY_LINE_END:
+<!-- ##### STRUCT AtkAttribute ##### -->
+<para>
+
+</para>
+
+@name:
+@value:
+
+<!-- ##### TYPEDEF AtkAttributeSet ##### -->
+<para>
+
+</para>
+
+
<!-- ##### FUNCTION atk_text_get_text ##### -->
<para>
@@ -88,10 +101,10 @@ AtkText
@text:
@offset:
@boundary_type:
-@Returns:
-<!-- # Unused Parameters # -->
@start_offset:
@end_offset:
+@Returns:
+<!-- # Unused Parameters # -->
@startOffset:
@endOffset:
@@ -104,10 +117,10 @@ AtkText
@text:
@offset:
@boundary_type:
-@Returns:
-<!-- # Unused Parameters # -->
@start_offset:
@end_offset:
+@Returns:
+<!-- # Unused Parameters # -->
@startOffset:
@endOffset:
@@ -120,10 +133,10 @@ AtkText
@text:
@offset:
@boundary_type:
-@Returns:
-<!-- # Unused Parameters # -->
@start_offset:
@end_offset:
+@Returns:
+<!-- # Unused Parameters # -->
@startOffset:
@endOffset:
@@ -146,11 +159,23 @@ AtkText
@offset:
@x:
@y:
-@length:
@width:
-<!-- # Unused Parameters # -->
@height:
@coords:
+<!-- # Unused Parameters # -->
+@length:
+
+
+<!-- ##### FUNCTION atk_text_ref_run_attributes ##### -->
+<para>
+
+</para>
+
+@text:
+@offset:
+@start_offset:
+@end_offset:
+@Returns:
<!-- ##### FUNCTION atk_text_get_character_count ##### -->
@@ -170,9 +195,8 @@ AtkText
@text:
@x:
@y:
-@Returns:
-<!-- # Unused Parameters # -->
@coords:
+@Returns:
<!-- ##### FUNCTION atk_text_get_n_selections ##### -->
@@ -239,3 +263,200 @@ AtkText
@Returns:
+<!-- ##### FUNCTION atk_attribute_set_free ##### -->
+<para>
+
+</para>
+
+@attrib_set:
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_LEFT_MARGIN ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_RIGHT_MARGIN ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_INDENT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_INVISIBLE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_EDITABLE ##### -->
+<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_BG_FULL_HEIGHT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_RISE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_UNDERLINE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_STRIKETHROUGH ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_SIZE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_SCALE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_WEIGHT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_LANGUAGE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_FAMILY_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_BG_COLOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_FG_COLOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_BG_STIPPLE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_FG_STIPPLE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_WRAP_MODE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_DIRECTION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_JUSTIFICATION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_STRETCH ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_VARIANT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO ATK_ATTRIBUTE_STYLE ##### -->
+<para>
+
+</para>
+
+
+
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.
</para>
+<!-- ##### ENUM AtkCoordType ##### -->
+<para>
+
+</para>
+
+@ATK_XY_SCREEN:
+@ATK_XY_WINDOW:
+
<!-- ##### FUNCTION atk_add_focus_tracker ##### -->
<para>
@@ -47,3 +55,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:
+
+