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

LibreOffice LibreOffice 7.3 SDK API Reference

XAccessibleTextMarkup.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_XAccessibleTextMarkup_idl__
21#define __com_sun_star_accessibility_XAccessibleTextMarkup_idl__
22
23#include <com/sun/star/uno/XInterface.idl>
24#include <com/sun/star/lang/IllegalArgumentException.idl>
25#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
26#include <com/sun/star/accessibility/XAccessibleText.idl>
27#include <com/sun/star/accessibility/TextSegment.idl>
28
29module com { module sun { module star { module accessibility {
30
31 interface XAccessibleTextMarkup;
32
33
48 interface XAccessibleTextMarkup
49 : ::com::sun::star::accessibility::XAccessibleText
50{
65 long getTextMarkupCount ( [in] long TextMarkupType )
66 raises (::com::sun::star::lang::IllegalArgumentException);
67
88 TextSegment getTextMarkup ( [in] long TextMarkupIndex,
89 [in] long TextMarkupType )
90 raises (::com::sun::star::lang::IndexOutOfBoundsException,
91 ::com::sun::star::lang::IllegalArgumentException);
92
114 sequence<TextSegment> getTextMarkupAtIndex ( [in] long CharIndex,
115 [in] long TextMarkupType )
116 raises (::com::sun::star::lang::IndexOutOfBoundsException,
117 ::com::sun::star::lang::IllegalArgumentException);
118};
119
120}; }; }; };
121
122#endif
123
124/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
IndexOutOfBoundsException.idl
TextSegment.idl
XAccessibleText.idl
XInterface.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
com::sun::star::accessibility::XAccessibleTextMarkup
Implement this interface to expose the text markups of a text.
Definition: XAccessibleTextMarkup.idl:50
com::sun::star::accessibility::XAccessibleTextMarkup::getTextMarkupCount
long getTextMarkupCount([in] long TextMarkupType)
Returns the number of text markup of the given text markup type of a text.
com::sun::star::accessibility::XAccessibleTextMarkup::getTextMarkup
TextSegment getTextMarkup([in] long TextMarkupIndex, [in] long TextMarkupType)
Returns the text segment of the text markup of the given index and of the given text mark type.
com::sun::star::accessibility::XAccessibleTextMarkup::getTextMarkupAtIndex
sequence< TextSegment > getTextMarkupAtIndex([in] long CharIndex, [in] long TextMarkupType)
returns a sequence of the text segments of the text markups at the given character index and of the g...
com::sun::star::accessibility::XAccessibleText
Implement this interface to give read-only access to a text.
Definition: XAccessibleText.idl:61
com
Definition: Accessible.idl:22
com::sun::star::accessibility::TextSegment
This structure describes a text segment that is embedded in a larger portion of text.
Definition: TextSegment.idl:55