LibreOffice
LibreOffice 7.2 SDK API Reference
XAccessibleText.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef __com_sun_star_accessibility_XAccessibleText_idl__
21 #define __com_sun_star_accessibility_XAccessibleText_idl__
22 
32 
33 module com { module sun { module star { module accessibility {
34 
61 {
73 
108  boolean setCaretPosition ([in] long nIndex)
110 
125  char getCharacter ([in] long nIndex)
127 
169  sequence<::com::sun::star::beans::PropertyValue>
171  [in] long nIndex,
172  [in] sequence<string> aRequestedAttributes)
175 
176 
212 
213 
224 
225 
245 
255  string getSelectedText ();
256 
267 
278 
309  boolean setSelection ([in] long nStartIndex, [in] long nEndIndex)
311 
321  string getText ();
322 
353  string getTextRange ([in] long nStartIndex, [in] long nEndIndex)
355 
383  TextSegment getTextAtIndex([in] long nIndex, [in] short nTextType)
386 
422  TextSegment getTextBeforeIndex([in] long nIndex, [in] short nTextType)
425 
460  TextSegment getTextBehindIndex([in] long nIndex, [in] short nTextType)
463 
491  boolean copyText ([in] long nStartIndex, [in] long nEndIndex)
493 
517  boolean
518  scrollSubstringTo ([in] long nStartIndex, [in] long nEndIndex,
519  [in] AccessibleScrollType aScrollType)
521 };
522 
523 }; }; }; };
524 
525 #endif
526 
527 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:35
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
Implement this interface to give read-only access to a text.
Definition: XAccessibleText.idl:61
long getCaretPosition()
Return the position of the caret.
TextSegment getTextBeforeIndex([in] long nIndex, [in] short nTextType)
Get a text portion before the given position.
long getCharacterCount()
Return the number of characters in the represented text.
TextSegment getTextAtIndex([in] long nIndex, [in] short nTextType)
Get a text portion around the given position.
::com::sun::star::awt::Rectangle getCharacterBounds([in] long nIndex)
Return the bounding box of the specified position.
char getCharacter([in] long nIndex)
Return the character at the specified position.
long getSelectionEnd()
Return the position of the end of the selection.
boolean setCaretPosition([in] long nIndex)
Set the position of the caret.
string getTextRange([in] long nStartIndex, [in] long nEndIndex)
Return the specified text range.
boolean scrollSubstringTo([in] long nStartIndex, [in] long nEndIndex, [in] AccessibleScrollType aScrollType)
Scroll the specified text to make it visible on screen.
sequence<::com::sun::star::beans::PropertyValue > getCharacterAttributes([in] long nIndex, [in] sequence< string > aRequestedAttributes)
Get the attribute set for the specified position.
string getText()
Return the whole text.
string getSelectedText()
Return the selected text.
boolean setSelection([in] long nStartIndex, [in] long nEndIndex)
Set a new selection.
boolean copyText([in] long nStartIndex, [in] long nEndIndex)
Copy the specified text into the clipboard.
TextSegment getTextBehindIndex([in] long nIndex, [in] short nTextType)
Get a text portion behind the given position.
long getIndexAtPoint([in] ::com::sun::star::awt::Point aPoint)
Return the text position for the specified screen position.
long getSelectionStart()
Return the position of the start of the selection.
base interface of all UNO interfaces
Definition: XInterface.idl:48
AccessibleScrollType
Scroll types.
Definition: AccessibleScrollType.idl:33
Definition: Ambiguous.idl:22
This structure describes a text segment that is embedded in a larger portion of text.
Definition: TextSegment.idl:55
specifies a 2-dimensional point using the Cartesian coordinate system.
Definition: Point.idl:30
specifies a rectangular area by position and size.
Definition: Rectangle.idl:30