accessibility/source/standard/vclxaccessiblemenuitem.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/vclxaccessiblemenuitem.hxx>
  21 #include <helper/characterattributeshelper.hxx>
  22 #include <comphelper/accessiblecontexthelper.hxx>
  23 #include <comphelper/accessiblekeybindinghelper.hxx>
  24 #include <com/sun/star/awt/KeyModifier.hpp>
  25
  26 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  27 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  28 #include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
  29 #include <com/sun/star/datatransfer/clipboard/XFlushableClipboard.hpp>
  30 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  31 #include <comphelper/sequence.hxx>
  32 #include <i18nlangtag/languagetag.hxx>
  33 #include <toolkit/helper/vclunohelper.hxx>
  34 #include <vcl/event.hxx>
  35 #include <vcl/svapp.hxx>
  36 #include <vcl/window.hxx>
  37 #include <vcl/menu.hxx>
  38 #include <vcl/unohelp2.hxx>
  39 #include <vcl/settings.hxx>
  40 #include <strings.hxx>
  41
  42 using namespace ::com::sun::star::accessibility;
  43 using namespace ::com::sun::star::uno;
  44 using namespace ::com::sun::star::beans;
  45 using namespace ::com::sun::star::lang;
  46 using namespace ::com::sun::star;
  47 using namespace ::comphelper;
  48
  49
  50
  51
  52 VCLXAccessibleMenuItem::VCLXAccessibleMenuItem( Menu* pParent, sal_uInt16 nItemPos, Menu* pMenu )
  53     :ImplInheritanceHelper( pParent, nItemPos, pMenu )
  54 {
  55 }
  56
  57
  58 bool VCLXAccessibleMenuItem::IsFocused()
  59 {
  60     return IsHighlighted();
  61 }
  62
  63
  64 bool VCLXAccessibleMenuItem::IsSelected()
  65 {
  66     return IsHighlighted();
  67 }
  68
  69 bool VCLXAccessibleMenuItem::IsCheckable()
  70 {
  71     if (!m_pParent)
  72         return false;
  73
  74     const sal_uInt16 nItemId = m_pParent->GetItemId(m_nItemPos);
  75     return m_pParent->IsItemCheckable(nItemId);
  76 }
  77
  78 bool VCLXAccessibleMenuItem::IsChecked()
  79 {
  80     bool bChecked = false;
  81
  82     if ( m_pParent )
  83     {
  84         sal_uInt16 nItemId = m_pParent->GetItemId( m_nItemPos );
  85         if ( m_pParent->IsItemChecked( nItemId ) )
  86             bChecked = true;
  87     }
  88
  89     return bChecked;
  90 }
  91
  92
  93 bool VCLXAccessibleMenuItem::IsHighlighted()
  94 {
  95     bool bHighlighted = false;
  96
  97     if ( m_pParent && m_pParent->IsHighlighted( m_nItemPos ) )
  98         bHighlighted = true;
  99
 100     return bHighlighted;
 101 }
 102
 103
 104 void VCLXAccessibleMenuItem::FillAccessibleStateSet( sal_Int64& rStateSet )
 105 {
 106     OAccessibleMenuItemComponent::FillAccessibleStateSet( rStateSet );
 107
 108     rStateSet |= AccessibleStateType::FOCUSABLE;
 109
 110     if ( IsFocused() )
 111         rStateSet |= AccessibleStateType::FOCUSED;
 112
 113     rStateSet |= AccessibleStateType::SELECTABLE;
 114
 115     if ( IsSelected() )
 116         rStateSet |= AccessibleStateType::SELECTED;
 117
 118     if (IsCheckable())
 119         rStateSet |= AccessibleStateType::CHECKABLE;
 120     if ( IsChecked() )
 121         rStateSet |= AccessibleStateType::CHECKED;
 122 }
 123
 124
 125 // OCommonAccessibleText
 126
 127
 128 OUString VCLXAccessibleMenuItem::implGetText()
 129 {
 130     return m_sItemText;
 131 }
 132
 133
 134 Locale VCLXAccessibleMenuItem::implGetLocale()
 135 {
 136     return Application::GetSettings().GetLanguageTag().getLocale();
 137 }
 138
 139
 140 void VCLXAccessibleMenuItem::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
 141 {
 142     nStartIndex = 0;
 143     nEndIndex = 0;
 144 }
 145
 146
 147 // XServiceInfo
 148
 149
 150 OUString VCLXAccessibleMenuItem::getImplementationName()
 151 {
 152     return u"com.sun.star.comp.toolkit.AccessibleMenuItem"_ustr;
 153 }
 154
 155
 156 Sequence< OUString > VCLXAccessibleMenuItem::getSupportedServiceNames()
 157 {
 158     return { u"com.sun.star.awt.AccessibleMenuItem"_ustr };
 159 }
 160
 161
 162 // XAccessibleContext
 163
 164
 165 sal_Int16 VCLXAccessibleMenuItem::getAccessibleRole(  )
 166 {
 167     OExternalLockGuard aGuard( this );
 168     // IA2 CWS. MT: We had the additional roles in UAA for ever, but never used them anywhere.
 169     // Looks reasonable, but need to verify in Orca and VoiceOver.
 170     sal_Int16 nRole = AccessibleRole::MENU_ITEM;
 171     if ( m_pParent )
 172     {
 173         sal_uInt16 nItemId = m_pParent->GetItemId( m_nItemPos );
 174         MenuItemBits nItemBits = m_pParent->GetItemBits(nItemId);
 175         if(  nItemBits & MenuItemBits::RADIOCHECK)
 176             nRole = AccessibleRole::RADIO_MENU_ITEM;
 177         else if( nItemBits & MenuItemBits::CHECKABLE)
 178             nRole = AccessibleRole::CHECK_MENU_ITEM;
 179     }
 180     return nRole;
 181 }
 182
 183
 184 // XAccessibleText
 185
 186
 187 sal_Int32 VCLXAccessibleMenuItem::getCaretPosition()
 188 {
 189     return -1;
 190 }
 191
 192
 193 sal_Bool VCLXAccessibleMenuItem::setCaretPosition( sal_Int32 nIndex )
 194 {
 195
 196     OExternalLockGuard aGuard( this );
 197
 198     if ( !implIsValidRange( nIndex, nIndex, m_sItemText.getLength() ) )
 199         throw IndexOutOfBoundsException();
 200
 201     return false;
 202 }
 203
 204
 205 sal_Unicode VCLXAccessibleMenuItem::getCharacter( sal_Int32 nIndex )
 206 {
 207     OExternalLockGuard aGuard( this );
 208
 209     return OCommonAccessibleText::implGetCharacter( implGetText(), nIndex );
 210 }
 211
 212
 213 Sequence< PropertyValue > VCLXAccessibleMenuItem::getCharacterAttributes( sal_Int32 nIndex, const Sequence< OUString >& aRequestedAttributes )
 214 {
 215     OExternalLockGuard aGuard( this );
 216
 217     if ( !implIsValidIndex( nIndex, m_sItemText.getLength() ) )
 218         throw IndexOutOfBoundsException();
 219
 220     vcl::Font aFont = Application::GetSettings().GetStyleSettings().GetMenuFont();
 221     sal_Int32 nBackColor = getBackground();
 222     sal_Int32 nColor = getForeground();
 223     return CharacterAttributesHelper( aFont, nBackColor, nColor )
 224         .GetCharacterAttributes( aRequestedAttributes );
 225 }
 226
 227
 228 awt::Rectangle VCLXAccessibleMenuItem::getCharacterBounds( sal_Int32 nIndex )
 229 {
 230     OExternalLockGuard aGuard( this );
 231
 232     if ( !implIsValidIndex( nIndex, m_sItemText.getLength() ) )
 233         throw IndexOutOfBoundsException();
 234
 235     awt::Rectangle aBounds( 0, 0, 0, 0 );
 236     if ( m_pParent )
 237     {
 238         sal_uInt16 nItemId = m_pParent->GetItemId( m_nItemPos );
 239         tools::Rectangle aItemRect = m_pParent->GetBoundingRectangle( m_nItemPos );
 240         tools::Rectangle aCharRect = m_pParent->GetCharacterBounds( nItemId, nIndex );
 241         aCharRect.Move( -aItemRect.Left(), -aItemRect.Top() );
 242         aBounds = VCLUnoHelper::ConvertToAWTRect(aCharRect);
 243     }
 244
 245     return aBounds;
 246 }
 247
 248
 249 sal_Int32 VCLXAccessibleMenuItem::getCharacterCount()
 250 {
 251     OExternalLockGuard aGuard( this );
 252
 253     return m_sItemText.getLength();
 254 }
 255
 256
 257 sal_Int32 VCLXAccessibleMenuItem::getIndexAtPoint( const awt::Point& aPoint )
 258 {
 259     OExternalLockGuard aGuard( this );
 260
 261     sal_Int32 nIndex = -1;
 262     if ( m_pParent )
 263     {
 264         sal_uInt16 nItemId = 0;
 265         tools::Rectangle aItemRect = m_pParent->GetBoundingRectangle( m_nItemPos );
 266         Point aPnt(VCLUnoHelper::ConvertToVCLPoint(aPoint));
 267         aPnt += aItemRect.TopLeft();
 268         sal_Int32 nI = m_pParent->GetIndexForPoint( aPnt, nItemId );
 269         if ( nI != -1 && m_pParent->GetItemId( m_nItemPos ) == nItemId )
 270             nIndex = nI;
 271     }
 272
 273     return nIndex;
 274 }
 275
 276
 277 OUString VCLXAccessibleMenuItem::getSelectedText()
 278 {
 279     OExternalLockGuard aGuard( this );
 280
 281     return OUString();
 282 }
 283
 284
 285 sal_Int32 VCLXAccessibleMenuItem::getSelectionStart()
 286 {
 287     OExternalLockGuard aGuard( this );
 288
 289     return 0;
 290 }
 291
 292
 293 sal_Int32 VCLXAccessibleMenuItem::getSelectionEnd()
 294 {
 295     OExternalLockGuard aGuard( this );
 296
 297     return 0;
 298 }
 299
 300
 301 sal_Bool VCLXAccessibleMenuItem::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 302 {
 303     OExternalLockGuard aGuard( this );
 304
 305     if ( !implIsValidRange( nStartIndex, nEndIndex, m_sItemText.getLength() ) )
 306         throw IndexOutOfBoundsException();
 307
 308     return false;
 309 }
 310
 311
 312 OUString VCLXAccessibleMenuItem::getText()
 313 {
 314     OExternalLockGuard aGuard( this );
 315
 316     return m_sItemText;
 317 }
 318
 319
 320 OUString VCLXAccessibleMenuItem::getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 321 {
 322     OExternalLockGuard aGuard( this );
 323
 324     return OCommonAccessibleText::implGetTextRange( implGetText(), nStartIndex, nEndIndex );
 325 }
 326
 327
 328 css::accessibility::TextSegment VCLXAccessibleMenuItem::getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 329 {
 330     OExternalLockGuard aGuard( this );
 331
 332     return OCommonAccessibleText::getTextAtIndex( nIndex, aTextType );
 333 }
 334
 335
 336 css::accessibility::TextSegment VCLXAccessibleMenuItem::getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 337 {
 338     OExternalLockGuard aGuard( this );
 339
 340     return OCommonAccessibleText::getTextBeforeIndex( nIndex, aTextType );
 341 }
 342
 343
 344 css::accessibility::TextSegment VCLXAccessibleMenuItem::getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 345 {
 346     OExternalLockGuard aGuard( this );
 347
 348     return OCommonAccessibleText::getTextBehindIndex( nIndex, aTextType );
 349 }
 350
 351
 352 sal_Bool VCLXAccessibleMenuItem::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 353 {
 354     OExternalLockGuard aGuard( this );
 355
 356     bool bReturn = false;
 357
 358     if ( m_pParent )
 359     {
 360         vcl::Window* pWindow = m_pParent->GetWindow();
 361         if ( pWindow )
 362         {
 363             Reference< datatransfer::clipboard::XClipboard > xClipboard = pWindow->GetClipboard();
 364             if ( xClipboard.is() )
 365             {
 366                 OUString sText( getTextRange( nStartIndex, nEndIndex ) );
 367
 368                 rtl::Reference<vcl::unohelper::TextDataObject> pDataObj = new vcl::unohelper::TextDataObject( sText );
 369
 370                 SolarMutexReleaser aReleaser;
 371                 xClipboard->setContents( pDataObj, nullptr );
 372                 Reference< datatransfer::clipboard::XFlushableClipboard > xFlushableClipboard( xClipboard, uno::UNO_QUERY );
 373                 if( xFlushableClipboard.is() )
 374                     xFlushableClipboard->flushClipboard();
 375
 376                 bReturn = true;
 377             }
 378         }
 379     }
 380
 381     return bReturn;
 382 }
 383
 384 sal_Bool VCLXAccessibleMenuItem::scrollSubstringTo( sal_Int32, sal_Int32, AccessibleScrollType )
 385 {
 386     return false;
 387 }
 388
 389
 390 // XAccessibleAction
 391
 392
 393 sal_Int32 VCLXAccessibleMenuItem::getAccessibleActionCount( )
 394 {
 395     return 1;
 396 }
 397
 398
 399 sal_Bool VCLXAccessibleMenuItem::doAccessibleAction ( sal_Int32 nIndex )
 400 {
 401     OExternalLockGuard aGuard( this );
 402
 403     if ( nIndex != 0 )
 404         throw IndexOutOfBoundsException();
 405
 406     Click();
 407
 408     return true;
 409 }
 410
 411
 412 OUString VCLXAccessibleMenuItem::getAccessibleActionDescription ( sal_Int32 nIndex )
 413 {
 414     OExternalLockGuard aGuard( this );
 415
 416     if ( nIndex != 0 )
 417         throw IndexOutOfBoundsException();
 418
 419     return RID_STR_ACC_ACTION_SELECT;
 420 }
 421
 422
 423 Reference< XAccessibleKeyBinding > VCLXAccessibleMenuItem::getAccessibleActionKeyBinding( sal_Int32 nIndex )
 424 {
 425     OExternalLockGuard aGuard( this );
 426
 427     if ( nIndex != 0 )
 428         throw IndexOutOfBoundsException();
 429
 430     rtl::Reference<OAccessibleKeyBindingHelper> pKeyBindingHelper = new OAccessibleKeyBindingHelper();
 431
 432     if ( m_pParent )
 433     {
 434         // create auto mnemonics
 435         if (!(m_pParent->GetMenuFlags() & MenuFlags::NoAutoMnemonics))
 436             m_pParent->CreateAutoMnemonics();
 437
 438         // activation key
 439         KeyEvent aKeyEvent = m_pParent->GetActivationKey( m_pParent->GetItemId( m_nItemPos ) );
 440         vcl::KeyCode aKeyCode = aKeyEvent.GetKeyCode();
 441         Sequence< awt::KeyStroke > aSeq1
 442         {
 443             {
 444                 0, // Modifiers
 445                 static_cast< sal_Int16 >(aKeyCode.GetCode()),
 446                 aKeyEvent.GetCharCode(),
 447                 static_cast< sal_Int16 >( aKeyCode.GetFunction())
 448             }
 449         };
 450         Reference< XAccessible > xParent( getAccessibleParent() );
 451         if ( xParent.is() )
 452         {
 453             Reference< XAccessibleContext > xParentContext( xParent->getAccessibleContext() );
 454             if ( xParentContext.is() && xParentContext->getAccessibleRole() == AccessibleRole::MENU_BAR )
 455                 aSeq1.getArray()[0].Modifiers |= awt::KeyModifier::MOD2;
 456         }
 457         pKeyBindingHelper->AddKeyBinding( aSeq1 );
 458
 459         // complete menu activation key sequence
 460         Sequence< awt::KeyStroke > aSeq;
 461         if ( xParent.is() )
 462         {
 463             Reference< XAccessibleContext > xParentContext( xParent->getAccessibleContext() );
 464             if ( xParentContext.is() && xParentContext->getAccessibleRole() == AccessibleRole::MENU )
 465             {
 466                 Reference< XAccessibleAction > xAction( xParentContext, UNO_QUERY );
 467                 if ( xAction.is() && xAction->getAccessibleActionCount() > 0 )
 468                 {
 469                     Reference< XAccessibleKeyBinding > xKeyB( xAction->getAccessibleActionKeyBinding( 0 ) );
 470                     if ( xKeyB.is() && xKeyB->getAccessibleKeyBindingCount() > 1 )
 471                         aSeq = xKeyB->getAccessibleKeyBinding( 1 );
 472                 }
 473             }
 474         }
 475         Sequence< awt::KeyStroke > aSeq2 = ::comphelper::concatSequences( aSeq, aSeq1 );
 476         pKeyBindingHelper->AddKeyBinding( aSeq2 );
 477
 478         // accelerator key
 479         vcl::KeyCode aAccelKeyCode = m_pParent->GetAccelKey( m_pParent->GetItemId( m_nItemPos ) );
 480         if ( aAccelKeyCode.GetCode() != 0 )
 481         {
 482             Sequence< awt::KeyStroke > aSeq3
 483             {
 484                 {
 485                     0, // Modifiers
 486                     static_cast< sal_Int16 >(aAccelKeyCode.GetCode()),
 487                     aKeyEvent.GetCharCode(),
 488                     static_cast< sal_Int16 >(aAccelKeyCode.GetFunction())
 489                 }
 490             };
 491             if (aAccelKeyCode.GetModifier() != 0)
 492             {
 493                 auto pSeq3 = aSeq3.getArray();
 494                 if ( aAccelKeyCode.IsShift() )
 495                     pSeq3[0].Modifiers |= awt::KeyModifier::SHIFT;
 496                 if ( aAccelKeyCode.IsMod1() )
 497                     pSeq3[0].Modifiers |= awt::KeyModifier::MOD1;
 498                 if ( aAccelKeyCode.IsMod2() )
 499                     pSeq3[0].Modifiers |= awt::KeyModifier::MOD2;
 500                 if ( aAccelKeyCode.IsMod3() )
 501                     pSeq3[0].Modifiers |= awt::KeyModifier::MOD3;
 502             }
 503             pKeyBindingHelper->AddKeyBinding( aSeq3 );
 504         }
 505     }
 506
 507     return pKeyBindingHelper;
 508 }
 509
 510
 511 // XAccessibleValue
 512
 513
 514 Any VCLXAccessibleMenuItem::getCurrentValue(  )
 515 {
 516     OExternalLockGuard aGuard( this );
 517
 518     Any aValue;
 519     if ( IsSelected() )
 520         aValue <<= sal_Int32(1);
 521     else
 522         aValue <<= sal_Int32(0);
 523
 524     return aValue;
 525 }
 526
 527
 528 sal_Bool VCLXAccessibleMenuItem::setCurrentValue( const Any& aNumber )
 529 {
 530     OExternalLockGuard aGuard( this );
 531
 532     bool bReturn = false;
 533     sal_Int32 nValue = 0;
 534     OSL_VERIFY( aNumber >>= nValue );
 535
 536     if ( nValue <= 0 )
 537     {
 538         DeSelect();
 539         bReturn = true;
 540     }
 541     else if ( nValue >= 1 )
 542     {
 543         Select();
 544         bReturn = true;
 545     }
 546
 547     return bReturn;
 548 }
 549
 550
 551 Any VCLXAccessibleMenuItem::getMaximumValue(  )
 552 {
 553     Any aValue;
 554     aValue <<= sal_Int32(1);
 555
 556     return aValue;
 557 }
 558
 559
 560 Any VCLXAccessibleMenuItem::getMinimumValue(  )
 561 {
 562     Any aValue;
 563     aValue <<= sal_Int32(0);
 564
 565     return aValue;
 566 }
 567
 568 Any VCLXAccessibleMenuItem::getMinimumIncrement( )
 569 {
 570     Any aValue;
 571     aValue <<= sal_Int32(1);
 572
 573     return aValue;
 574 }
 575
 576
 577 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */