source: trunk/third/at-spi/idl/Accessibility_Text.idl @ 18422

Revision 18422, 2.7 KB checked in by ghudson, 22 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r18421, which included commits to RCS files with non-trunk default branches.
Line 
1/*
2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4 *
5 * Copyright 2001 Sun Microsystems, Inc.
6 *
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.
11 *
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.
16 *
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.
21 */
22
23module Accessibility {
24
25  enum TEXT_BOUNDARY_TYPE {
26    TEXT_BOUNDARY_CHAR,
27    TEXT_BOUNDARY_WORD_START,
28    TEXT_BOUNDARY_WORD_END,
29    TEXT_BOUNDARY_SENTENCE_START,
30    TEXT_BOUNDARY_SENTENCE_END,
31    TEXT_BOUNDARY_LINE_START,
32    TEXT_BOUNDARY_LINE_END
33  };
34
35  interface Text : Bonobo::Unknown {
36    readonly attribute long characterCount;
37    readonly attribute long caretOffset;
38    string getText (in long startOffset, in long endOffset);
39    boolean setCaretOffset (in long offset);
40    string getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type,
41                                out long startOffset, out long endOffset);
42    string getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type,
43                                                        out long startOffset, out long endOffset);
44    string getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type,
45                                                        out long startOffset, out long endOffset);
46    unsigned long getCharacterAtOffset (in long offset);  /* long instead of wchar,
47                                                           * to allow unicode chars > 16 bits
48                                                           */
49    string getAttributes (in long offset,
50                          out long startOffset, out long endOffset);
51    void getCharacterExtents (in long offset, out long x, out long y, out long length, out long width, in short coordType);
52    long getOffsetAtPoint (in long x, in long y, in short coordType);
53    long getNSelections ();
54    void getSelection (in long selectionNum, out long startOffset, out long endOffset);
55    boolean addSelection (in long startOffset, in long endOffset);
56    boolean removeSelection (in long selectionNum);
57    boolean setSelection (in long selectionNum, in long startOffset, in long endOffset);
58    /**
59     * unImplemented:
60     *
61     * placeholders for future expansion.
62     */
63    void unImplemented ();
64    void unImplemented2 ();
65    void unImplemented3 ();
66    void unImplemented4 ();
67  };
68};
Note: See TracBrowser for help on using the repository browser.