diff options
Diffstat (limited to 'src/plugins/platforms/winrt/uiautomation/qwinrtuiatextprovider.cpp')
| -rw-r--r-- | src/plugins/platforms/winrt/uiautomation/qwinrtuiatextprovider.cpp | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/src/plugins/platforms/winrt/uiautomation/qwinrtuiatextprovider.cpp b/src/plugins/platforms/winrt/uiautomation/qwinrtuiatextprovider.cpp new file mode 100644 index 0000000000..aa120377df --- /dev/null +++ b/src/plugins/platforms/winrt/uiautomation/qwinrtuiatextprovider.cpp @@ -0,0 +1,232 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QtGui/qtguiglobal.h> +#if QT_CONFIG(accessibility) + +#include "qwinrtuiatextprovider.h" +#include "qwinrtuiametadatacache.h" +#include "qwinrtuiatextrangeprovider.h" +#include "qwinrtuiautils.h" + +#include <QtGui/QAccessible> +#include <QtGui/QAccessibleInterface> +#include <QtCore/QLoggingCategory> +#include <QtCore/QString> +#include <QtCore/private/qeventdispatcher_winrt_p.h> + +QT_BEGIN_NAMESPACE + +using namespace QWinRTUiAutomation; +using namespace Microsoft::WRL; +using namespace Microsoft::WRL::Wrappers; +using namespace ABI::Windows::UI::Xaml::Automation; +using namespace ABI::Windows::UI::Xaml::Automation::Provider; + +QWinRTUiaTextProvider::QWinRTUiaTextProvider(QAccessible::Id id) : + QWinRTUiaBaseProvider(id) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; +} + +QWinRTUiaTextProvider::~QWinRTUiaTextProvider() +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; +} + +// Returns a text range provider for the entire text. +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::get_DocumentRange(ITextRangeProvider **value) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + + if (!value) + return E_INVALIDARG; + + QSharedPointer<QWinRTUiaControlMetadata> metadata = QWinRTUiaMetadataCache::instance()->metadataForId(id()); + ComPtr<QWinRTUiaTextRangeProvider> textRangeProvider = Make<QWinRTUiaTextRangeProvider>(id(), 0, metadata->characterCount()); + return textRangeProvider.CopyTo(value); +} + +// Currently supporting single selection. +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::get_SupportedTextSelection(SupportedTextSelection *value) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + if (!value) + return E_INVALIDARG; + *value = SupportedTextSelection_Single; + return S_OK; + +} + +// Returns an array of providers for the selected text ranges. +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::GetSelection(UINT32 *returnValueSize, ITextRangeProvider ***returnValue) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + + if (!returnValueSize || !returnValue) + return E_INVALIDARG; + *returnValueSize = 0; + *returnValue = nullptr; + + auto accid = id(); + auto selections = QSharedPointer<QList<QPair<int,int>>>(new QList<QPair<int,int>>); + auto ptrSelections = new QSharedPointer<QList<QPair<int,int>>>(selections); + + if (!SUCCEEDED(QEventDispatcherWinRT::runOnMainThread([accid, ptrSelections]() { + if (QAccessibleInterface *accessible = accessibleForId(accid)) { + if (QAccessibleTextInterface *textInterface = accessible->textInterface()) { + for (int i = 0; i < textInterface->selectionCount(); ++i) { + QPair<int,int> sel; + textInterface->selection(i, &sel.first, &sel.second); + (*ptrSelections)->append(sel); + } + if ((*ptrSelections)->size() == 0) { + // If there is no selection, we return an array with a single degenerate (empty) text range at the cursor position. + QPair<int,int> sel(textInterface->cursorPosition(), textInterface->cursorPosition()); + (*ptrSelections)->append(sel); + } + } + } + delete ptrSelections; + return S_OK; + }))) { + return E_FAIL; + } + + int selCount = selections->size(); + if (selCount < 1) + return E_FAIL; + + ITextRangeProvider **providerArray = static_cast<ITextRangeProvider **>(CoTaskMemAlloc(selCount * sizeof(ITextRangeProvider *))); + if (!providerArray) + return E_OUTOFMEMORY; + + for (int i = 0; i < selCount; ++i) { + ComPtr<QWinRTUiaTextRangeProvider> textRangeProvider = Make<QWinRTUiaTextRangeProvider>(id(), (*selections)[i].first, (*selections)[i].second); + textRangeProvider.CopyTo(&providerArray[i]); + } + *returnValueSize = selCount; + *returnValue = providerArray; + return S_OK; +} + +// Returns an array of providers for the visible text ranges. +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::GetVisibleRanges(UINT32 *returnValueSize, ITextRangeProvider ***returnValue) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + + if (!returnValueSize || !returnValue) + return E_INVALIDARG; + + QSharedPointer<QWinRTUiaControlMetadata> metadata = QWinRTUiaMetadataCache::instance()->metadataForId(id()); + + // Considering the entire text as visible. + ComPtr<QWinRTUiaTextRangeProvider> textRangeProvider = Make<QWinRTUiaTextRangeProvider>(id(), 0, metadata->characterCount()); + textRangeProvider.CopyTo(*returnValue); + *returnValueSize = 1; + return S_OK; +} + +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::RangeFromChild(IIRawElementProviderSimple *childElement, ITextRangeProvider **returnValue) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + if (!childElement || !returnValue) + return E_INVALIDARG; + *returnValue = nullptr; + // No children supported. + return S_OK; +} + +// Returns a degenerate text range at the specified point. +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::RangeFromPoint(ABI::Windows::Foundation::Point screenLocation, ITextRangeProvider **returnValue) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + + if (!returnValue) + return E_INVALIDARG; + *returnValue = nullptr; + + const QPoint pt(screenLocation.X, screenLocation.Y); + auto accid = id(); + auto offset = QSharedPointer<int>(new int); + auto ptrOffset = new QSharedPointer<int>(offset); + + if (!SUCCEEDED(QEventDispatcherWinRT::runOnMainThread([accid, pt, ptrOffset]() { + if (QAccessibleInterface *accessible = accessibleForId(accid)) + if (QAccessibleTextInterface *textInterface = accessible->textInterface()) + **ptrOffset = qBound(0, textInterface->offsetAtPoint(pt), textInterface->characterCount() - 1); + delete ptrOffset; + return S_OK; + }))) { + return E_FAIL; + } + + ComPtr<QWinRTUiaTextRangeProvider> textRangeProvider = Make<QWinRTUiaTextRangeProvider>(id(), *offset, *offset); + textRangeProvider.CopyTo(returnValue); + return S_OK; +} + +// Not supporting annotations. +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::RangeFromAnnotation(IIRawElementProviderSimple *annotationElement, ITextRangeProvider **returnValue) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + if (!annotationElement || !returnValue) + return E_INVALIDARG; + *returnValue = nullptr; + return S_OK; +} + +HRESULT STDMETHODCALLTYPE QWinRTUiaTextProvider::GetCaretRange(boolean *isActive, ITextRangeProvider **returnValue) +{ + qCDebug(lcQpaUiAutomation) << __FUNCTION__; + + if (!isActive || !returnValue) + return E_INVALIDARG; + + QSharedPointer<QWinRTUiaControlMetadata> metadata = QWinRTUiaMetadataCache::instance()->metadataForId(id()); + *isActive = metadata->state().focused; + + ComPtr<QWinRTUiaTextRangeProvider> textRangeProvider = Make<QWinRTUiaTextRangeProvider>(id(), metadata->cursorPosition(), metadata->cursorPosition()); + return textRangeProvider.CopyTo(returnValue); +} + + +QT_END_NAMESPACE + +#endif // QT_CONFIG(accessibility) |