1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the plugins of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QWINDOWSUIATEXTRANGEPROVIDER_H
41 #define QWINDOWSUIATEXTRANGEPROVIDER_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #if QT_CONFIG(accessibility)
45 
46 #include "qwindowsuiabaseprovider.h"
47 
48 QT_BEGIN_NAMESPACE
49 
50 // Implements the Text Range control pattern provider. Used for text controls.
51 class QWindowsUiaTextRangeProvider : public QWindowsUiaBaseProvider,
52                                      public QWindowsComBase<ITextRangeProvider>
53 {
54     Q_DISABLE_COPY_MOVE(QWindowsUiaTextRangeProvider)
55 public:
56     explicit QWindowsUiaTextRangeProvider(QAccessible::Id id, int startOffset, int endOffset);
57     virtual ~QWindowsUiaTextRangeProvider();
58 
59     // ITextRangeProvider
60     HRESULT STDMETHODCALLTYPE AddToSelection() override;
61     HRESULT STDMETHODCALLTYPE Clone(ITextRangeProvider **pRetVal) override;
62     HRESULT STDMETHODCALLTYPE Compare(ITextRangeProvider *range, BOOL *pRetVal) override;
63     HRESULT STDMETHODCALLTYPE CompareEndpoints(TextPatternRangeEndpoint endpoint, ITextRangeProvider *targetRange, TextPatternRangeEndpoint targetEndpoint, int *pRetVal) override;
64     HRESULT STDMETHODCALLTYPE ExpandToEnclosingUnit(TextUnit unit) override;
65     HRESULT STDMETHODCALLTYPE FindAttribute(TEXTATTRIBUTEID attributeId, VARIANT val, BOOL backward, ITextRangeProvider **pRetVal) override;
66     HRESULT STDMETHODCALLTYPE FindText(BSTR text, BOOL backward, BOOL ignoreCase, ITextRangeProvider **pRetVal) override;
67     HRESULT STDMETHODCALLTYPE GetAttributeValue(TEXTATTRIBUTEID attributeId, VARIANT *pRetVal) override;
68     HRESULT STDMETHODCALLTYPE GetBoundingRectangles(SAFEARRAY **pRetVal) override;
69     HRESULT STDMETHODCALLTYPE GetChildren(SAFEARRAY **pRetVal) override;
70     HRESULT STDMETHODCALLTYPE GetEnclosingElement(IRawElementProviderSimple **pRetVal) override;
71     HRESULT STDMETHODCALLTYPE GetText(int maxLength, BSTR *pRetVal) override;
72     HRESULT STDMETHODCALLTYPE Move(TextUnit unit, int count, int *pRetVal) override;
73     HRESULT STDMETHODCALLTYPE MoveEndpointByRange(TextPatternRangeEndpoint endpoint, ITextRangeProvider *targetRange, TextPatternRangeEndpoint targetEndpoint) override;
74     HRESULT STDMETHODCALLTYPE MoveEndpointByUnit(TextPatternRangeEndpoint endpoint, TextUnit unit, int count, int *pRetVal) override;
75     HRESULT STDMETHODCALLTYPE RemoveFromSelection() override;
76     HRESULT STDMETHODCALLTYPE ScrollIntoView(BOOL alignToTop) override;
77     HRESULT STDMETHODCALLTYPE Select() override;
78 
79 private:
80     HRESULT unselect();
81     int m_startOffset;
82     int m_endOffset;
83 };
84 
85 QT_END_NAMESPACE
86 
87 #endif // QT_CONFIG(accessibility)
88 
89 #endif // QWINDOWSUIATEXTRANGEPROVIDER_H
90