1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>at-spi-idl: /export/home/wangke/at-spi/idl/Accessibility_Text.idl Source File</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
7
<!-- Generated by Doxygen 1.5.7.1 -->
8
<div class="navigation" id="top">
11
<li><a href="index.html"><span>Main Page</span></a></li>
12
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
13
<li><a href="annotated.html"><span>Data Structures</span></a></li>
14
<li class="current"><a href="files.html"><span>Files</span></a></li>
15
<li><a href="dirs.html"><span>Directories</span></a></li>
20
<li><a href="files.html"><span>File List</span></a></li>
23
<div class="navpath"><a class="el" href="dir_a7fbb50c70f6b5de3e726d4621996acc.html">idl</a>
26
<div class="contents">
27
<h1>Accessibility_Text.idl</h1><a href="Accessibility__Text_8idl.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* </span>
28
<a name="l00002"></a>00002 <span class="comment"> * AT-SPI - Assistive Technology Service Provider Interface </span>
29
<a name="l00003"></a>00003 <span class="comment"> * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)</span>
30
<a name="l00004"></a>00004 <span class="comment"> *</span>
31
<a name="l00005"></a>00005 <span class="comment"> * Copyright 2001 Sun Microsystems, Inc.</span>
32
<a name="l00006"></a>00006 <span class="comment"> *</span>
33
<a name="l00007"></a>00007 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
34
<a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Library General Public</span>
35
<a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span>
36
<a name="l00010"></a>00010 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span>
37
<a name="l00011"></a>00011 <span class="comment"> *</span>
38
<a name="l00012"></a>00012 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
39
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
40
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
41
<a name="l00015"></a>00015 <span class="comment"> * Library General Public License for more details.</span>
42
<a name="l00016"></a>00016 <span class="comment"> *</span>
43
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Library General Public</span>
44
<a name="l00018"></a>00018 <span class="comment"> * License along with this library; if not, write to the</span>
45
<a name="l00019"></a>00019 <span class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330,</span>
46
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02111-1307, USA.</span>
47
<a name="l00021"></a>00021 <span class="comment"> */</span>
48
<a name="l00022"></a>00022
49
<a name="l00023"></a>00023 module Accessibility {
50
<a name="l00024"></a>00024
51
<a name="l00029"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130">00029</a> <span class="keyword">enum</span> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130">TEXT_BOUNDARY_TYPE</a> {
52
<a name="l00030"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc91308a0a6227c0ce856740a0bc1744109a34">00030</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc91308a0a6227c0ce856740a0bc1744109a34">TEXT_BOUNDARY_CHAR</a>,
53
<a name="l00033"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130d269946aa3456236401e4cf23e554383">00033</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130d269946aa3456236401e4cf23e554383">TEXT_BOUNDARY_WORD_START</a>,
54
<a name="l00036"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc913015e725dca9637afbdbd6813c6d23eb70">00036</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc913015e725dca9637afbdbd6813c6d23eb70">TEXT_BOUNDARY_WORD_END</a>,
55
<a name="l00043"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130423416cb6e178a4688fa2b4d1b659413">00043</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130423416cb6e178a4688fa2b4d1b659413">TEXT_BOUNDARY_SENTENCE_START</a>,
56
<a name="l00049"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130ac3879f403792a017aba97577bb33beb">00049</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130ac3879f403792a017aba97577bb33beb">TEXT_BOUNDARY_SENTENCE_END</a>,
57
<a name="l00055"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130e9b0eb43d5a548eef806460540066c52">00055</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130e9b0eb43d5a548eef806460540066c52">TEXT_BOUNDARY_LINE_START</a>,
58
<a name="l00059"></a><a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130d15c31e3afa41f1614836e86c5a779a1">00059</a> <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130d15c31e3afa41f1614836e86c5a779a1">TEXT_BOUNDARY_LINE_END</a>
59
<a name="l00063"></a>00063 };
60
<a name="l00064"></a>00064
61
<a name="l00072"></a><a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d">00072</a> <span class="keyword">enum</span> <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d">TEXT_CLIP_TYPE</a> {
62
<a name="l00073"></a><a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7df8b284826300dc9e0e336a00b46a66c3">00073</a> <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7df8b284826300dc9e0e336a00b46a66c3">TEXT_CLIP_NONE</a>,
63
<a name="l00074"></a><a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d5d2c79c9ea44d75e89eae669e3d0ddbc">00074</a> <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d5d2c79c9ea44d75e89eae669e3d0ddbc">TEXT_CLIP_MIN</a>,
64
<a name="l00075"></a><a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d07cf12b22fcf585a3942ee3393df9509">00075</a> <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d07cf12b22fcf585a3942ee3393df9509">TEXT_CLIP_MAX</a>,
65
<a name="l00076"></a><a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7daaa4669d40e133f468ca464ac916bd67">00076</a> <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7daaa4669d40e133f468ca464ac916bd67">TEXT_CLIP_BOTH</a>
66
<a name="l00077"></a>00077 };
67
<a name="l00078"></a>00078
68
<a name="l00119"></a><a class="code" href="interfaceAccessibility_1_1Text.html">00119</a> interface <a class="code" href="interfaceAccessibility_1_1Text.html">Text</a> : Bonobo::Unknown {
69
<a name="l00120"></a>00120
70
<a name="l00124"></a><a class="code" href="structAccessibility_1_1Text_1_1Range.html">00124</a> <span class="keyword">struct </span><a class="code" href="structAccessibility_1_1Text_1_1Range.html">Range</a> {
71
<a name="l00125"></a><a class="code" href="structAccessibility_1_1Text_1_1Range.html#adbb561535b1ee39cf779e12091a1844">00125</a> <span class="keywordtype">long</span> startOffset;
72
<a name="l00126"></a><a class="code" href="structAccessibility_1_1Text_1_1Range.html#bcc0d49866dceb2a9d8090b993f04e5b">00126</a> <span class="keywordtype">long</span> endOffset;
73
<a name="l00127"></a><a class="code" href="structAccessibility_1_1Text_1_1Range.html#0b29ffd64c76a4c73d302b0234bd8088">00127</a> <span class="keywordtype">string</span> content;
74
<a name="l00128"></a><a class="code" href="structAccessibility_1_1Text_1_1Range.html#45666bf45fac3fa88ab7f4ce56817e62">00128</a> any data;
75
<a name="l00129"></a>00129 };
76
<a name="l00130"></a>00130
77
<a name="l00131"></a><a class="code" href="interfaceAccessibility_1_1Text.html#27aeba1ecd50aba1aa9fb8fe39f6e1f8">00131</a> <span class="keyword">typedef</span> sequence<Range> RangeList;
78
<a name="l00132"></a>00132
79
<a name="l00136"></a><a class="code" href="interfaceAccessibility_1_1Text.html#525e8e06584efc964f32f1d7f2c7ade9">00136</a> readonly attribute <span class="keywordtype">long</span> characterCount;
80
<a name="l00137"></a>00137
81
<a name="l00144"></a><a class="code" href="interfaceAccessibility_1_1Text.html#a95e0467813a17e6af426fbac6fd4323">00144</a> readonly attribute <span class="keywordtype">long</span> caretOffset;
82
<a name="l00145"></a>00145
83
<a name="l00156"></a>00156 <span class="keywordtype">string</span> getText (in <span class="keywordtype">long</span> startOffset, in <span class="keywordtype">long</span> endOffset);
84
<a name="l00157"></a>00157
85
<a name="l00164"></a>00164 <span class="keywordtype">boolean</span> setCaretOffset (in <span class="keywordtype">long</span> offset);
86
<a name="l00165"></a>00165
87
<a name="l00183"></a>00183 <span class="keywordtype">string</span> getTextBeforeOffset (in <span class="keywordtype">long</span> offset, in <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130">TEXT_BOUNDARY_TYPE</a> type,
88
<a name="l00184"></a>00184 out <span class="keywordtype">long</span> startOffset, out <span class="keywordtype">long</span> endOffset);
89
<a name="l00202"></a>00202 <span class="keywordtype">string</span> getTextAtOffset (in <span class="keywordtype">long</span> offset, in <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130">TEXT_BOUNDARY_TYPE</a> type,
90
<a name="l00203"></a>00203 out <span class="keywordtype">long</span> startOffset, out <span class="keywordtype">long</span> endOffset);
91
<a name="l00222"></a>00222 <span class="keywordtype">string</span> getTextAfterOffset (in <span class="keywordtype">long</span> offset, in <a class="code" href="namespaceAccessibility.html#3e168f50d58ee7d64d1b27927ddc9130">TEXT_BOUNDARY_TYPE</a> type,
92
<a name="l00223"></a>00223 out <span class="keywordtype">long</span> startOffset, out <span class="keywordtype">long</span> endOffset);
93
<a name="l00228"></a>00228 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> getCharacterAtOffset (in <span class="keywordtype">long</span> offset); <span class="comment">/* long instead of wchar, </span>
94
<a name="l00229"></a>00229 <span class="comment"> * to allow unicode chars > 16 bits </span>
95
<a name="l00230"></a>00230 <span class="comment"> */</span>
96
<a name="l00243"></a>00243 <span class="keywordtype">string</span> getAttributeValue (in <span class="keywordtype">long</span> offset, in <span class="keywordtype">string</span> attributeName,
97
<a name="l00244"></a>00244 out <span class="keywordtype">long</span> startOffset,
98
<a name="l00245"></a>00245 out <span class="keywordtype">long</span> endOffset,
99
<a name="l00246"></a>00246 out <span class="keywordtype">boolean</span> defined);
100
<a name="l00252"></a>00252 <span class="keywordtype">string</span> getAttributes (in <span class="keywordtype">long</span> offset,
101
<a name="l00253"></a>00253 out <span class="keywordtype">long</span> startOffset, out <span class="keywordtype">long</span> endOffset);
102
<a name="l00260"></a>00260 <span class="keywordtype">string</span> getDefaultAttributes ();
103
<a name="l00282"></a>00282 <span class="keywordtype">void</span> getCharacterExtents (in <span class="keywordtype">long</span> offset, out <span class="keywordtype">long</span> x, out <span class="keywordtype">long</span> y, out <span class="keywordtype">long</span> width, out <span class="keywordtype">long</span> height, in <span class="keywordtype">short</span> coordType);
104
<a name="l00292"></a>00292 <span class="keywordtype">long</span> getOffsetAtPoint (in <span class="keywordtype">long</span> x, in <span class="keywordtype">long</span> y, in <span class="keywordtype">short</span> coordType);
105
<a name="l00302"></a>00302 <span class="keywordtype">long</span> getNSelections ();
106
<a name="l00307"></a>00307 <span class="keywordtype">void</span> getSelection (in <span class="keywordtype">long</span> selectionNum, out <span class="keywordtype">long</span> startOffset, out <span class="keywordtype">long</span> endOffset);
107
<a name="l00317"></a>00317 <span class="keywordtype">boolean</span> addSelection (in <span class="keywordtype">long</span> startOffset, in <span class="keywordtype">long</span> endOffset);
108
<a name="l00323"></a>00323 <span class="keywordtype">boolean</span> removeSelection (in <span class="keywordtype">long</span> selectionNum);
109
<a name="l00336"></a>00336 <span class="keywordtype">boolean</span> setSelection (in <span class="keywordtype">long</span> selectionNum, in <span class="keywordtype">long</span> startOffset, in <span class="keywordtype">long</span> endOffset);
110
<a name="l00356"></a>00356 <span class="keywordtype">void</span> getRangeExtents (in <span class="keywordtype">long</span> startOffset, in <span class="keywordtype">long</span> endOffset,
111
<a name="l00357"></a>00357 out <span class="keywordtype">long</span> x, out <span class="keywordtype">long</span> y,
112
<a name="l00358"></a>00358 out <span class="keywordtype">long</span> width, out <span class="keywordtype">long</span> height, in <span class="keywordtype">short</span> coordType);
113
<a name="l00359"></a>00359
114
<a name="l00382"></a>00382 RangeList getBoundedRanges (in <span class="keywordtype">long</span> x, in <span class="keywordtype">long</span> y,
115
<a name="l00383"></a>00383 in <span class="keywordtype">long</span> width, in <span class="keywordtype">long</span> height,
116
<a name="l00384"></a>00384 in <span class="keywordtype">short</span> coordType,
117
<a name="l00385"></a>00385 in <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d">TEXT_CLIP_TYPE</a> xClipType,
118
<a name="l00386"></a>00386 in <a class="code" href="namespaceAccessibility.html#303d7dd2931c6ecd521f5dca847d5c7d">TEXT_CLIP_TYPE</a> yClipType);
119
<a name="l00387"></a>00387
120
<a name="l00439"></a>00439 <a class="code" href="namespaceAccessibility.html#917a6a01da45802ba562d131cae3c4e9">AttributeSet</a> getAttributeRun (in <span class="keywordtype">long</span> offset,
121
<a name="l00440"></a>00440 out <span class="keywordtype">long</span> startOffset,
122
<a name="l00441"></a>00441 out <span class="keywordtype">long</span> endOffset,
123
<a name="l00442"></a>00442 in <span class="keywordtype">boolean</span> includeDefaults);
124
<a name="l00453"></a>00453 <a class="code" href="namespaceAccessibility.html#917a6a01da45802ba562d131cae3c4e9">AttributeSet</a> getDefaultAttributeSet ();
125
<a name="l00454"></a>00454
126
<a name="l00460"></a>00460 <span class="keywordtype">void</span> unImplemented ();
127
<a name="l00461"></a>00461 <span class="keywordtype">void</span> unImplemented2 ();
128
<a name="l00463"></a>00463 };
129
<a name="l00464"></a>00464 };
131
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 22 14:55:00 2009 for at-spi-idl by
132
<a href="http://www.doxygen.org/index.html">
133
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>