Added descriptive documentation of the ATK interfaces, primarily
[atk.git] / docs / tmpl / atkeditabletext.sgml
blob7fb992ec7fdb74129c40d2a69d445c3a7f646adb
1 <!-- ##### SECTION Title ##### -->
2 AtkEditableText
4 <!-- ##### SECTION Short_Description ##### -->
5 ATK Interface implemented by components containing user-editable text content.
6 <!-- ##### SECTION Long_Description ##### -->
7 <para>
8 #AtkEditableText should be implemented by UI components which contain
9 text which the user can edit, via the #AtkObject corresponding to that
10 component (see #AtkObject).
11 </para>
12 <para>
13 #AtkEditableText is a subclass of #AtkText, and as such, an object which
14 implements #AtkEditableText is by definition an #AtkText implementor as well.
15 </para>
17 <!-- ##### SECTION See_Also ##### -->
18 <para>
19 #AtkText
20 </para>
22 <!-- ##### STRUCT AtkEditableText ##### -->
23 <para>
25 </para>
28 <!-- ##### STRUCT AtkEditableTextIface ##### -->
29 <para>
31 </para>
33 @parent_interface:
34 @set_run_attributes:
35 @set_text_contents:
36 @insert_text:
37 @copy_text:
38 @cut_text:
39 @delete_text:
40 @paste_text:
42 <!-- ##### FUNCTION atk_editable_text_set_run_attributes ##### -->
43 <para>
45 </para>
47 @text:
48 @attrib_set:
49 @start_offset:
50 @end_offset:
51 @Returns:
54 <!-- ##### FUNCTION atk_editable_text_set_text_contents ##### -->
55 <para>
57 </para>
59 @text:
60 @string:
63 <!-- ##### FUNCTION atk_editable_text_insert_text ##### -->
64 <para>
66 </para>
68 @text:
69 @string:
70 @length:
71 @position:
74 <!-- ##### FUNCTION atk_editable_text_copy_text ##### -->
75 <para>
77 </para>
79 @text:
80 @start_pos:
81 @end_pos:
84 <!-- ##### FUNCTION atk_editable_text_cut_text ##### -->
85 <para>
87 </para>
89 @text:
90 @start_pos:
91 @end_pos:
94 <!-- ##### FUNCTION atk_editable_text_delete_text ##### -->
95 <para>
97 </para>
99 @text:
100 @start_pos:
101 @end_pos:
104 <!-- ##### FUNCTION atk_editable_text_paste_text ##### -->
105 <para>
107 </para>
109 @text:
110 @position: