Added new API for ATK 1.11/1.12. Minor docs cleanup.
[platform/upstream/atk.git] / docs / tmpl / atkeditabletext.sgml
1 <!-- ##### SECTION Title ##### -->
2 AtkEditableText
3
4 <!-- ##### SECTION Short_Description ##### -->
5 The ATK interface implemented by components containing user-editable text content.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 #AtkEditableText should be implemented by UI components which contain
10 text which the user can edit, via the #AtkObject corresponding to that
11 component (see #AtkObject).
12 </para>
13 <para>
14 #AtkEditableText is a subclass of #AtkText, and as such, an object which
15 implements #AtkEditableText is by definition an #AtkText implementor as well.
16 </para>
17
18 <!-- ##### SECTION See_Also ##### -->
19 <para>
20 #AtkText
21 </para>
22
23 <!-- ##### SECTION Stability_Level ##### -->
24
25
26 <!-- ##### STRUCT AtkEditableText ##### -->
27 <para>
28 The AtkEditableText structure does not contain any fields.
29
30 </para>
31
32
33 <!-- ##### FUNCTION atk_editable_text_set_run_attributes ##### -->
34 <para>
35
36 </para>
37
38 @text: 
39 @attrib_set: 
40 @start_offset: 
41 @end_offset: 
42 @Returns: 
43
44
45 <!-- ##### FUNCTION atk_editable_text_set_text_contents ##### -->
46 <para>
47
48 </para>
49
50 @text: 
51 @string: 
52
53
54 <!-- ##### FUNCTION atk_editable_text_insert_text ##### -->
55 <para>
56
57 </para>
58
59 @text: 
60 @string: 
61 @length: 
62 @position: 
63
64
65 <!-- ##### FUNCTION atk_editable_text_copy_text ##### -->
66 <para>
67
68 </para>
69
70 @text: 
71 @start_pos: 
72 @end_pos: 
73
74
75 <!-- ##### FUNCTION atk_editable_text_cut_text ##### -->
76 <para>
77
78 </para>
79
80 @text: 
81 @start_pos: 
82 @end_pos: 
83
84
85 <!-- ##### FUNCTION atk_editable_text_delete_text ##### -->
86 <para>
87
88 </para>
89
90 @text: 
91 @start_pos: 
92 @end_pos: 
93
94
95 <!-- ##### FUNCTION atk_editable_text_paste_text ##### -->
96 <para>
97
98 </para>
99
100 @text: 
101 @position: 
102
103