1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_COMPHELPER_ACCESSIBLETEXTHELPER_HXX
#define INCLUDED_COMPHELPER_ACCESSIBLETEXTHELPER_HXX
#include <com/sun/star/accessibility/XAccessibleText.hpp>
#include <com/sun/star/accessibility/TextSegment.hpp>
#include <comphelper/accessiblecomponenthelper.hxx>
#include <cppuhelper/implbase.hxx>
#include <comphelper/comphelperdllapi.h>
namespace com::sun::star::i18n { class XBreakIterator; }
namespace com::sun::star::i18n { class XCharacterClassification; }
namespace com::sun::star::i18n { struct Boundary; }
namespace comphelper
{
// OCommonAccessibleText
/** base class encapsulating common functionality for the helper classes implementing
the XAccessibleText
*/
class COMPHELPER_DLLPUBLIC OCommonAccessibleText
{
private:
css::uno::Reference < css::i18n::XBreakIterator > m_xBreakIter;
css::uno::Reference < css::i18n::XCharacterClassification > m_xCharClass;
protected:
OCommonAccessibleText();
virtual ~OCommonAccessibleText();
css::uno::Reference < css::i18n::XBreakIterator > const & implGetBreakIterator();
css::uno::Reference < css::i18n::XCharacterClassification > const & implGetCharacterClassification();
static bool implIsValidBoundary( css::i18n::Boundary const & rBoundary, sal_Int32 nLength );
static bool implIsValidIndex( sal_Int32 nIndex, sal_Int32 nLength );
static bool implIsValidRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex, sal_Int32 nLength );
static sal_Unicode implGetCharacter( std::u16string_view rText, sal_Int32 nIndex );
static OUString implGetTextRange( std::u16string_view rText, sal_Int32 nStartIndex, sal_Int32 nEndIndex );
virtual OUString implGetText() = 0;
virtual css::lang::Locale implGetLocale() = 0;
virtual void implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex ) = 0;
void implGetGlyphBoundary( const OUString& rText, css::i18n::Boundary& rBoundary, sal_Int32 nIndex );
bool implGetWordBoundary( const OUString& rText, css::i18n::Boundary& rBoundary, sal_Int32 nIndex );
void implGetSentenceBoundary( const OUString& rText, css::i18n::Boundary& rBoundary, sal_Int32 nIndex );
virtual void implGetParagraphBoundary( const OUString& rText, css::i18n::Boundary& rBoundary, sal_Int32 nIndex );
virtual void implGetLineBoundary( const OUString& rText, css::i18n::Boundary& rBoundary, sal_Int32 nIndex );
/** non-virtual versions of the methods
@throws css::lang::IndexOutOfBoundsException
@throws css::uno::RuntimeException
*/
OUString getSelectedText();
/// @throws css::uno::RuntimeException
sal_Int32 getSelectionStart();
/// @throws css::uno::RuntimeException
sal_Int32 getSelectionEnd();
/// @throws css::lang::IndexOutOfBoundsException
/// @throws css::lang::IllegalArgumentException
/// @throws css::uno::RuntimeException
css::accessibility::TextSegment getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType );
/// @throws css::lang::IndexOutOfBoundsException
/// @throws css::lang::IllegalArgumentException
/// @throws css::uno::RuntimeException
css::accessibility::TextSegment getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType );
/// @throws css::lang::IndexOutOfBoundsException
/// @throws css::lang::IllegalArgumentException
/// @throws css::uno::RuntimeException
css::accessibility::TextSegment getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType );
public:
/** Helper method, that detects the difference between
two strings and returns the deleted selection and
the inserted selection if available.
@returns true if there are differences between the
two strings and false if both are equal
@see css::accessibility::AccessibleEventId
css::accessibility::TextSegment
*/
static bool implInitTextChangedEvent(
std::u16string_view rOldString,
std::u16string_view rNewString,
/*out*/ css::uno::Any& rDeleted,
/*out*/ css::uno::Any& rInserted); // throw()
};
// OAccessibleTextHelper
/** a helper class for implementing an AccessibleExtendedComponent which at the same time
supports an XAccessibleText interface
*/
class COMPHELPER_DLLPUBLIC OAccessibleTextHelper : public cppu::ImplInheritanceHelper<
OAccessibleExtendedComponentHelper,
css::accessibility::XAccessibleText>,
public OCommonAccessibleText
{
private:
OAccessibleTextHelper(OAccessibleTextHelper const &) = delete;
OAccessibleTextHelper(OAccessibleTextHelper &&) = delete;
void operator =(OAccessibleTextHelper const &) = delete;
void operator =(OAccessibleTextHelper &&) = delete;
protected:
OAccessibleTextHelper();
public:
// XAccessibleText
virtual OUString SAL_CALL getSelectedText() override;
virtual sal_Int32 SAL_CALL getSelectionStart() override;
virtual sal_Int32 SAL_CALL getSelectionEnd() override;
virtual css::accessibility::TextSegment SAL_CALL getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType ) override;
virtual css::accessibility::TextSegment SAL_CALL getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType ) override;
virtual css::accessibility::TextSegment SAL_CALL getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType ) override;
};
} // namespace comphelper
// OAccessibleTextHelper is a helper class for implementing the
// XAccessibleText interface.
// The following methods have a default implementation:
// getCharacter
// getSelectedText
// getSelectionStart
// getSelectionEnd
// getTextRange
// getTextAtIndex
// getTextBeforeIndex
// getTextBehindIndex
// The following methods must be overridden by derived classes:
// implGetText
// implGetLocale
// implGetSelection
// getCaretPosition
// setCaretPosition
// getCharacterAttributes
// getCharacterBounds
// getIndexAtPoint
// setSelection
// copyText
#endif // INCLUDED_COMPHELPER_ACCESSIBLETEXTHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
