2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 module Accessibility {
25 enum TEXT_BOUNDARY_TYPE {
27 TEXT_BOUNDARY_CURSOR_POS,
28 TEXT_BOUNDARY_WORD_START,
29 TEXT_BOUNDARY_WORD_END,
30 TEXT_BOUNDARY_SENTENCE_START,
31 TEXT_BOUNDARY_SENTENCE_END,
32 TEXT_BOUNDARY_LINE_START,
33 TEXT_BOUNDARY_LINE_END
36 interface Text : Bonobo::Unknown {
37 readonly attribute long characterCount;
38 readonly attribute long caretOffset;
39 string getText (in long startOffset, in long endOffset);
40 boolean setCaretOffset (in long offset);
41 string getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type,
42 out long startOffset, out long endOffset);
43 string getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type,
44 out long startOffset, out long endOffset);
45 string getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type,
46 out long startOffset, out long endOffset);
47 wchar getCharacterAtOffset (in long offset); /* could be string instead,
48 * to allow unicode chars > 16 bits
50 /* void getRowColAtOffset (in long offset, out long row, out long column); */
51 string getAttributes (in long offset,
52 out long startOffset, out long endOffset);
53 boolean getCharacterExtents (in long offset, out long x, out long y, out long length, out long width, in short coordType);
54 long getOffsetAtPoint (in long x, in long y, in short coordType);
55 long getNSelections ();
56 void getSelection (in long selectionNum, out long startOffset, out long endOffset);
57 boolean addSelection (in long startOffset, in long endOffset);
58 boolean removeSelection (in long selectionNum);
59 boolean setSelection (in long selectionNum, in long startOffset, in long endOffset);