docs/tmpl/atktext.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkText
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  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 @ref_run_attributes:
  36 @get_character_extents:
  37 @get_character_count:
  38 @get_offset_at_point:
  39 @get_n_selections:
  40 @get_selection:
  41 @add_selection:
  42 @remove_selection:
  43 @set_selection:
  44 @set_caret_offset:
  45 @text_changed:
  46 @caret_changed:
  47
  48 <!-- ##### ENUM AtkTextBoundary ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @ATK_TEXT_BOUNDARY_CHAR:
  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 <!-- ##### STRUCT AtkAttribute ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @name:
  67 @value:
  68
  69 <!-- ##### TYPEDEF AtkAttributeSet ##### -->
  70 <para>
  71
  72 </para>
  73
  74
  75 <!-- ##### FUNCTION atk_text_get_text ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @text:
  81 @start_offset:
  82 @end_offset:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @text:
  92 @offset:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @text:
 102 @offset:
 103 @boundary_type:
 104 @start_offset:
 105 @end_offset:
 106 @Returns:
 107 <!-- # Unused Parameters # -->
 108 @startOffset:
 109 @endOffset:
 110
 111
 112 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @text:
 118 @offset:
 119 @boundary_type:
 120 @start_offset:
 121 @end_offset:
 122 @Returns:
 123 <!-- # Unused Parameters # -->
 124 @startOffset:
 125 @endOffset:
 126
 127
 128 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @text:
 134 @offset:
 135 @boundary_type:
 136 @start_offset:
 137 @end_offset:
 138 @Returns:
 139 <!-- # Unused Parameters # -->
 140 @startOffset:
 141 @endOffset:
 142
 143
 144 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @text:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @text:
 159 @offset:
 160 @x:
 161 @y:
 162 @width:
 163 @height:
 164 @coords:
 165 <!-- # Unused Parameters # -->
 166 @length:
 167
 168
 169 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @text:
 175 @Returns:
 176
 177
 178 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @text:
 184 @x:
 185 @y:
 186 @coords:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @text:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @text:
 205 @selection_num:
 206 @start_offset:
 207 @end_offset:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @text:
 217 @start_offset:
 218 @end_offset:
 219 @Returns:
 220
 221
 222 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 223 <para>
 224
 225 </para>
 226
 227 @text:
 228 @selection_num:
 229 @Returns:
 230
 231
 232 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @text:
 238 @selection_num:
 239 @start_offset:
 240 @end_offset:
 241 @Returns:
 242
 243
 244 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @text:
 250 @offset:
 251 @Returns:
 252
 253
 254 <!-- ##### FUNCTION atk_attribute_set_free ##### -->
 255 <para>
 256
 257 </para>
 258
 259 @attrib_set:
 260
 261