accessibility/source/standard/accessiblemenuitemcomponent.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/accessiblemenuitemcomponent.hxx>
  21
  22
  23 #include <accessibility/helper/accresmgr.hxx>
  24 #include <accessibility/helper/accessiblestrings.hrc>
  25 #include <toolkit/awt/vclxwindows.hxx>
  26 #include <toolkit/helper/externallock.hxx>
  27 #include <toolkit/helper/convert.hxx>
  28
  29 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  30 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  31 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  32 #include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
  33 #include <com/sun/star/datatransfer/clipboard/XFlushableClipboard.hpp>
  34
  35 #include <unotools/accessiblestatesethelper.hxx>
  36 #include <unotools/accessiblerelationsethelper.hxx>
  37 #include <cppuhelper/typeprovider.hxx>
  38 #include <comphelper/sequence.hxx>
  39 #include <comphelper/accessibletexthelper.hxx>
  40 #include <vcl/svapp.hxx>
  41 #include <vcl/window.hxx>
  42 #include <vcl/menu.hxx>
  43 #include <vcl/unohelp2.hxx>
  44 #include <vcl/settings.hxx>
  45
  46 using namespace ::com::sun::star::accessibility;
  47 using namespace ::com::sun::star::uno;
  48 using namespace ::com::sun::star::beans;
  49 using namespace ::com::sun::star::lang;
  50 using namespace ::com::sun::star;
  51 using namespace ::comphelper;
  52
  53
  54
  55 // class OAccessibleMenuItemComponent
  56
  57
  58 OAccessibleMenuItemComponent::OAccessibleMenuItemComponent( Menu* pParent, sal_uInt16 nItemPos, Menu* pMenu )
  59     :OAccessibleMenuBaseComponent( pMenu )
  60     ,m_pParent( pParent )
  61     ,m_nItemPos( nItemPos )
  62 {
  63     m_sAccessibleName = GetAccessibleName();
  64     m_sItemText = GetItemText();
  65 }
  66
  67
  68
  69 OAccessibleMenuItemComponent::~OAccessibleMenuItemComponent()
  70 {
  71 }
  72
  73
  74
  75 bool OAccessibleMenuItemComponent::IsEnabled()
  76 {
  77     OExternalLockGuard aGuard( this );
  78
  79     bool bEnabled = false;
  80     if ( m_pParent )
  81         bEnabled = m_pParent->IsItemEnabled( m_pParent->GetItemId( m_nItemPos ) );
  82
  83     return bEnabled;
  84 }
  85
  86
  87
  88 bool OAccessibleMenuItemComponent::IsVisible()
  89 {
  90     bool bVisible = false;
  91
  92     if ( m_pParent )
  93         bVisible = m_pParent->IsItemPosVisible( m_nItemPos );
  94
  95     return bVisible;
  96 }
  97
  98
  99
 100 void OAccessibleMenuItemComponent::Select()
 101 {
 102     // open the parent menu
 103     Reference< XAccessible > xParent( getAccessibleParent() );
 104     if ( xParent.is() )
 105     {
 106         OAccessibleMenuBaseComponent* pComp = static_cast< OAccessibleMenuBaseComponent* >( xParent.get() );
 107         if ( pComp && pComp->getAccessibleRole() == AccessibleRole::MENU && !pComp->IsPopupMenuOpen() )
 108             pComp->Click();
 109     }
 110
 111     // highlight the menu item
 112     if ( m_pParent )
 113         m_pParent->HighlightItem( m_nItemPos );
 114 }
 115
 116
 117
 118 void OAccessibleMenuItemComponent::DeSelect()
 119 {
 120     if ( m_pParent && IsSelected() )
 121         m_pParent->DeHighlight();
 122 }
 123
 124
 125
 126 void OAccessibleMenuItemComponent::Click()
 127 {
 128     // open the parent menu
 129     Reference< XAccessible > xParent( getAccessibleParent() );
 130     if ( xParent.is() )
 131     {
 132         OAccessibleMenuBaseComponent* pComp = static_cast< OAccessibleMenuBaseComponent* >( xParent.get() );
 133         if ( pComp && pComp->getAccessibleRole() == AccessibleRole::MENU && !pComp->IsPopupMenuOpen() )
 134             pComp->Click();
 135     }
 136
 137     // click the menu item
 138     if ( m_pParent )
 139     {
 140         vcl::Window* pWindow = m_pParent->GetWindow();
 141         if ( pWindow )
 142         {
 143             // #102438# Menu items are not selectable
 144             // Popup menus are executed asynchronously, triggered by a timer.
 145             // As Menu::SelectItem only works, if the corresponding menu window is
 146             // already created, we have to set the menu delay to 0, so
 147             // that the popup menus are executed synchronously.
 148             AllSettings aSettings = pWindow->GetSettings();
 149             MouseSettings aMouseSettings = aSettings.GetMouseSettings();
 150             sal_uLong nDelay = aMouseSettings.GetMenuDelay();
 151             aMouseSettings.SetMenuDelay( 0 );
 152             aSettings.SetMouseSettings( aMouseSettings );
 153             pWindow->SetSettings( aSettings );
 154
 155             m_pParent->SelectItem( m_pParent->GetItemId( m_nItemPos ) );
 156
 157             // meanwhile the window pointer may be invalid
 158             pWindow = m_pParent->GetWindow();
 159             if ( pWindow )
 160             {
 161                 // set the menu delay back to the old value
 162                 aSettings = pWindow->GetSettings();
 163                 aMouseSettings = aSettings.GetMouseSettings();
 164                 aMouseSettings.SetMenuDelay( nDelay );
 165                 aSettings.SetMouseSettings( aMouseSettings );
 166                 pWindow->SetSettings( aSettings );
 167             }
 168         }
 169     }
 170 }
 171
 172
 173
 174 void OAccessibleMenuItemComponent::SetItemPos( sal_uInt16 nItemPos )
 175 {
 176     m_nItemPos = nItemPos;
 177 }
 178
 179
 180
 181 void OAccessibleMenuItemComponent::SetAccessibleName( const OUString& sAccessibleName )
 182 {
 183     if ( !m_sAccessibleName.equals( sAccessibleName ) )
 184     {
 185         Any aOldValue, aNewValue;
 186         aOldValue <<= m_sAccessibleName;
 187         aNewValue <<= sAccessibleName;
 188         m_sAccessibleName = sAccessibleName;
 189         NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
 190     }
 191 }
 192
 193
 194
 195 OUString OAccessibleMenuItemComponent::GetAccessibleName()
 196 {
 197     OUString sName;
 198     if ( m_pParent )
 199     {
 200         sal_uInt16 nItemId = m_pParent->GetItemId( m_nItemPos );
 201         sName = m_pParent->GetAccessibleName( nItemId );
 202         if ( sName.isEmpty() )
 203             sName = m_pParent->GetItemText( nItemId );
 204         sName = OutputDevice::GetNonMnemonicString( sName );
 205 #if defined WNT
 206         if ( m_pParent->GetAccelKey( nItemId ).GetName().getLength() )
 207             sName = sName + "\t" + m_pParent->GetAccelKey(nItemId).GetName();
 208 #endif
 209     }
 210
 211     return sName;
 212 }
 213
 214
 215
 216 void OAccessibleMenuItemComponent::SetItemText( const OUString& sItemText )
 217 {
 218     Any aOldValue, aNewValue;
 219     if ( OCommonAccessibleText::implInitTextChangedEvent( m_sItemText, sItemText, aOldValue, aNewValue ) )
 220     {
 221         m_sItemText = sItemText;
 222         NotifyAccessibleEvent( AccessibleEventId::TEXT_CHANGED, aOldValue, aNewValue );
 223     }
 224 }
 225
 226
 227
 228 OUString OAccessibleMenuItemComponent::GetItemText()
 229 {
 230     OUString sText;
 231     if ( m_pParent )
 232         sText = OutputDevice::GetNonMnemonicString( m_pParent->GetItemText( m_pParent->GetItemId( m_nItemPos ) ) );
 233
 234     return sText;
 235 }
 236
 237
 238
 239 void OAccessibleMenuItemComponent::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 240 {
 241     bool bEnabled = IsEnabled();
 242     if ( bEnabled )
 243     {
 244         rStateSet.AddState( AccessibleStateType::ENABLED );
 245         rStateSet.AddState( AccessibleStateType::SENSITIVE );
 246     }
 247
 248     if ( IsVisible() )
 249     {
 250         rStateSet.AddState( AccessibleStateType::SHOWING );
 251         if( !IsMenuHideDisabledEntries() || bEnabled )
 252             rStateSet.AddState( AccessibleStateType::VISIBLE );
 253     }
 254     rStateSet.AddState( AccessibleStateType::OPAQUE );
 255 }
 256
 257
 258 // OCommonAccessibleComponent
 259
 260
 261 awt::Rectangle OAccessibleMenuItemComponent::implGetBounds() throw (RuntimeException)
 262 {
 263     awt::Rectangle aBounds( 0, 0, 0, 0 );
 264
 265     if ( m_pParent )
 266     {
 267         // get bounding rectangle of the item relative to the containing window
 268         aBounds = AWTRectangle( m_pParent->GetBoundingRectangle( m_nItemPos ) );
 269
 270         // get position of containing window in screen coordinates
 271         vcl::Window* pWindow = m_pParent->GetWindow();
 272         if ( pWindow )
 273         {
 274             Rectangle aRect = pWindow->GetWindowExtentsRelative( NULL );
 275             awt::Point aWindowScreenLoc = AWTPoint( aRect.TopLeft() );
 276
 277             // get position of accessible parent in screen coordinates
 278             Reference< XAccessible > xParent = getAccessibleParent();
 279             if ( xParent.is() )
 280             {
 281                 Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), UNO_QUERY );
 282                 if ( xParentComponent.is() )
 283                 {
 284                     awt::Point aParentScreenLoc = xParentComponent->getLocationOnScreen();
 285
 286                     // calculate bounding rectangle of the item relative to the accessible parent
 287                     aBounds.X += aWindowScreenLoc.X - aParentScreenLoc.X;
 288                     aBounds.Y += aWindowScreenLoc.Y - aParentScreenLoc.Y;
 289                 }
 290             }
 291         }
 292     }
 293
 294     return aBounds;
 295 }
 296
 297
 298 // XComponent
 299
 300
 301 void SAL_CALL OAccessibleMenuItemComponent::disposing()
 302 {
 303     OAccessibleMenuBaseComponent::disposing();
 304
 305     m_pParent = NULL;
 306     m_sAccessibleName.clear();
 307     m_sItemText.clear();
 308 }
 309
 310
 311 // XAccessibleContext
 312
 313
 314 sal_Int32 OAccessibleMenuItemComponent::getAccessibleChildCount() throw (RuntimeException, std::exception)
 315 {
 316     OExternalLockGuard aGuard( this );
 317
 318     return 0;
 319 }
 320
 321
 322
 323 Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 324 {
 325     OExternalLockGuard aGuard( this );
 326
 327     if ( i < 0 || i >= getAccessibleChildCount() )
 328         throw IndexOutOfBoundsException();
 329
 330     return Reference< XAccessible >();
 331 }
 332
 333
 334
 335 Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleParent(  ) throw (RuntimeException, std::exception)
 336 {
 337     OExternalLockGuard aGuard( this );
 338
 339     return m_pParent->GetAccessible();
 340 }
 341
 342
 343
 344 sal_Int32 OAccessibleMenuItemComponent::getAccessibleIndexInParent(  ) throw (RuntimeException, std::exception)
 345 {
 346     OExternalLockGuard aGuard( this );
 347
 348     return m_nItemPos;
 349 }
 350
 351
 352
 353 sal_Int16 OAccessibleMenuItemComponent::getAccessibleRole(  ) throw (RuntimeException, std::exception)
 354 {
 355     OExternalLockGuard aGuard( this );
 356
 357     return AccessibleRole::UNKNOWN;
 358 }
 359
 360
 361
 362 OUString OAccessibleMenuItemComponent::getAccessibleDescription( ) throw (RuntimeException, std::exception)
 363 {
 364     OExternalLockGuard aGuard( this );
 365
 366     OUString sDescription;
 367     if ( m_pParent )
 368         sDescription = m_pParent->GetHelpText( m_pParent->GetItemId( m_nItemPos ) );
 369
 370     return sDescription;
 371 }
 372
 373
 374
 375 OUString OAccessibleMenuItemComponent::getAccessibleName(  ) throw (RuntimeException, std::exception)
 376 {
 377     OExternalLockGuard aGuard( this );
 378
 379     return m_sAccessibleName;
 380 }
 381
 382
 383
 384 Reference< XAccessibleRelationSet > OAccessibleMenuItemComponent::getAccessibleRelationSet(  ) throw (RuntimeException, std::exception)
 385 {
 386     OExternalLockGuard aGuard( this );
 387
 388     utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
 389     Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
 390     return xSet;
 391 }
 392
 393
 394
 395 Locale OAccessibleMenuItemComponent::getLocale(  ) throw (IllegalAccessibleComponentStateException, RuntimeException, std::exception)
 396 {
 397     OExternalLockGuard aGuard( this );
 398
 399     return Application::GetSettings().GetLanguageTag().getLocale();
 400 }
 401
 402
 403 // XAccessibleComponent
 404
 405
 406 Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleAtPoint( const awt::Point& ) throw (RuntimeException, std::exception)
 407 {
 408     OExternalLockGuard aGuard( this );
 409
 410     return Reference< XAccessible >();
 411 }
 412
 413
 414
 415 void OAccessibleMenuItemComponent::grabFocus(  ) throw (RuntimeException, std::exception)
 416 {
 417     // no focus for items
 418 }
 419
 420
 421
 422 sal_Int32 OAccessibleMenuItemComponent::getForeground(  ) throw (RuntimeException, std::exception)
 423 {
 424     OExternalLockGuard aGuard( this );
 425
 426     sal_Int32 nColor = 0;
 427     Reference< XAccessible > xParent = getAccessibleParent();
 428     if ( xParent.is() )
 429     {
 430         Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 431         if ( xParentComp.is() )
 432             nColor = xParentComp->getForeground();
 433     }
 434
 435     return nColor;
 436 }
 437
 438
 439
 440 sal_Int32 OAccessibleMenuItemComponent::getBackground(  ) throw (RuntimeException, std::exception)
 441 {
 442     OExternalLockGuard aGuard( this );
 443
 444     sal_Int32 nColor = 0;
 445     Reference< XAccessible > xParent = getAccessibleParent();
 446     if ( xParent.is() )
 447     {
 448         Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 449         if ( xParentComp.is() )
 450             nColor = xParentComp->getBackground();
 451     }
 452
 453     return nColor;
 454 }
 455
 456
 457 // XAccessibleExtendedComponent
 458
 459
 460 Reference< awt::XFont > OAccessibleMenuItemComponent::getFont(  ) throw (RuntimeException, std::exception)
 461 {
 462     OExternalLockGuard aGuard( this );
 463
 464     Reference< awt::XFont > xFont;
 465     Reference< XAccessible > xParent = getAccessibleParent();
 466     if ( xParent.is() )
 467     {
 468         Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 469         if ( xParentComp.is() )
 470             xFont = xParentComp->getFont();
 471     }
 472
 473     return xFont;
 474 }
 475
 476
 477
 478 OUString OAccessibleMenuItemComponent::getTitledBorderText(  ) throw (RuntimeException, std::exception)
 479 {
 480     OExternalLockGuard aGuard( this );
 481
 482     return OUString();
 483 }
 484
 485
 486
 487 OUString OAccessibleMenuItemComponent::getToolTipText(  ) throw (RuntimeException, std::exception)
 488 {
 489     OExternalLockGuard aGuard( this );
 490
 491     OUString sRet;
 492     if ( m_pParent )
 493         sRet = m_pParent->GetTipHelpText( m_pParent->GetItemId( m_nItemPos ) );
 494
 495     return sRet;
 496 }
 497
 498
 499
 500 bool OAccessibleMenuItemComponent::IsMenuHideDisabledEntries()
 501 {
 502     if (m_pParent )
 503     {
 504         if( m_pParent->GetMenuFlags() & MenuFlags::HideDisabledEntries)
 505         {
 506             return true;
 507         }
 508     }
 509     return false;
 510 }
 511
 512 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */