← Back to branch summary

~ubuntu-branches/ubuntu/lucid/at-spi/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/cspi/xml/spi_editabletext.xml

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2010-07-02 15:50:32 UTC
  • mfrom: (1.2.1 upstream) (0.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20100702155032-mw7vioq2owm3a809
Tags: 1.30.1-0ubuntu1
https://launchpad.net/bugs/600906
* New upstream release (LP: #600906)
  -  Fixes GNOME bugzilla #538680, collection.getMatchesTo() seems to ignore
     the count.
  - Updated translations:

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/xml/spi_editabletext.xml
1
 
<refentry id="at-spi-cspi-AccessibleEditableText-Interface">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="at-spi-cspi-AccessibleEditableText-Interface.top_of_page">AccessibleEditableText Interface</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>AT-SPI-CSPI Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>AccessibleEditableText Interface</refname>
10
 
<refpurpose>An interface which allows editable text fields to be programmatically manipulated.</refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="at-spi-cspi-AccessibleEditableText-Interface.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
<link linkend="void">void</link>                <link linkend="AccessibleEditableText-ref">AccessibleEditableText_ref</link>          (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj);
18
 
<link linkend="void">void</link>                <link linkend="AccessibleEditableText-unref">AccessibleEditableText_unref</link>        (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj);
19
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-copyText">AccessibleEditableText_copyText</link>     (<link linkend="AccessibleText">AccessibleText</link> *obj,
20
 
                                                         long <link linkend="int">int</link> startPos,
21
 
                                                         long <link linkend="int">int</link> endPos);
22
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-deleteText">AccessibleEditableText_deleteText</link>   (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
23
 
                                                         long <link linkend="int">int</link> startPos,
24
 
                                                         long <link linkend="int">int</link> endPos);
25
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-insertText">AccessibleEditableText_insertText</link>   (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
26
 
                                                         long <link linkend="int">int</link> position,
27
 
                                                         const <link linkend="char">char</link> *text,
28
 
                                                         long <link linkend="int">int</link> length);
29
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-cutText">AccessibleEditableText_cutText</link>      (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
30
 
                                                         long <link linkend="int">int</link> startPos,
31
 
                                                         long <link linkend="int">int</link> endPos);
32
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-pasteText">AccessibleEditableText_pasteText</link>    (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
33
 
                                                         long <link linkend="int">int</link> position);
34
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-setTextContents">AccessibleEditableText_setTextContents</link>
35
 
                                                        (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
36
 
                                                         const <link linkend="char">char</link> *newContents);
37
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleEditableText-setAttributes">AccessibleEditableText_setAttributes</link>
38
 
                                                        (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
39
 
                                                         const <link linkend="char">char</link> *attributes,
40
 
                                                         long <link linkend="int">int</link> startOffset,
41
 
                                                         long <link linkend="int">int</link> endOffset);
42
 
</synopsis>
43
 
</refsynopsisdiv>
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
<refsect1 id="at-spi-cspi-AccessibleEditableText-Interface.description" role="desc">
54
 
<title role="desc.title">Description</title>
55
 
<para>
56
 
An interface implemented by objects whose text content may be (potentially or
57
 
actually) directly modified by user activity.  Text entry fields and text
58
 
editor compose panes are examples of EditableText implementors.
59
 
</para>
60
 
</refsect1>
61
 
 
62
 
<refsect1 id="at-spi-cspi-AccessibleEditableText-Interface.details" role="details">
63
 
<title role="details.title">Details</title>
64
 
<refsect2 id="AccessibleEditableText-ref" role="function">
65
 
<title>AccessibleEditableText_ref ()</title>
66
 
<indexterm zone="AccessibleEditableText-ref"><primary sortas="AccessibleEditableText_ref">AccessibleEditableText_ref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleEditableText_ref          (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj);</programlisting>
67
 
<para>
68
 
Increment the reference count for an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object.
69
 
      Since AccessibleEditableText is derived from AccessibleText,
70
 
      this is the same as <link linkend="AccessibleText-ref"><function>AccessibleText_ref()</function></link>.</para>
71
 
<para>
72
 
</para><variablelist role="params">
73
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
74
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object on which to operate.
75
 
</simpara></listitem></varlistentry>
76
 
</variablelist></refsect2>
77
 
<refsect2 id="AccessibleEditableText-unref" role="function">
78
 
<title>AccessibleEditableText_unref ()</title>
79
 
<indexterm zone="AccessibleEditableText-unref"><primary sortas="AccessibleEditableText_unref">AccessibleEditableText_unref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleEditableText_unref        (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj);</programlisting>
80
 
<para>
81
 
Decrement the reference count for an <link linkend="AccessibleEdiitableText"><type>AccessibleEdiitableText</type></link> object.
82
 
      Since AccessibleEditableText is derived from AccessibleText,
83
 
      this is the same as <link linkend="AccessibleText-unref"><function>AccessibleText_unref()</function></link>.</para>
84
 
<para>
85
 
</para><variablelist role="params">
86
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
87
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object on which to operate.
88
 
</simpara></listitem></varlistentry>
89
 
</variablelist></refsect2>
90
 
<refsect2 id="AccessibleEditableText-copyText" role="function">
91
 
<title>AccessibleEditableText_copyText ()</title>
92
 
<indexterm zone="AccessibleEditableText-copyText"><primary sortas="AccessibleEditableText_copyText">AccessibleEditableText_copyText</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_copyText     (<link linkend="AccessibleText">AccessibleText</link> *obj,
93
 
                                                         long <link linkend="int">int</link> startPos,
94
 
                                                         long <link linkend="int">int</link> endPos);</programlisting>
95
 
<para>
96
 
Copy text from an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object into the clipboard.
97
 
</para>
98
 
<para>
99
 
<parameter>see</parameter>: AccessibleEditableText_pasteText</para>
100
 
<para>
101
 
</para><variablelist role="params">
102
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
103
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><parameter>startPos</parameter>&#160;:</term>
106
 
<listitem><simpara> an integer indicating the starting character offset
107
 
      of the text to copy.
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>endPos</parameter>&#160;:</term>
110
 
<listitem><simpara> an integer indicating the offset of the first character
111
 
      past the end of the text section to be copied.
112
 
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the operation was successful, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
114
 
</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2>
116
 
<refsect2 id="AccessibleEditableText-deleteText" role="function">
117
 
<title>AccessibleEditableText_deleteText ()</title>
118
 
<indexterm zone="AccessibleEditableText-deleteText"><primary sortas="AccessibleEditableText_deleteText">AccessibleEditableText_deleteText</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_deleteText   (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
119
 
                                                         long <link linkend="int">int</link> startPos,
120
 
                                                         long <link linkend="int">int</link> endPos);</programlisting>
121
 
<para>
122
 
Delete text from an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object, without copying the
123
 
      excised portion into the clipboard.
124
 
</para>
125
 
<para>
126
 
<parameter>see</parameter>: AccessibleEditableText_cutText</para>
127
 
<para>
128
 
</para><variablelist role="params">
129
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
130
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
131
 
</simpara></listitem></varlistentry>
132
 
<varlistentry><term><parameter>startPos</parameter>&#160;:</term>
133
 
<listitem><simpara> an integer indicating the starting character offset
134
 
      of the text to delete.
135
 
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><parameter>endPos</parameter>&#160;:</term>
137
 
<listitem><simpara> an integer indicating the offset of the first character
138
 
      past the end of the text section to be deleted.
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the operation was successful, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
<refsect2 id="AccessibleEditableText-insertText" role="function">
144
 
<title>AccessibleEditableText_insertText ()</title>
145
 
<indexterm zone="AccessibleEditableText-insertText"><primary sortas="AccessibleEditableText_insertText">AccessibleEditableText_insertText</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_insertText   (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
146
 
                                                         long <link linkend="int">int</link> position,
147
 
                                                         const <link linkend="char">char</link> *text,
148
 
                                                         long <link linkend="int">int</link> length);</programlisting>
149
 
<para>
150
 
Insert text into an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object.
151
 
As with all character offsets, the specified <parameter>position</parameter> may not be the
152
 
      same as the resulting byte offset, since the text is in a
153
 
      variable-width encoding.</para>
154
 
<para>
155
 
</para><variablelist role="params">
156
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
157
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
158
 
</simpara></listitem></varlistentry>
159
 
<varlistentry><term><parameter>position</parameter>&#160;:</term>
160
 
<listitem><simpara> an integer indicating the character offset at which to insert
161
 
      the new text.  
162
 
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><parameter>text</parameter>&#160;:</term>
164
 
<listitem><simpara> a char* pointer to the text to insert, in UTF-8 encoding.
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
167
 
<listitem><simpara> (frankly I'm not sure this parameter should be here)
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the operation was successful, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
170
 
</simpara></listitem></varlistentry>
171
 
</variablelist></refsect2>
172
 
<refsect2 id="AccessibleEditableText-cutText" role="function">
173
 
<title>AccessibleEditableText_cutText ()</title>
174
 
<indexterm zone="AccessibleEditableText-cutText"><primary sortas="AccessibleEditableText_cutText">AccessibleEditableText_cutText</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_cutText      (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
175
 
                                                         long <link linkend="int">int</link> startPos,
176
 
                                                         long <link linkend="int">int</link> endPos);</programlisting>
177
 
<para>
178
 
Delete text from an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object, copying the
179
 
      excised portion into the clipboard.
180
 
</para>
181
 
<para>
182
 
<parameter>see</parameter>: AccessibleEditableText_pasteText</para>
183
 
<para>
184
 
</para><variablelist role="params">
185
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
186
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
187
 
</simpara></listitem></varlistentry>
188
 
<varlistentry><term><parameter>startPos</parameter>&#160;:</term>
189
 
<listitem><simpara> an integer indicating the starting character offset
190
 
      of the text to cut.
191
 
</simpara></listitem></varlistentry>
192
 
<varlistentry><term><parameter>endPos</parameter>&#160;:</term>
193
 
<listitem><simpara> an integer indicating the offset of the first character
194
 
      past the end of the text section to be cut.
195
 
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if operation was successful, <link linkend="FALSE--CAPS"><type>FALSE</type></link> otherwise.
197
 
</simpara></listitem></varlistentry>
198
 
</variablelist></refsect2>
199
 
<refsect2 id="AccessibleEditableText-pasteText" role="function">
200
 
<title>AccessibleEditableText_pasteText ()</title>
201
 
<indexterm zone="AccessibleEditableText-pasteText"><primary sortas="AccessibleEditableText_pasteText">AccessibleEditableText_pasteText</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_pasteText    (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
202
 
                                                         long <link linkend="int">int</link> position);</programlisting>
203
 
<para>
204
 
Insert text from the clipboard into an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object.
205
 
As with all character offsets, the specified <parameter>position</parameter> may not be the
206
 
      same as the resulting byte offset, since the text is in a
207
 
      variable-width encoding.</para>
208
 
<para>
209
 
</para><variablelist role="params">
210
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
211
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
212
 
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><parameter>position</parameter>&#160;:</term>
214
 
<listitem><simpara> an integer indicating the character offset at which to insert
215
 
      the new text.  
216
 
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the operation was successful, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
218
 
</simpara></listitem></varlistentry>
219
 
</variablelist></refsect2>
220
 
<refsect2 id="AccessibleEditableText-setTextContents" role="function">
221
 
<title>AccessibleEditableText_setTextContents ()</title>
222
 
<indexterm zone="AccessibleEditableText-setTextContents"><primary sortas="AccessibleEditableText_setTextContents">AccessibleEditableText_setTextContents</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_setTextContents
223
 
                                                        (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
224
 
                                                         const <link linkend="char">char</link> *newContents);</programlisting>
225
 
<para>
226
 
Replace the entire text contents of an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object.</para>
227
 
<para>
228
 
</para><variablelist role="params">
229
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
230
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
231
 
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>newContents</parameter>&#160;:</term>
233
 
<listitem><simpara> a character string, encoded in UTF-8, which is to
234
 
     become the new text contents of the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object.
235
 
</simpara></listitem></varlistentry>
236
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the operation was successful, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
237
 
</simpara></listitem></varlistentry>
238
 
</variablelist></refsect2>
239
 
<refsect2 id="AccessibleEditableText-setAttributes" role="function">
240
 
<title>AccessibleEditableText_setAttributes ()</title>
241
 
<indexterm zone="AccessibleEditableText-setAttributes"><primary sortas="AccessibleEditableText_setAttributes">AccessibleEditableText_setAttributes</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleEditableText_setAttributes
242
 
                                                        (<link linkend="AccessibleEditableText">AccessibleEditableText</link> *obj,
243
 
                                                         const <link linkend="char">char</link> *attributes,
244
 
                                                         long <link linkend="int">int</link> startOffset,
245
 
                                                         long <link linkend="int">int</link> endOffset);</programlisting>
246
 
<para>
247
 
Set the attributes applied to a range of text from an <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link>
248
 
         object, and the bounds of the range.</para>
249
 
<para>
250
 
</para><variablelist role="params">
251
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
252
 
<listitem><simpara> a pointer to the <link linkend="AccessibleEditableText"><type>AccessibleEditableText</type></link> object to modify.
253
 
</simpara></listitem></varlistentry>
254
 
<varlistentry><term><parameter>attributes</parameter>&#160;:</term>
255
 
<listitem><simpara> a character string indicating the attributes to apply to the range,
256
 
       delimited by ':'.
257
 
</simpara></listitem></varlistentry>
258
 
<varlistentry><term><parameter>startOffset</parameter>&#160;:</term>
259
 
<listitem><simpara> a <link linkend="long"><type>long</type></link> indicating the start of the desired text range.
260
 
</simpara></listitem></varlistentry>
261
 
<varlistentry><term><parameter>endOffset</parameter>&#160;:</term>
262
 
<listitem><simpara> a <link linkend="long"><type>long</type></link> indicating the first character past the desired range.
263
 
</simpara></listitem></varlistentry>
264
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the operation was successful, otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
265
 
</simpara></listitem></varlistentry>
266
 
</variablelist></refsect2>
267
 
 
268
 
</refsect1>
269
 
 
270
 
 
271
 
 
272
 
 
273
 
</refentry>