LibreOffice: com/sun/star/accessibility/XAccessibleText.idl Source File

LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
20module com { module sun { module star { module accessibility {
21
47 interface XAccessibleText : ::com::sun::star::uno::XInterface
48{
59 long getCaretPosition ();
60
95 boolean setCaretPosition ([in] long nIndex)
96 raises (::com::sun::star::lang::IndexOutOfBoundsException);
97
112 char getCharacter ([in] long nIndex)
113 raises (::com::sun::star::lang::IndexOutOfBoundsException);
114
156 sequence<::com::sun::star::beans::PropertyValue>
157 getCharacterAttributes (
158 [in] long nIndex,
159 [in] sequence<string> aRequestedAttributes)
160 raises (::com::sun::star::lang::IndexOutOfBoundsException,
161 ::com::sun::star::beans::UnknownPropertyException);
162
163
197 ::com::sun::star::awt::Rectangle getCharacterBounds ([in] long nIndex)
198 raises (::com::sun::star::lang::IndexOutOfBoundsException);
199
200
210 long getCharacterCount ();
211
212
231 long getIndexAtPoint ([in] ::com::sun::star::awt::Point aPoint);
232
242 string getSelectedText ();
243
253 long getSelectionStart ();
254
264 long getSelectionEnd ();
265
296 boolean setSelection ([in] long nStartIndex, [in] long nEndIndex)
297 raises (::com::sun::star::lang::IndexOutOfBoundsException);
298
308 string getText ();
309
340 string getTextRange ([in] long nStartIndex, [in] long nEndIndex)
341 raises (::com::sun::star::lang::IndexOutOfBoundsException);
342
370 TextSegment getTextAtIndex([in] long nIndex, [in] short nTextType)
371 raises (::com::sun::star::lang::IndexOutOfBoundsException,
372 ::com::sun::star::lang::IllegalArgumentException);
373
409 TextSegment getTextBeforeIndex([in] long nIndex, [in] short nTextType)
410 raises (::com::sun::star::lang::IndexOutOfBoundsException,
411 ::com::sun::star::lang::IllegalArgumentException);
412
447 TextSegment getTextBehindIndex([in] long nIndex, [in] short nTextType)
448 raises (::com::sun::star::lang::IndexOutOfBoundsException,
449 ::com::sun::star::lang::IllegalArgumentException);
450
478 boolean copyText ([in] long nStartIndex, [in] long nEndIndex)
479 raises (::com::sun::star::lang::IndexOutOfBoundsException);
480
504 boolean
505 scrollSubstringTo ([in] long nStartIndex, [in] long nEndIndex,
506 [in] AccessibleScrollType aScrollType)
507 raises (::com::sun::star::lang::IndexOutOfBoundsException);
508};
509
510}; }; }; };
511
512/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition UnknownPropertyException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition IndexOutOfBoundsException.idl:31
com::sun::star::accessibility::XAccessibleText
Implement this interface to give read-only access to a text.
Definition XAccessibleText.idl:48
com::sun::star::accessibility::XAccessibleText::getCaretPosition
long getCaretPosition()
Return the position of the caret.
com::sun::star::accessibility::XAccessibleText::getTextBeforeIndex
TextSegment getTextBeforeIndex([in] long nIndex, [in] short nTextType)
Get a text portion before the given position.
com::sun::star::accessibility::XAccessibleText::getCharacterCount
long getCharacterCount()
Return the number of characters in the represented text.
com::sun::star::accessibility::XAccessibleText::getTextAtIndex
TextSegment getTextAtIndex([in] long nIndex, [in] short nTextType)
Get a text portion around the given position.
com::sun::star::accessibility::XAccessibleText::getCharacterBounds
::com::sun::star::awt::Rectangle getCharacterBounds([in] long nIndex)
Return the bounding box of the specified position.
com::sun::star::accessibility::XAccessibleText::getCharacter
char getCharacter([in] long nIndex)
Return the character at the specified position.
com::sun::star::accessibility::XAccessibleText::getSelectionEnd
long getSelectionEnd()
Return the position of the end of the selection.
com::sun::star::accessibility::XAccessibleText::setCaretPosition
boolean setCaretPosition([in] long nIndex)
Set the position of the caret.
com::sun::star::accessibility::XAccessibleText::getTextRange
string getTextRange([in] long nStartIndex, [in] long nEndIndex)
Return the specified text range.
com::sun::star::accessibility::XAccessibleText::scrollSubstringTo
boolean scrollSubstringTo([in] long nStartIndex, [in] long nEndIndex, [in] AccessibleScrollType aScrollType)
Scroll the specified text to make it visible on screen.
com::sun::star::accessibility::XAccessibleText::getCharacterAttributes
sequence<::com::sun::star::beans::PropertyValue > getCharacterAttributes([in] long nIndex, [in] sequence< string > aRequestedAttributes)
Get the attribute set for the specified position.
com::sun::star::accessibility::XAccessibleText::getText
string getText()
Return the whole text.
com::sun::star::accessibility::XAccessibleText::getSelectedText
string getSelectedText()
Return the selected text.
com::sun::star::accessibility::XAccessibleText::setSelection
boolean setSelection([in] long nStartIndex, [in] long nEndIndex)
Set a new selection.
com::sun::star::accessibility::XAccessibleText::copyText
boolean copyText([in] long nStartIndex, [in] long nEndIndex)
Copy the specified text into the clipboard.
com::sun::star::accessibility::XAccessibleText::getTextBehindIndex
TextSegment getTextBehindIndex([in] long nIndex, [in] short nTextType)
Get a text portion behind the given position.
com::sun::star::accessibility::XAccessibleText::getIndexAtPoint
long getIndexAtPoint([in] ::com::sun::star::awt::Point aPoint)
Return the text position for the specified screen position.
com::sun::star::accessibility::XAccessibleText::getSelectionStart
long getSelectionStart()
Return the position of the start of the selection.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com::sun::star::accessibility::AccessibleScrollType
AccessibleScrollType
Scroll types.
Definition AccessibleScrollType.idl:30
com
Definition Ambiguous.idl:20
com::sun::star::accessibility::TextSegment
This structure describes a text segment that is embedded in a larger portion of text.
Definition TextSegment.idl:52
com::sun::star::awt::Point
specifies a 2-dimensional point using the Cartesian coordinate system.
Definition Point.idl:28
com::sun::star::awt::Rectangle
specifies a rectangular area by position and size.
Definition Rectangle.idl:28