accessibility/source/standard/vclxaccessibleedit.cxx

   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 #include <standard/vclxaccessibleedit.hxx>
  21
  22 #include <toolkit/awt/vclxwindows.hxx>
  23 #include <toolkit/helper/vclunohelper.hxx>
  24
  25 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  26 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  27 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  28 #include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
  29 #include <com/sun/star/accessibility/AccessibleTextType.hpp>
  30 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  31 #include <comphelper/accessiblecontexthelper.hxx>
  32 #include <comphelper/string.hxx>
  33 #include <vcl/svapp.hxx>
  34 #include <vcl/window.hxx>
  35 #include <vcl/mnemonic.hxx>
  36 #include <vcl/settings.hxx>
  37 #include <vcl/toolkit/edit.hxx>
  38 #include <vcl/toolkit/vclmedit.hxx>
  39 #include <vcl/textdata.hxx>
  40 #include <vcl/txtattr.hxx>
  41 #include <vcl/xtextedt.hxx>
  42 #include <sot/exchange.hxx>
  43 #include <sot/formats.hxx>
  44
  45 #include <algorithm>
  46
  47 using namespace ::com::sun::star;
  48 using namespace ::com::sun::star::uno;
  49 using namespace ::com::sun::star::lang;
  50 using namespace ::com::sun::star::beans;
  51 using namespace ::com::sun::star::accessibility;
  52 using namespace ::comphelper;
  53
  54
  55 // VCLXAccessibleEdit
  56
  57
  58 VCLXAccessibleEdit::VCLXAccessibleEdit( VCLXWindow* pVCLWindow )
  59     :ImplInheritanceHelper( pVCLWindow )
  60 {
  61     m_nCaretPosition = getCaretPosition();
  62 }
  63
  64
  65 void VCLXAccessibleEdit::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  66 {
  67     switch ( rVclWindowEvent.GetId() )
  68     {
  69         case VclEventId::EditModify:
  70         {
  71             SetText( implGetText() );
  72         }
  73         break;
  74         case VclEventId::EditCaretChanged:
  75         {
  76             sal_Int32 nOldCaretPosition = m_nCaretPosition;
  77             m_nCaretPosition = getCaretPosition();
  78
  79             VclPtr<vcl::Window> pWindow = GetWindow();
  80             if (pWindow && pWindow->HasChildPathFocus())
  81             {
  82                 if (m_nCaretPosition != nOldCaretPosition)
  83                 {
  84                     Any aOldValue, aNewValue;
  85                     aOldValue <<= nOldCaretPosition;
  86                     aNewValue <<= m_nCaretPosition;
  87                     NotifyAccessibleEvent( AccessibleEventId::CARET_CHANGED, aOldValue, aNewValue );
  88                 }
  89             }
  90         }
  91         break;
  92         case VclEventId::EditSelectionChanged:
  93         {
  94             VclPtr<vcl::Window> pWindow = GetWindow();
  95             if (pWindow && pWindow->HasChildPathFocus())
  96             {
  97                 NotifyAccessibleEvent( AccessibleEventId::TEXT_SELECTION_CHANGED, Any(), Any() );
  98             }
  99         }
 100         break;
 101         default:
 102             VCLXAccessibleTextComponent::ProcessWindowEvent( rVclWindowEvent );
 103    }
 104 }
 105
 106
 107 void VCLXAccessibleEdit::FillAccessibleStateSet( sal_Int64& rStateSet )
 108 {
 109     VCLXAccessibleTextComponent::FillAccessibleStateSet( rStateSet );
 110
 111     VCLXWindow* pVCLXWindow = GetVCLXWindow();
 112     if (pVCLXWindow)
 113     {
 114         rStateSet |= AccessibleStateType::FOCUSABLE;
 115
 116         if (GetWindow() && GetWindow()->GetType() == WindowType::MULTILINEEDIT)
 117             rStateSet |= AccessibleStateType::MULTI_LINE;
 118         else
 119             rStateSet |= AccessibleStateType::SINGLE_LINE;
 120
 121         if (isEditable())
 122             rStateSet |= AccessibleStateType::EDITABLE;
 123     }
 124 }
 125
 126
 127 // OCommonAccessibleText
 128
 129
 130 OUString VCLXAccessibleEdit::implGetText()
 131 {
 132     OUString aText;
 133
 134     VclPtr< Edit > pEdit = GetAs< Edit >();
 135     if ( pEdit )
 136     {
 137         aText = removeMnemonicFromString( pEdit->GetText() );
 138
 139         if ( implGetAccessibleRole() == AccessibleRole::PASSWORD_TEXT )
 140         {
 141             sal_Unicode cEchoChar = pEdit->GetEchoChar();
 142             if ( !cEchoChar )
 143                 cEchoChar = '*';
 144             OUStringBuffer sTmp(aText.getLength());
 145             aText = comphelper::string::padToLength(sTmp, aText.getLength(),
 146                 cEchoChar).makeStringAndClear();
 147         }
 148     }
 149
 150     return aText;
 151 }
 152
 153
 154 void VCLXAccessibleEdit::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
 155 {
 156     Selection aSelection;
 157     VclPtr<Edit> pEdit = GetAs<Edit>();
 158     if (pEdit)
 159         aSelection = pEdit->GetSelection();
 160
 161     nStartIndex = aSelection.Min();
 162     nEndIndex = aSelection.Max();
 163 }
 164
 165 // VCLXAccessibleTextComponent
 166 bool VCLXAccessibleEdit::PreferFullTextInTextChangedEvent()
 167 {
 168     // for a combobox subedit, the Orca screen reader announces the new/added text
 169     // so always send the whole old and new text and not just
 170     // the changed characters, so the whole entry text gets announced
 171     Reference<XAccessible> xParent = getAccessibleParent();
 172     if (xParent.is())
 173     {
 174         Reference<XAccessibleContext> xParentContext = xParent->getAccessibleContext();
 175         if (xParentContext.is() && xParentContext->getAccessibleRole() == AccessibleRole::COMBO_BOX)
 176             return true;
 177     }
 178
 179     return false;
 180 }
 181
 182 // XServiceInfo
 183
 184
 185 OUString VCLXAccessibleEdit::getImplementationName()
 186 {
 187     return u"com.sun.star.comp.toolkit.AccessibleEdit"_ustr;
 188 }
 189
 190
 191 Sequence< OUString > VCLXAccessibleEdit::getSupportedServiceNames()
 192 {
 193     return { u"com.sun.star.awt.AccessibleEdit"_ustr };
 194 }
 195
 196
 197 // XAccessibleContext
 198
 199
 200 sal_Int64 VCLXAccessibleEdit::getAccessibleChildCount()
 201 {
 202     OExternalLockGuard aGuard( this );
 203
 204     return 0;
 205 }
 206
 207
 208 Reference< XAccessible > VCLXAccessibleEdit::getAccessibleChild( sal_Int64 )
 209 {
 210     throw IndexOutOfBoundsException();
 211 }
 212
 213
 214 sal_Int16 VCLXAccessibleEdit::getAccessibleRole(  )
 215 {
 216     OExternalLockGuard aGuard( this );
 217
 218     return implGetAccessibleRole();
 219 }
 220
 221 sal_Int16 VCLXAccessibleEdit::implGetAccessibleRole(  )
 222 {
 223     sal_Int16 nRole;
 224     VclPtr< Edit > pEdit = GetAs< Edit >();
 225     if ( pEdit && ( pEdit->IsPassword() || pEdit->GetEchoChar() ) )
 226         nRole = AccessibleRole::PASSWORD_TEXT;
 227     else if ( pEdit && ( pEdit->GetStyle() & WB_READONLY ) )
 228         nRole = AccessibleRole::STATIC;
 229     else
 230         nRole = AccessibleRole::TEXT;
 231
 232     return nRole;
 233 }
 234
 235
 236 // XAccessibleAction
 237
 238
 239 sal_Int32 VCLXAccessibleEdit::getAccessibleActionCount( )
 240 {
 241     OExternalLockGuard aGuard( this );
 242
 243     // There is one action: activate
 244     return 1;
 245 }
 246
 247
 248 sal_Bool VCLXAccessibleEdit::doAccessibleAction ( sal_Int32 nIndex )
 249 {
 250     OExternalLockGuard aGuard( this );
 251
 252     if ( nIndex != 0 )
 253         throw IndexOutOfBoundsException();
 254
 255     bool bDoAction = false;
 256     VclPtr<vcl::Window> pWindow = GetWindow();
 257     if ( pWindow )
 258     {
 259         pWindow->GrabFocus();
 260         bDoAction = true;
 261     }
 262
 263     return bDoAction;
 264 }
 265
 266
 267 OUString VCLXAccessibleEdit::getAccessibleActionDescription ( sal_Int32 nIndex )
 268 {
 269     OExternalLockGuard aGuard( this );
 270
 271     if ( nIndex != 0)
 272         throw IndexOutOfBoundsException();
 273
 274     return u"activate"_ustr;
 275 }
 276
 277
 278 Reference< XAccessibleKeyBinding > VCLXAccessibleEdit::getAccessibleActionKeyBinding( sal_Int32 nIndex )
 279 {
 280     OExternalLockGuard aGuard( this );
 281
 282     if ( nIndex != 0 )
 283         throw IndexOutOfBoundsException();
 284
 285     return Reference< XAccessibleKeyBinding >();
 286 }
 287
 288
 289 // XAccessibleText
 290
 291
 292 sal_Int32 VCLXAccessibleEdit::getCaretPosition(  )
 293 {
 294     return getSelectionEnd();
 295 }
 296
 297
 298 sal_Bool VCLXAccessibleEdit::setCaretPosition( sal_Int32 nIndex )
 299 {
 300     return setSelection( nIndex, nIndex );
 301 }
 302
 303
 304 sal_Unicode VCLXAccessibleEdit::getCharacter( sal_Int32 nIndex )
 305 {
 306     return VCLXAccessibleTextComponent::getCharacter( nIndex );
 307 }
 308
 309
 310 Sequence< PropertyValue > VCLXAccessibleEdit::getCharacterAttributes( sal_Int32 nIndex, const Sequence< OUString >& aRequestedAttributes )
 311 {
 312     OExternalLockGuard aGuard( this );
 313     Sequence< PropertyValue > aProperties = VCLXAccessibleTextComponent::getCharacterAttributes( nIndex, aRequestedAttributes );
 314     auto aNonConstRange = asNonConstRange(aProperties);
 315
 316     // Handle multiline edit character properties
 317     VclPtr<VclMultiLineEdit> pMulitLineEdit = GetAsDynamic< VclMultiLineEdit >();
 318     if ( pMulitLineEdit )
 319     {
 320         ExtTextEngine* pTextEngine = pMulitLineEdit->GetTextEngine();
 321         TextPaM aCursor( 0, nIndex );
 322         const TextAttribFontColor* pFontColor = static_cast<const TextAttribFontColor* >(pTextEngine->FindAttrib( aCursor, TEXTATTR_FONTCOLOR ));
 323         if ( pFontColor )
 324         {
 325             for (PropertyValue& aValue : aNonConstRange )
 326             {
 327                 if (aValue.Name == "CharColor")
 328                 {
 329                     aValue.Value <<= pFontColor->GetColor().GetRGBColor();
 330                     break;
 331                 }
 332             }
 333         }
 334     }
 335
 336     // Set default character color if it is not set yet to a valid value
 337     for (PropertyValue& aValue : aNonConstRange )
 338     {
 339         if (aValue.Name == "CharColor")
 340         {
 341             if ( aValue.Value == sal_Int32(-1) )
 342             {
 343                 OutputDevice* pDev = Application::GetDefaultDevice();
 344                 if ( pDev )
 345                 {
 346                     aValue.Value <<= pDev->GetSettings().GetStyleSettings().GetFieldTextColor();
 347                 }
 348             }
 349             break;
 350         }
 351     }
 352
 353     return aProperties;
 354 }
 355
 356
 357 awt::Rectangle VCLXAccessibleEdit::getCharacterBounds( sal_Int32 nIndex )
 358 {
 359     OExternalLockGuard aGuard( this );
 360
 361     awt::Rectangle aBounds( 0, 0, 0, 0 );
 362     sal_Int32 nLength = implGetText().getLength();
 363
 364     if ( !implIsValidRange( nIndex, nIndex, nLength ) )
 365         throw IndexOutOfBoundsException();
 366
 367     VclPtr< Control > pControl = GetAs< Control >();
 368     if ( pControl )
 369     {
 370         if ( nIndex == nLength )
 371         {
 372             // #108914# calculate virtual bounding rectangle
 373             for ( sal_Int32 i = 0; i < nLength; ++i )
 374             {
 375                 tools::Rectangle aRect = pControl->GetCharacterBounds( i );
 376                 sal_Int32 nHeight = aRect.GetHeight();
 377                 if ( aBounds.Height < nHeight )
 378                 {
 379                     aBounds.Y = aRect.Top();
 380                     aBounds.Height = nHeight;
 381                 }
 382                 if ( i == nLength - 1 )
 383                 {
 384                     aBounds.X = aRect.Right() + 1;
 385                     aBounds.Width = 1;
 386                 }
 387             }
 388         }
 389         else
 390         {
 391             aBounds = VCLUnoHelper::ConvertToAWTRect(pControl->GetCharacterBounds(nIndex));
 392         }
 393     }
 394
 395     return aBounds;
 396 }
 397
 398
 399 sal_Int32 VCLXAccessibleEdit::getCharacterCount(  )
 400 {
 401     return VCLXAccessibleTextComponent::getCharacterCount();
 402 }
 403
 404
 405 sal_Int32 VCLXAccessibleEdit::getIndexAtPoint( const awt::Point& aPoint )
 406 {
 407     return VCLXAccessibleTextComponent::getIndexAtPoint( aPoint );
 408 }
 409
 410
 411 OUString VCLXAccessibleEdit::getSelectedText(  )
 412 {
 413     return VCLXAccessibleTextComponent::getSelectedText();
 414 }
 415
 416
 417 sal_Int32 VCLXAccessibleEdit::getSelectionStart(  )
 418 {
 419     return VCLXAccessibleTextComponent::getSelectionStart();
 420 }
 421
 422
 423 sal_Int32 VCLXAccessibleEdit::getSelectionEnd(  )
 424 {
 425     return VCLXAccessibleTextComponent::getSelectionEnd();
 426 }
 427
 428
 429 sal_Bool VCLXAccessibleEdit::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 430 {
 431     OExternalLockGuard aGuard( this );
 432
 433     bool bReturn = false;
 434     OUString sText( implGetText() );
 435
 436     if ( !implIsValidRange( nStartIndex, nEndIndex, sText.getLength() ) )
 437         throw IndexOutOfBoundsException();
 438
 439     VclPtr< Edit > pEdit = GetAs< Edit >();
 440     if (pEdit && pEdit->IsEnabled())
 441     {
 442         pEdit->SetSelection(Selection(nStartIndex, nEndIndex));
 443         bReturn = true;
 444     }
 445
 446     return bReturn;
 447 }
 448
 449
 450 OUString VCLXAccessibleEdit::getText(  )
 451 {
 452     return VCLXAccessibleTextComponent::getText();
 453 }
 454
 455
 456 OUString VCLXAccessibleEdit::getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 457 {
 458     return VCLXAccessibleTextComponent::getTextRange( nStartIndex, nEndIndex );
 459 }
 460
 461
 462 css::accessibility::TextSegment VCLXAccessibleEdit::getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 463 {
 464     OExternalLockGuard aGuard( this );
 465     // Override general text component behavior: MultiLineEdit can have more text portions
 466     if ( aTextType == AccessibleTextType::ATTRIBUTE_RUN )
 467     {
 468         VclPtr<VclMultiLineEdit> pMulitLineEdit = GetAsDynamic< VclMultiLineEdit >();
 469         if ( pMulitLineEdit )
 470         {
 471             ExtTextEngine* pTextEngine = pMulitLineEdit->GetTextEngine();
 472             TextPaM aCursor( 0, nIndex );
 473             TextSegment aResult;
 474             pTextEngine->GetTextPortionRange( aCursor, aResult.SegmentStart, aResult.SegmentEnd );
 475             return aResult;
 476         }
 477     }
 478
 479     return VCLXAccessibleTextComponent::getTextAtIndex( nIndex, aTextType );
 480 }
 481
 482
 483 css::accessibility::TextSegment VCLXAccessibleEdit::getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 484 {
 485     return VCLXAccessibleTextComponent::getTextBeforeIndex( nIndex, aTextType );
 486 }
 487
 488
 489 css::accessibility::TextSegment VCLXAccessibleEdit::getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 490 {
 491     return VCLXAccessibleTextComponent::getTextBehindIndex( nIndex, aTextType );
 492 }
 493
 494
 495 sal_Bool VCLXAccessibleEdit::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 496 {
 497     return VCLXAccessibleTextComponent::copyText( nStartIndex, nEndIndex );
 498 }
 499
 500 sal_Bool VCLXAccessibleEdit::scrollSubstringTo( sal_Int32, sal_Int32, AccessibleScrollType )
 501 {
 502     return false;
 503 }
 504
 505 // XAccessibleEditableText
 506
 507
 508 sal_Bool VCLXAccessibleEdit::cutText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 509 {
 510     return copyText( nStartIndex, nEndIndex ) && deleteText( nStartIndex, nEndIndex );
 511 }
 512
 513
 514 sal_Bool VCLXAccessibleEdit::pasteText( sal_Int32 nIndex )
 515 {
 516     OExternalLockGuard aGuard( this );
 517
 518     bool bReturn = false;
 519
 520     if ( GetWindow() )
 521     {
 522         Reference< datatransfer::clipboard::XClipboard > xClipboard = GetWindow()->GetClipboard();
 523         if ( xClipboard.is() )
 524         {
 525             Reference< datatransfer::XTransferable > xDataObj;
 526             {
 527                 SolarMutexReleaser aReleaser;
 528                 xDataObj = xClipboard->getContents();
 529             }
 530             if ( xDataObj.is() )
 531             {
 532                 datatransfer::DataFlavor aFlavor;
 533                 SotExchange::GetFormatDataFlavor( SotClipboardFormatId::STRING, aFlavor );
 534                 if ( xDataObj->isDataFlavorSupported( aFlavor ) )
 535                 {
 536                     Any aData = xDataObj->getTransferData( aFlavor );
 537                     OUString sText;
 538                     aData >>= sText;
 539                     bReturn = replaceText( nIndex, nIndex, sText );
 540                 }
 541             }
 542         }
 543     }
 544
 545     return bReturn;
 546 }
 547
 548
 549 sal_Bool VCLXAccessibleEdit::deleteText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 550 {
 551     return replaceText( nStartIndex, nEndIndex, OUString() );
 552 }
 553
 554
 555 sal_Bool VCLXAccessibleEdit::insertText( const OUString& sText, sal_Int32 nIndex )
 556 {
 557     return replaceText( nIndex, nIndex, sText );
 558 }
 559
 560
 561 sal_Bool VCLXAccessibleEdit::replaceText( sal_Int32 nStartIndex, sal_Int32 nEndIndex, const OUString& sReplacement )
 562 {
 563     OExternalLockGuard aGuard( this );
 564
 565     bool bReturn = false;
 566     OUString sText( implGetText() );
 567
 568     if ( !implIsValidRange( nStartIndex, nEndIndex, sText.getLength() ) )
 569         throw IndexOutOfBoundsException();
 570
 571     sal_Int32 nMinIndex = std::min( nStartIndex, nEndIndex );
 572     sal_Int32 nMaxIndex = std::max( nStartIndex, nEndIndex );
 573
 574
 575     if (isEditable())
 576     {
 577         VclPtr<Edit> pEdit = GetAs<Edit>();
 578         assert(pEdit);
 579         pEdit->SetText(sText.replaceAt(nMinIndex, nMaxIndex - nMinIndex, sReplacement));
 580         sal_Int32 nIndex = nMinIndex + sReplacement.getLength();
 581         setSelection( nIndex, nIndex );
 582         bReturn = true;
 583     }
 584
 585     return bReturn;
 586 }
 587
 588
 589 sal_Bool VCLXAccessibleEdit::setAttributes( sal_Int32 nStartIndex, sal_Int32 nEndIndex, const Sequence<PropertyValue>& )
 590 {
 591     OExternalLockGuard aGuard( this );
 592
 593     if ( !implIsValidRange( nStartIndex, nEndIndex, implGetText().getLength() ) )
 594         throw IndexOutOfBoundsException();
 595
 596     return false;   // attributes cannot be set for an edit
 597 }
 598
 599
 600 sal_Bool VCLXAccessibleEdit::setText( const OUString& sText )
 601 {
 602     OExternalLockGuard aGuard( this );
 603
 604     bool bReturn = false;
 605
 606     if (isEditable())
 607     {
 608         VclPtr<Edit> pEdit = GetAs<Edit>();
 609         assert(pEdit);
 610         pEdit->SetText(sText);
 611         sal_Int32 nSize = sText.getLength();
 612         pEdit->SetSelection(Selection(nSize, nSize) );
 613         bReturn = true;
 614     }
 615
 616     return bReturn;
 617 }
 618
 619 bool VCLXAccessibleEdit::isEditable()
 620 {
 621     VclPtr<Edit> pEdit = GetAs<Edit>();
 622     return pEdit && !pEdit->IsReadOnly() && pEdit->IsEnabled();
 623 }
 624
 625 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */