docs/tmpl/atktext.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkText
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 accessibility interface for text widgets
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 AtkText provides an accessibility interface for text widgets
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### STRUCT AtkText ##### -->
  18 <para>
  19
  20 </para>
  21
  22
  23 <!-- ##### STRUCT AtkTextIface ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @parent:
  29 @get_text:
  30 @get_text_after_offset:
  31 @get_text_at_offset:
  32 @get_character_at_offset:
  33 @get_text_before_offset:
  34 @get_caret_offset:
  35 @get_row_col_at_offset:
  36 @get_range_attributes:
  37 @get_character_extents:
  38 @get_character_count:
  39 @get_offset_at_point:
  40 @get_selected_text:
  41 @get_selection_bounds:
  42 @set_selection_bounds:
  43 @set_caret_offset:
  44 @text_changed:
  45 @caret_changed:
  46
  47 <!-- ##### ENUM AtkTextBoundary ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @ATK_TEXT_BOUNDARY_CHAR:
  53 @ATK_TEXT_BOUNDARY_CURSOR_POS:
  54 @ATK_TEXT_BOUNDARY_WORD_START:
  55 @ATK_TEXT_BOUNDARY_WORD_END:
  56 @ATK_TEXT_BOUNDARY_SENTENCE_START:
  57 @ATK_TEXT_BOUNDARY_SENTENCE_END:
  58 @ATK_TEXT_BOUNDARY_LINE_START:
  59 @ATK_TEXT_BOUNDARY_LINE_END:
  60
  61 <!-- ##### FUNCTION atk_text_get_text ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @text:
  67 @start_offset:
  68 @end_offset:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @text:
  78 @offset:
  79 @Returns:
  80
  81
  82 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @text:
  88 @offset:
  89 @boundary_type:
  90 @Returns:
  91
  92
  93 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @text:
  99 @offset:
 100 @boundary_type:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @text:
 110 @offset:
 111 @boundary_type:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @text:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION atk_text_get_row_col_at_offset ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @text:
 130 @offset:
 131 @row:
 132 @col:
 133
 134
 135 <!-- ##### FUNCTION atk_text_get_range_attributes ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @text:
 141 @start_offset:
 142 @end_offset:
 143 @Returns:
 144
 145
 146 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @text:
 152 @offset:
 153 @x:
 154 @y:
 155 @length:
 156 @width:
 157
 158
 159 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @text:
 165 @Returns:
 166
 167
 168 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @text:
 174 @x:
 175 @y:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION atk_text_get_selected_text ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @text:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION atk_text_get_selection_bounds ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @text:
 194 @start_offset:
 195 @end_offset:
 196
 197
 198 <!-- ##### FUNCTION atk_text_set_selection_bounds ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @text:
 204 @start_offset:
 205 @end_offset:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @text:
 215 @offset:
 216 @Returns:
 217
 218