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