LibreOffice
LibreOffice 6.3 SDK API Reference
com
sun
star
accessibility
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
23
#include <
com/sun/star/accessibility/AccessibleTextType.idl
>
24
#include <
com/sun/star/uno/XInterface.idl
>
25
#include <
com/sun/star/awt/Point.idl
>
26
#include <
com/sun/star/awt/Rectangle.idl
>
27
#include <
com/sun/star/lang/IndexOutOfBoundsException.idl
>
28
#include <
com/sun/star/lang/IllegalArgumentException.idl
>
29
#include <
com/sun/star/beans/PropertyValue.idl
>
30
#include <
com/sun/star/beans/UnknownPropertyException.idl
>
31
#include <
com/sun/star/accessibility/TextSegment.idl
>
32
33
module
com
{ module sun { module star { module accessibility {
34
60
interface
XAccessibleText
:
::com::sun::star::uno::XInterface
61
{
72
long
getCaretPosition ();
73
108
boolean
setCaretPosition ([in]
long
nIndex)
109
raises (::
com::sun::star::lang::IndexOutOfBoundsException
);
110
125
char
getCharacter ([in]
long
nIndex)
126
raises (::
com::sun::star::lang::IndexOutOfBoundsException
);
127
169
sequence<::com::sun::star::beans::PropertyValue>
170
getCharacterAttributes (
171
[in]
long
nIndex,
172
[in] sequence<string> aRequestedAttributes)
173
raises (::
com::sun::star::lang::IndexOutOfBoundsException
,
174
::
com::sun::star::beans::UnknownPropertyException
);
175
176
210
::com::sun::star::awt::Rectangle
getCharacterBounds ([in]
long
nIndex)
211
raises (::
com::sun::star::lang::IndexOutOfBoundsException
);
212
213
223
long
getCharacterCount ();
224
225
244
long
getIndexAtPoint ([in] ::
com::sun::star::awt::Point
aPoint);
245
255
string
getSelectedText ();
256
266
long
getSelectionStart ();
267
277
long
getSelectionEnd ();
278
309
boolean
setSelection ([in]
long
nStartIndex, [in]
long
nEndIndex)
310
raises (::
com::sun::star::lang::IndexOutOfBoundsException
);
311
321
string
getText ();
322
353
string
getTextRange ([in]
long
nStartIndex, [in]
long
nEndIndex)
354
raises (::
com::sun::star::lang::IndexOutOfBoundsException
);
355
383
TextSegment
getTextAtIndex([in]
long
nIndex, [in]
short
nTextType)
384
raises (::
com::sun::star::lang::IndexOutOfBoundsException
,
385
::
com::sun::star::lang::IllegalArgumentException
);
386
422
TextSegment
getTextBeforeIndex([in]
long
nIndex, [in]
short
nTextType)
423
raises (::
com::sun::star::lang::IndexOutOfBoundsException
,
424
::
com::sun::star::lang::IllegalArgumentException
);
425
460
TextSegment
getTextBehindIndex([in]
long
nIndex, [in]
short
nTextType)
461
raises (::
com::sun::star::lang::IndexOutOfBoundsException
,
462
::
com::sun::star::lang::IllegalArgumentException
);
463
491
boolean
copyText ([in]
long
nStartIndex, [in]
long
nEndIndex)
492
raises (::
com::sun::star::lang::IndexOutOfBoundsException
);
493
494
};
495
496
}; }; }; };
497
498
#endif
499
500
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::Rectangle
specifies a rectangular area by position and size.
Definition:
Rectangle.idl:29
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition:
IndexOutOfBoundsException.idl:34
com::sun::star::awt::Point
specifies a 2-dimensional point using the Cartesian coordinate system.
Definition:
Point.idl:29
IllegalArgumentException.idl
com
Definition:
Ambiguous.idl:22
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition:
UnknownPropertyException.idl:34
PropertyValue.idl
com::sun::star::accessibility::TextSegment
This structure describes a text segment that is embedded in a larger portion of text.
Definition:
TextSegment.idl:54
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition:
IllegalArgumentException.idl:29
XInterface.idl
com::sun::star::accessibility::XAccessibleText
Implement this interface to give read-only access to a text.
Definition:
XAccessibleText.idl:60
Point.idl
Rectangle.idl
UnknownPropertyException.idl
IndexOutOfBoundsException.idl
TextSegment.idl
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition:
XInterface.idl:47
AccessibleTextType.idl
Generated by
1.8.15