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