From b120d2904a4b901b181c26c6f6f77d83e26a0e07 Mon Sep 17 00:00:00 2001 From: Tim Janik Date: Fri, 26 Oct 2001 14:03:39 +0000 Subject: [PATCH] doc building updates. --- docs/tmpl/atk-unused.sgml | 459 ++++++++++++++++++++++++++++++++++++ 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 | 11 - 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 ---- 13 files changed, 516 insertions(+), 376 deletions(-) diff --git a/docs/tmpl/atk-unused.sgml b/docs/tmpl/atk-unused.sgml index d81c262..66e0c4a 100644 --- a/docs/tmpl/atk-unused.sgml +++ b/docs/tmpl/atk-unused.sgml @@ -18,3 +18,462 @@ 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 f744c7d..689dd42 100644 --- a/docs/tmpl/atkaction.sgml +++ b/docs/tmpl/atkaction.sgml @@ -33,9 +33,7 @@ be manipulated should support this interface. @do_action: @get_n_actions: @get_description: -@get_name: @get_keybinding: -@set_description: @@ -44,6 +42,7 @@ be manipulated should support this interface. @action: @i: + @Returns: @@ -66,16 +65,6 @@ be manipulated should support this interface. @Returns: - - - - - -@action: -@i: -@Returns: - - @@ -86,14 +75,3 @@ be manipulated should support this interface. @Returns: - - - - - -@action: -@i: -@desc: -@Returns: - - diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index bde93a5..9da63e1 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -31,9 +31,10 @@ representation of an object. @parent: @add_focus_handler: @contains: -@ref_accessible_at_point: +@get_accessible_at_point: @get_extents: @get_position: +@get_position_on_screen: @get_size: @grab_focus: @remove_focus_handler: @@ -59,8 +60,9 @@ representation of an object. @component: @x: @y: -@coord_type: @Returns: + +@coord_type: @@ -73,6 +75,7 @@ representation of an object. @y: @width: @height: + @coord_type: @@ -84,6 +87,7 @@ representation of an object. @component: @x: @y: + @coord_type: @@ -103,18 +107,7 @@ representation of an object. @component: -@Returns: - - - - - - - -@component: -@x: -@y: -@coord_type: + @Returns: @@ -137,6 +130,7 @@ representation of an object. @y: @width: @height: + @coord_type: @Returns: @@ -149,6 +143,7 @@ representation of an object. @component: @x: @y: + @coord_type: @Returns: @@ -161,6 +156,7 @@ representation of an object. @component: @width: @height: + @Returns: diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml index 5972540..5d7ef8d 100644 --- a/docs/tmpl/atkdocument.sgml +++ b/docs/tmpl/atkdocument.sgml @@ -14,36 +14,3 @@ AtkDocument - - - - - - - - - - - -@parent: -@get_document_type: -@get_document: - - - - - - -@document: -@Returns: - - - - - - - -@document: -@Returns: - - diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml index 1f9d147..84327f7 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_run_attributes: +@set_attributes: @set_text_contents: @insert_text: @copy_text: @@ -35,18 +35,6 @@ 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 8d0a6bc..7045bda 100644 --- a/docs/tmpl/atkimage.sgml +++ b/docs/tmpl/atkimage.sgml @@ -28,22 +28,12 @@ an assistive technology to get descriptive information about images. @parent: -@get_image_position: +@get_storage_type: @get_image_description: -@get_image_size: +@get_image_height: +@get_image_width: @set_image_description: - - - - - -@image: -@x: -@y: -@coord_type: - - @@ -63,13 +53,3 @@ 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 0655016..9b1cb09 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -83,7 +83,6 @@ 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: @@ -289,13 +288,3 @@ of the other ATK interfaces: @handler_id: - - - - - -@accessible: -@state: -@value: - - diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index 300a0d8..0169daa 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -45,6 +45,7 @@ can be selected should support the AtkSelection interface. @selection: @i: + @Returns: @@ -54,6 +55,7 @@ can be selected should support the AtkSelection interface. @selection: + @Returns: @@ -93,6 +95,7 @@ can be selected should support the AtkSelection interface. @selection: @i: + @Returns: @@ -102,6 +105,7 @@ can be selected should support the AtkSelection interface. @selection: + @Returns: diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml index a881058..b7027f3 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -29,7 +29,6 @@ AtkStates. @ATK_STATE_COLLAPSED: @ATK_STATE_DEFUNCT: @ATK_STATE_EDITABLE: -@ATK_STATE_ENABLED: @ATK_STATE_EXPANDABLE: @ATK_STATE_EXPANDED: @ATK_STATE_FOCUSABLE: @@ -47,7 +46,6 @@ 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 65bcdfe..c58b53b 100644 --- a/docs/tmpl/atkstreamablecontent.sgml +++ b/docs/tmpl/atkstreamablecontent.sgml @@ -15,32 +15,3 @@ 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 9dbab84..a1b1fcc 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -28,39 +28,29 @@ AtkTable @parent: @ref_at: @get_index_at: -@get_column_at_index: @get_row_at_index: -@get_n_columns: -@get_n_rows: -@get_column_extent_at: -@get_row_extent_at: +@get_column_at_index: @get_caption: +@get_n_columns: @get_column_description: +@get_column_extent_at: @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: @@ -169,10 +159,10 @@ AtkTable @table: -@row: +@r: @Returns: -@r: +@row: @@ -181,8 +171,9 @@ AtkTable @table: -@column: @Returns: + +@column: @@ -191,8 +182,9 @@ AtkTable @table: -@row: @Returns: + +@row: @@ -210,9 +202,9 @@ AtkTable @table: -@caption: - @accessible: + +@caption: @@ -222,9 +214,9 @@ AtkTable @table: @row: -@description: - @accessible: + +@description: @@ -234,9 +226,9 @@ AtkTable @table: @column: -@description: - @accessible: + +@description: @@ -274,8 +266,9 @@ AtkTable @table: -@selected: @Returns: + +@selected: @@ -284,8 +277,9 @@ AtkTable @table: -@selected: @Returns: + +@selected: @@ -319,43 +313,3 @@ 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 95b3dd4..f06b944 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -32,8 +32,7 @@ AtkText @get_character_at_offset: @get_text_before_offset: @get_caret_offset: -@get_run_attributes: -@get_default_attributes: +@get_range_attributes: @get_character_extents: @get_character_count: @get_offset_at_point: @@ -52,6 +51,7 @@ 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,53 +59,6 @@ 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: - @@ -135,10 +88,10 @@ AtkText @text: @offset: @boundary_type: -@start_offset: -@end_offset: @Returns: +@start_offset: +@end_offset: @startOffset: @endOffset: @@ -151,10 +104,10 @@ AtkText @text: @offset: @boundary_type: -@start_offset: -@end_offset: @Returns: +@start_offset: +@end_offset: @startOffset: @endOffset: @@ -167,10 +120,10 @@ AtkText @text: @offset: @boundary_type: -@start_offset: -@end_offset: @Returns: +@start_offset: +@end_offset: @startOffset: @endOffset: @@ -193,32 +146,11 @@ AtkText @offset: @x: @y: +@length: @width: + @height: @coords: - -@length: - - - - - - - -@text: -@offset: -@start_offset: -@end_offset: -@Returns: - - - - - - - -@text: -@Returns: @@ -238,8 +170,9 @@ AtkText @text: @x: @y: -@coords: @Returns: + +@coords: @@ -306,30 +239,3 @@ AtkText @Returns: - - - - - -@attrib_set: - - - - - - - -@attr: -@Returns: - - - - - - - -@attr: -@index: -@Returns: - - diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml index 027f90e..062101e 100644 --- a/docs/tmpl/atkutil.sgml +++ b/docs/tmpl/atkutil.sgml @@ -14,14 +14,6 @@ The AtkUtility interface provides general purpose utility functions. - - - - - -@ATK_XY_SCREEN: -@ATK_XY_WINDOW: - @@ -55,45 +47,3 @@ The AtkUtility interface provides general purpose utility functions. @object: - - - - - -@listener: -@event_type: -@Returns: - - - - - - - -@listener_id: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - -- 2.7.4