Add new function atk_text_get_default_attributes Rename
[platform/upstream/atk.git] / docs / tmpl / atktext.sgml
index 8ae9d43..61f3c4b 100644 (file)
@@ -2,11 +2,11 @@
 AtkText
 
 <!-- ##### SECTION Short_Description ##### -->
-accessibility interface for text widgets
+
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-AtkText provides an accessibility interface for text widgets
+
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -32,14 +32,16 @@ AtkText provides an accessibility interface for text widgets
 @get_character_at_offset: 
 @get_text_before_offset: 
 @get_caret_offset: 
-@get_row_col_at_offset
-@get_range_attributes: 
+@get_run_attributes
+@get_default_attributes: 
 @get_character_extents: 
 @get_character_count: 
 @get_offset_at_point: 
-@get_selected_text: 
-@get_selection_bounds: 
-@set_selection_bounds: 
+@get_n_selections: 
+@get_selection: 
+@add_selection: 
+@remove_selection: 
+@set_selection: 
 @set_caret_offset: 
 @text_changed: 
 @caret_changed: 
@@ -50,7 +52,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: 
@@ -58,6 +59,20 @@ AtkText provides an accessibility interface for text widgets
 @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>
 
@@ -87,7 +102,12 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @offset: 
 @boundary_type: 
+@start_offset: 
+@end_offset: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@startOffset: 
+@endOffset: 
 
 
 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
@@ -98,7 +118,12 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @offset: 
 @boundary_type: 
+@start_offset: 
+@end_offset: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@startOffset: 
+@endOffset: 
 
 
 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
@@ -109,7 +134,12 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @offset: 
 @boundary_type: 
+@start_offset: 
+@end_offset: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@startOffset: 
+@endOffset: 
 
 
 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
@@ -121,39 +151,41 @@ AtkText provides an accessibility interface for text widgets
 @Returns: 
 
 
-<!-- ##### FUNCTION atk_text_get_row_col_at_offset ##### -->
+<!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 <para>
 
 </para>
 
 @text: 
 @offset: 
-@row: 
-@col: 
+@x: 
+@y: 
+@width: 
+@height: 
+@coords: 
+<!-- # Unused Parameters # -->
+@length: 
 
 
-<!-- ##### FUNCTION atk_text_get_range_attributes ##### -->
+<!-- ##### FUNCTION atk_text_get_run_attributes ##### -->
 <para>
 
 </para>
 
 @text: 
+@offset: 
 @start_offset: 
 @end_offset: 
 @Returns: 
 
 
-<!-- ##### FUNCTION atk_text_get_character_extents ##### -->
+<!-- ##### FUNCTION atk_text_get_default_attributes ##### -->
 <para>
 
 </para>
 
 @text: 
-@offset: 
-@x: 
-@y: 
-@length: 
-@width: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
@@ -173,10 +205,11 @@ AtkText provides an accessibility interface for text widgets
 @text: 
 @x: 
 @y: 
+@coords: 
 @Returns: 
 
 
-<!-- ##### FUNCTION atk_text_get_selected_text ##### -->
+<!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 <para>
 
 </para>
@@ -185,17 +218,19 @@ AtkText provides an accessibility interface for text widgets
 @Returns: 
 
 
-<!-- ##### FUNCTION atk_text_get_selection_bounds ##### -->
+<!-- ##### FUNCTION atk_text_get_selection ##### -->
 <para>
 
 </para>
 
 @text: 
+@selection_num: 
 @start_offset: 
 @end_offset: 
+@Returns: 
 
 
-<!-- ##### FUNCTION atk_text_set_selection_bounds ##### -->
+<!-- ##### FUNCTION atk_text_add_selection ##### -->
 <para>
 
 </para>
@@ -206,6 +241,28 @@ AtkText provides an accessibility interface for text widgets
 @Returns: 
 
 
+<!-- ##### FUNCTION atk_text_remove_selection ##### -->
+<para>
+
+</para>
+
+@text: 
+@selection_num: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_text_set_selection ##### -->
+<para>
+
+</para>
+
+@text: 
+@selection_num: 
+@start_offset: 
+@end_offset: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 <para>
 
@@ -216,3 +273,200 @@ AtkText provides an accessibility interface for text widgets
 @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>
+
+
+