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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
|
/* -*- 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_SW_SOURCE_CORE_ACCESS_ACCPARA_HXX
#define INCLUDED_SW_SOURCE_CORE_ACCESS_ACCPARA_HXX
#include "acccontext.hxx"
#include <com/sun/star/accessibility/AccessibleScrollType.hpp>
#include <com/sun/star/accessibility/XAccessibleEditableText.hpp>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <com/sun/star/accessibility/XAccessibleHypertext.hpp>
#include <com/sun/star/accessibility/XAccessibleTextMarkup.hpp>
#include <com/sun/star/accessibility/XAccessibleMultiLineText.hpp>
#include <com/sun/star/accessibility/XAccessibleTextSelection.hpp>
#include <com/sun/star/accessibility/XAccessibleExtendedAttributes.hpp>
#include <com/sun/star/accessibility/XAccessibleTextAttributes.hpp>
#include "accselectionhelper.hxx"
#include <unordered_map>
#include <svl/lstner.hxx>
class SwTextFrame;
class SwPaM;
class SwAccessiblePortionData;
class SwAccessibleHyperTextData;
class SwRangeRedline;
class SwXTextPortion;
class SwParaChangeTrackingInfo; //#i108125#
namespace com::sun::star {
namespace i18n { struct Boundary; }
namespace style { struct TabStop; }
}
typedef std::unordered_map< OUString,
css::beans::PropertyValue > tAccParaPropValMap;
using SwAccessibleParagraph_BASE = cppu::ImplInheritanceHelper<SwAccessibleContext,
css::accessibility::XAccessibleEditableText,
css::accessibility::XAccessibleSelection,
css::accessibility::XAccessibleHypertext,
css::accessibility::XAccessibleTextMarkup,
css::accessibility::XAccessibleMultiLineText,
css::accessibility::XAccessibleTextAttributes,
css::accessibility::XAccessibleTextSelection,
css::accessibility::XAccessibleExtendedAttributes>;
class SwAccessibleParagraph :
public SfxListener,
public SwAccessibleParagraph_BASE
{
friend class SwAccessibleHyperlink;
// data for this paragraph's text portions; this contains the
// mapping from the core 'model string' to the accessible text
// string.
// pPortionData may be NULL; it should only be accessed through the
// Get/Clear/Has/UpdatePortionData() methods
std::unique_ptr<SwAccessiblePortionData> m_pPortionData;
std::unique_ptr<SwAccessibleHyperTextData> m_pHyperTextData;
sal_Int32 m_nOldCaretPos; // The 'old' caret pos. It's only valid as long
// as the cursor is inside this object (protected by
// mutex)
bool m_bIsBlockQuote;
bool m_bIsHeading; // protected by base classes mutex
sal_Int32 m_nHeadingLevel;
// implementation for XAccessibleSelection
SwAccessibleSelectionHelper m_aSelectionHelper;
std::unique_ptr<SwParaChangeTrackingInfo> mpParaChangeTrackInfo; // #i108125#
// XAccessibleComponent
bool m_bLastHasSelection;
const SwTextFrame* GetTextFrame() const;
/// get the (accessible) text string (requires frame; check before)
OUString const & GetString();
// get the current caret position
sal_Int32 GetCaretPos();
// determine the current selection. Fill the values with
// -1 if there is no selection in the this paragraph
// @param pSelection (optional) check only Nth selection in ring
bool GetSelectionAtIndex(sal_Int32 * pSelection, sal_Int32& nStart, sal_Int32& nEnd);
bool GetSelection(sal_Int32& nStart, sal_Int32& nEnd) {
return GetSelectionAtIndex(nullptr, nStart, nEnd);
}
// helper for GetSelection and getCaretPosition
// #i27301# - add parameter <_bForSelection>, which indicates,
// if the cursor is retrieved for selection or for caret position.
SwPaM* GetCursor( const bool _bForSelection );
// for cut/copy/paste: execute a particular slot at the view shell
void ExecuteAtViewShell( sal_uInt16 nSlot );
// helper method for get/setAttributes
// (for the special case of (nEndIndex==-1) a single character will
// be selected)
rtl::Reference<SwXTextPortion> CreateUnoPortion( sal_Int32 nStart, sal_Int32 nEnd );
// methods for checking the parameter range:
// does nPos point to a char?
static bool IsValidChar(sal_Int32 nPos, sal_Int32 nLength);
// does nPos point to a position? (may be behind the last character)
static bool IsValidPosition(sal_Int32 nPos, sal_Int32 nLength);
// is nBegin...nEnd a valid range? (nEnd points past the last character)
static bool IsValidRange(sal_Int32 nBegin, sal_Int32 nEnd, sal_Int32 nLength);
// Ensure ordered range (i.e. nBegin is smaller then nEnd)
static void OrderRange(sal_Int32& nBegin, sal_Int32& nEnd)
{
if( nBegin > nEnd )
std::swap( nBegin, nEnd );
}
const SwRangeRedline* GetRedlineAtIndex();
OUString GetFieldTypeNameAtIndex(sal_Int32 nIndex);
// #i63870#
void _getDefaultAttributesImpl(
const css::uno::Sequence< OUString >& aRequestedAttributes,
tAccParaPropValMap& rDefAttrSeq,
const bool bOnlyCharAttrs = false );
void _getRunAttributesImpl(
const sal_Int32 nIndex,
const css::uno::Sequence< OUString >& aRequestedAttributes,
tAccParaPropValMap& rRunAttrSeq );
void _getSupplementalAttributesImpl(
const css::uno::Sequence< OUString >& aRequestedAttributes,
tAccParaPropValMap& rSupplementalAttrSeq );
void _correctValues(
const sal_Int32 nIndex,
std::vector< css::beans::PropertyValue >& rValues );
public:
bool IsHeading() const;
protected:
// Set states for getAccessibleStateSet.
// This derived class additionally sets MULTILINE(1), MULTISELECTABLE(+),
// FOCUSABLE(+) and FOCUSED(+)
virtual void GetStates( sal_Int64& rStateSet ) override;
virtual void InvalidateContent_( bool bVisibleDataFired ) override;
virtual void InvalidateCursorPos_() override;
virtual void InvalidateFocus_() override;
virtual ~SwAccessibleParagraph() override;
// handling of data for the text portions
// force update of new portion data
/// @throws css::uno::RuntimeException
void UpdatePortionData();
// remove the current portion data
void ClearPortionData();
// get portion data; update if necessary
/// @throws css::uno::RuntimeException
SwAccessiblePortionData& GetPortionData()
{
if( m_pPortionData == nullptr )
UpdatePortionData();
return *m_pPortionData;
}
//helpers for word boundaries
bool GetCharBoundary( css::i18n::Boundary& rBound,
std::u16string_view text,
sal_Int32 nPos );
bool GetWordBoundary( css::i18n::Boundary& rBound,
const OUString& rText,
sal_Int32 nPos );
bool GetSentenceBoundary( css::i18n::Boundary& rBound,
const OUString& rText,
sal_Int32 nPos );
bool GetLineBoundary( css::i18n::Boundary& rBound,
std::u16string_view aText,
sal_Int32 nPos );
static bool GetParagraphBoundary( css::i18n::Boundary& rBound,
std::u16string_view aText );
bool GetAttributeBoundary( css::i18n::Boundary& rBound,
sal_Int32 nPos );
bool GetGlyphBoundary( css::i18n::Boundary& rBound,
const OUString& rText,
sal_Int32 nPos );
// get boundaries of word/sentence/etc. for specified text type
// Does all argument checking, and then delegates to helper methods above.
/// @throws css::lang::IndexOutOfBoundsException
/// @throws css::lang::IllegalArgumentException
/// @throws css::uno::RuntimeException
bool GetTextBoundary( css::i18n::Boundary& rBound,
const OUString& rText,
sal_Int32 nPos,
sal_Int16 aTextType );
virtual void Notify(SfxBroadcaster& rBC, const SfxHint& rHint) override;
public:
SwAccessibleParagraph( std::shared_ptr<SwAccessibleMap> const& pInitMap,
const SwTextFrame& rTextFrame );
virtual bool HasCursor() override; // required by map to remember that object
css::uno::Sequence< css::style::TabStop > GetCurrentTabStop( sal_Int32 nIndex );
virtual sal_Int16 SAL_CALL getAccessibleRole() override;
// XAccessibleContext
// Return this object's description.
virtual OUString SAL_CALL
getAccessibleDescription() override;
// Return the parents locale or throw exception if this object has no
// parent yet/anymore.
virtual css::lang::Locale SAL_CALL
getLocale() override;
// #i27138# - paragraphs are in relation CONTENT_FLOWS_FROM and/or CONTENT_FLOWS_TO
virtual css::uno::Reference<
css::accessibility::XAccessibleRelationSet> SAL_CALL
getAccessibleRelationSet() override;
// XAccessibleComponent
virtual void SAL_CALL grabFocus() override;
// #i71385#
virtual sal_Int32 SAL_CALL getForeground() override;
virtual sal_Int32 SAL_CALL getBackground() override;
// XServiceInfo
// Returns an identifier for the implementation of this object.
virtual OUString SAL_CALL
getImplementationName() override;
// Returns a list of all supported services. In this case that is just
// the AccessibleContext service.
virtual css::uno::Sequence< OUString> SAL_CALL
getSupportedServiceNames() override;
// XAccessibleText
virtual sal_Int32 SAL_CALL getCaretPosition() override;
virtual sal_Bool SAL_CALL setCaretPosition( sal_Int32 nIndex ) override;
virtual sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) override;
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCharacterAttributes( sal_Int32 nIndex, const css::uno::Sequence< OUString >& aRequestedAttributes ) override;
virtual css::awt::Rectangle SAL_CALL getCharacterBounds( sal_Int32 nIndex ) override;
virtual sal_Int32 SAL_CALL getCharacterCount( ) override;
virtual sal_Int32 SAL_CALL getIndexAtPoint( const css::awt::Point& aPoint ) override;
virtual OUString SAL_CALL getSelectedText( ) override;
virtual sal_Int32 SAL_CALL getSelectionStart() override;
virtual sal_Int32 SAL_CALL getSelectionEnd() override;
virtual sal_Bool SAL_CALL setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
virtual OUString SAL_CALL getText( ) override;
virtual OUString SAL_CALL getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) 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;
virtual sal_Bool SAL_CALL copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
virtual sal_Bool SAL_CALL scrollSubstringTo( sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override;
// XAccessibleEditableText
virtual sal_Bool SAL_CALL cutText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
virtual sal_Bool SAL_CALL pasteText( sal_Int32 nIndex ) override;
virtual sal_Bool SAL_CALL deleteText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
virtual sal_Bool SAL_CALL insertText( const OUString& sText, sal_Int32 nIndex ) override;
virtual sal_Bool SAL_CALL replaceText( sal_Int32 nStartIndex, sal_Int32 nEndIndex, const OUString& sReplacement ) override;
virtual sal_Bool SAL_CALL setAttributes( sal_Int32 nStartIndex, sal_Int32 nEndIndex, const css::uno::Sequence< css::beans::PropertyValue >& aAttributeSet ) override;
virtual sal_Bool SAL_CALL setText( const OUString& sText ) override;
// XAccessibleSelection
virtual void SAL_CALL selectAccessibleChild(
sal_Int64 nChildIndex ) override;
virtual sal_Bool SAL_CALL isAccessibleChildSelected(
sal_Int64 nChildIndex ) override;
virtual void SAL_CALL clearAccessibleSelection( ) override;
virtual void SAL_CALL selectAllAccessibleChildren( ) override;
virtual sal_Int64 SAL_CALL getSelectedAccessibleChildCount( ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild(
sal_Int64 nSelectedChildIndex ) override;
// index has to be treated as global child index.
virtual void SAL_CALL deselectAccessibleChild(
sal_Int64 nChildIndex ) override;
// XAccessibleHypertext
virtual sal_Int32 SAL_CALL getHyperLinkCount() override;
virtual css::uno::Reference<
css::accessibility::XAccessibleHyperlink >
SAL_CALL getHyperLink( sal_Int32 nLinkIndex ) override;
virtual sal_Int32 SAL_CALL getHyperLinkIndex( sal_Int32 nCharIndex ) override;
// #i71360#
// XAccessibleTextMarkup
virtual sal_Int32 SAL_CALL getTextMarkupCount( sal_Int32 nTextMarkupType ) override;
virtual css::accessibility::TextSegment SAL_CALL
getTextMarkup( sal_Int32 nTextMarkupIndex,
sal_Int32 nTextMarkupType ) override;
virtual css::uno::Sequence< css::accessibility::TextSegment > SAL_CALL
getTextMarkupAtIndex( sal_Int32 nCharIndex,
sal_Int32 nTextMarkupType ) override;
// XAccessibleTextSelection
virtual sal_Bool SAL_CALL scrollToPosition( const css::awt::Point& aPoint, sal_Bool isLeftTop ) override;
virtual sal_Int32 SAL_CALL getSelectedPortionCount( ) override;
virtual sal_Int32 SAL_CALL getSeletedPositionStart( sal_Int32 nSelectedPortionIndex ) override;
virtual sal_Int32 SAL_CALL getSeletedPositionEnd( sal_Int32 nSelectedPortionIndex ) override;
virtual sal_Bool SAL_CALL removeSelection( sal_Int32 selectionIndex ) override;
virtual sal_Int32 SAL_CALL addSelection( sal_Int32 selectionIndex, sal_Int32 startOffset, sal_Int32 endOffset) override;
// XAccessibleExtendedAttributes
virtual OUString SAL_CALL getExtendedAttributes() override;
sal_Int32 GetRealHeadingLevel();
bool IsBlockQuote();
// #i89175#
// XAccessibleMultiLineText
virtual sal_Int32 SAL_CALL getLineNumberAtIndex( sal_Int32 nIndex ) override;
virtual css::accessibility::TextSegment SAL_CALL
getTextAtLineNumber( sal_Int32 nLineNo ) override;
virtual css::accessibility::TextSegment SAL_CALL
getTextAtLineWithCaret() override;
virtual sal_Int32 SAL_CALL getNumberOfLineWithCaret() override;
// #i63870#
// XAccessibleTextAttributes
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getDefaultAttributes( const css::uno::Sequence< OUString >& aRequestedAttributes ) override;
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getRunAttributes( sal_Int32 nIndex, const css::uno::Sequence< OUString >& aRequestedAttributes ) override;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|