accessibility/source/standard/accessiblemenucomponent.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/accessiblemenucomponent.hxx>
  21
  22 #include <toolkit/awt/vclxfont.hxx>
  23 #include <toolkit/helper/convert.hxx>
  24
  25 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  26 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  27 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  28
  29 #include <unotools/accessiblestatesethelper.hxx>
  30 #include <unotools/accessiblerelationsethelper.hxx>
  31 #include <cppuhelper/typeprovider.hxx>
  32 #include <comphelper/sequence.hxx>
  33 #include <vcl/svapp.hxx>
  34 #include <vcl/window.hxx>
  35 #include <vcl/menu.hxx>
  36 #include <vcl/unohelp2.hxx>
  37 #include <vcl/settings.hxx>
  38
  39 using namespace ::com::sun::star::accessibility;
  40 using namespace ::com::sun::star::uno;
  41 using namespace ::com::sun::star::lang;
  42 using namespace ::com::sun::star;
  43 using namespace ::comphelper;
  44
  45
  46
  47 // class OAccessibleMenuComponent
  48
  49
  50 OAccessibleMenuComponent::OAccessibleMenuComponent( Menu* pMenu )
  51     :OAccessibleMenuBaseComponent( pMenu )
  52 {
  53 }
  54
  55
  56
  57 OAccessibleMenuComponent::~OAccessibleMenuComponent()
  58 {
  59 }
  60
  61
  62
  63 bool OAccessibleMenuComponent::IsEnabled()
  64 {
  65     return true;
  66 }
  67
  68
  69
  70 bool OAccessibleMenuComponent::IsVisible()
  71 {
  72     bool bVisible = false;
  73
  74     if ( m_pMenu )
  75         bVisible = m_pMenu->IsMenuVisible();
  76
  77     return bVisible;
  78 }
  79
  80
  81
  82 void OAccessibleMenuComponent::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
  83 {
  84     if ( IsEnabled() )
  85     {
  86         rStateSet.AddState( AccessibleStateType::ENABLED );
  87         rStateSet.AddState( AccessibleStateType::SENSITIVE );
  88     }
  89
  90     rStateSet.AddState( AccessibleStateType::FOCUSABLE );
  91
  92     if ( IsFocused() )
  93         rStateSet.AddState( AccessibleStateType::FOCUSED );
  94
  95     if ( IsVisible() )
  96     {
  97         rStateSet.AddState( AccessibleStateType::VISIBLE );
  98         rStateSet.AddState( AccessibleStateType::SHOWING );
  99     }
 100
 101     rStateSet.AddState( AccessibleStateType::OPAQUE );
 102 }
 103
 104
 105 // OCommonAccessibleComponent
 106
 107
 108 awt::Rectangle OAccessibleMenuComponent::implGetBounds() throw (RuntimeException)
 109 {
 110     awt::Rectangle aBounds( 0, 0, 0, 0 );
 111
 112     if ( m_pMenu )
 113     {
 114         vcl::Window* pWindow = m_pMenu->GetWindow();
 115         if ( pWindow )
 116         {
 117             // get bounding rectangle of the window in screen coordinates
 118             Rectangle aRect = pWindow->GetWindowExtentsRelative( NULL );
 119             aBounds = AWTRectangle( aRect );
 120
 121             // get position of the accessible parent in screen coordinates
 122             Reference< XAccessible > xParent = getAccessibleParent();
 123             if ( xParent.is() )
 124             {
 125                 Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), UNO_QUERY );
 126                 if ( xParentComponent.is() )
 127                 {
 128                     awt::Point aParentScreenLoc = xParentComponent->getLocationOnScreen();
 129
 130                     // calculate position of the window relative to the accessible parent
 131                     aBounds.X -= aParentScreenLoc.X;
 132                     aBounds.Y -= aParentScreenLoc.Y;
 133                 }
 134             }
 135         }
 136     }
 137
 138     return aBounds;
 139 }
 140
 141
 142 // XInterface
 143
 144
 145 IMPLEMENT_FORWARD_XINTERFACE2( OAccessibleMenuComponent, OAccessibleMenuBaseComponent, OAccessibleMenuComponent_BASE )
 146
 147
 148 // XTypeProvider
 149
 150
 151 IMPLEMENT_FORWARD_XTYPEPROVIDER2( OAccessibleMenuComponent, OAccessibleMenuBaseComponent, OAccessibleMenuComponent_BASE )
 152
 153
 154 // XAccessibleContext
 155
 156
 157 sal_Int32 OAccessibleMenuComponent::getAccessibleChildCount() throw (RuntimeException, std::exception)
 158 {
 159     OExternalLockGuard aGuard( this );
 160
 161     return GetChildCount();
 162 }
 163
 164
 165
 166 Reference< XAccessible > OAccessibleMenuComponent::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 167 {
 168     OExternalLockGuard aGuard( this );
 169
 170     if ( i < 0 || i >= GetChildCount() )
 171         throw IndexOutOfBoundsException();
 172
 173     return GetChild( i );
 174 }
 175
 176
 177
 178 Reference< XAccessible > OAccessibleMenuComponent::getAccessibleParent(  ) throw (RuntimeException, std::exception)
 179 {
 180     OExternalLockGuard aGuard( this );
 181
 182     Reference< XAccessible > xParent;
 183
 184     if ( m_pMenu )
 185     {
 186         vcl::Window* pWindow = m_pMenu->GetWindow();
 187         if ( pWindow )
 188         {
 189             vcl::Window* pParent = pWindow->GetAccessibleParentWindow();
 190             if ( pParent )
 191                 xParent = pParent->GetAccessible();
 192         }
 193     }
 194
 195     return xParent;
 196 }
 197
 198
 199
 200 sal_Int16 OAccessibleMenuComponent::getAccessibleRole(  ) throw (RuntimeException, std::exception)
 201 {
 202     OExternalLockGuard aGuard( this );
 203
 204     return AccessibleRole::UNKNOWN;
 205 }
 206
 207
 208
 209 OUString OAccessibleMenuComponent::getAccessibleDescription( ) throw (RuntimeException, std::exception)
 210 {
 211     OExternalLockGuard aGuard( this );
 212
 213     OUString sDescription;
 214     if ( m_pMenu )
 215     {
 216         vcl::Window* pWindow = m_pMenu->GetWindow();
 217         if ( pWindow )
 218             sDescription = pWindow->GetAccessibleDescription();
 219     }
 220
 221     return sDescription;
 222 }
 223
 224
 225
 226 OUString OAccessibleMenuComponent::getAccessibleName(  ) throw (RuntimeException, std::exception)
 227 {
 228     OExternalLockGuard aGuard( this );
 229
 230     return OUString();
 231 }
 232
 233
 234
 235 Reference< XAccessibleRelationSet > OAccessibleMenuComponent::getAccessibleRelationSet(  ) throw (RuntimeException, std::exception)
 236 {
 237     OExternalLockGuard aGuard( this );
 238
 239     utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
 240     Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
 241     return xSet;
 242 }
 243
 244
 245
 246 Locale OAccessibleMenuComponent::getLocale(  ) throw (IllegalAccessibleComponentStateException, RuntimeException, std::exception)
 247 {
 248     OExternalLockGuard aGuard( this );
 249
 250     return Application::GetSettings().GetLanguageTag().getLocale();
 251 }
 252
 253
 254 // XAccessibleComponent
 255
 256
 257 Reference< XAccessible > OAccessibleMenuComponent::getAccessibleAtPoint( const awt::Point& rPoint ) throw (RuntimeException, std::exception)
 258 {
 259     OExternalLockGuard aGuard( this );
 260
 261     return GetChildAt( rPoint );
 262 }
 263
 264
 265
 266 awt::Point OAccessibleMenuComponent::getLocationOnScreen(  ) throw (RuntimeException, std::exception)
 267 {
 268     OExternalLockGuard aGuard( this );
 269
 270     awt::Point aPos;
 271
 272     if ( m_pMenu )
 273     {
 274         vcl::Window* pWindow = m_pMenu->GetWindow();
 275         if ( pWindow )
 276         {
 277             Rectangle aRect = pWindow->GetWindowExtentsRelative( NULL );
 278             aPos = AWTPoint( aRect.TopLeft() );
 279         }
 280     }
 281
 282     return aPos;
 283 }
 284
 285
 286
 287 void OAccessibleMenuComponent::grabFocus(  ) throw (RuntimeException, std::exception)
 288 {
 289     OExternalLockGuard aGuard( this );
 290
 291     if ( m_pMenu )
 292     {
 293         vcl::Window* pWindow = m_pMenu->GetWindow();
 294         if ( pWindow )
 295             pWindow->GrabFocus();
 296     }
 297 }
 298
 299
 300
 301 sal_Int32 OAccessibleMenuComponent::getForeground(  ) throw (RuntimeException, std::exception)
 302 {
 303     OExternalLockGuard aGuard( this );
 304
 305     const StyleSettings& rStyleSettings = Application::GetSettings().GetStyleSettings();
 306     sal_Int32 nColor = rStyleSettings.GetMenuTextColor().GetColor();
 307
 308     return nColor;
 309 }
 310
 311
 312
 313 sal_Int32 OAccessibleMenuComponent::getBackground(  ) throw (RuntimeException, std::exception)
 314 {
 315     OExternalLockGuard aGuard( this );
 316
 317     return 0;
 318 }
 319
 320
 321 // XAccessibleExtendedComponent
 322
 323
 324 Reference< awt::XFont > OAccessibleMenuComponent::getFont(  ) throw (RuntimeException, std::exception)
 325 {
 326     OExternalLockGuard aGuard( this );
 327
 328     Reference< awt::XFont > xFont;
 329
 330     if ( m_pMenu )
 331     {
 332         vcl::Window* pWindow = m_pMenu->GetWindow();
 333         if ( pWindow )
 334         {
 335             Reference< awt::XDevice > xDev( pWindow->GetComponentInterface(), UNO_QUERY );
 336             if ( xDev.is() )
 337             {
 338                 const StyleSettings& rStyleSettings = Application::GetSettings().GetStyleSettings();
 339                 VCLXFont* pVCLXFont = new VCLXFont;
 340                 pVCLXFont->Init( *xDev.get(), rStyleSettings.GetMenuFont() );
 341                 xFont = pVCLXFont;
 342             }
 343         }
 344     }
 345
 346     return xFont;
 347 }
 348
 349
 350
 351 OUString OAccessibleMenuComponent::getTitledBorderText(  ) throw (RuntimeException, std::exception)
 352 {
 353     OExternalLockGuard aGuard( this );
 354
 355     return OUString();
 356 }
 357
 358
 359
 360 OUString OAccessibleMenuComponent::getToolTipText(  ) throw (RuntimeException, std::exception)
 361 {
 362     OExternalLockGuard aGuard( this );
 363
 364     return OUString();
 365 }
 366
 367
 368 // XAccessibleSelection
 369
 370
 371 void OAccessibleMenuComponent::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 372 {
 373     OExternalLockGuard aGuard( this );
 374
 375     if ( nChildIndex < 0 || nChildIndex >= GetChildCount() )
 376         throw IndexOutOfBoundsException();
 377
 378     SelectChild( nChildIndex );
 379 }
 380
 381
 382
 383 sal_Bool OAccessibleMenuComponent::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 384 {
 385     OExternalLockGuard aGuard( this );
 386
 387     if ( nChildIndex < 0 || nChildIndex >= GetChildCount() )
 388         throw IndexOutOfBoundsException();
 389
 390     return IsChildSelected( nChildIndex );
 391 }
 392
 393
 394
 395 void OAccessibleMenuComponent::clearAccessibleSelection(  ) throw (RuntimeException, std::exception)
 396 {
 397     OExternalLockGuard aGuard( this );
 398
 399     DeSelectAll();
 400 }
 401
 402
 403
 404 void OAccessibleMenuComponent::selectAllAccessibleChildren(  ) throw (RuntimeException, std::exception)
 405 {
 406     // This method makes no sense in a menu, and so does nothing.
 407 }
 408
 409
 410
 411 sal_Int32 OAccessibleMenuComponent::getSelectedAccessibleChildCount(  ) throw (RuntimeException, std::exception)
 412 {
 413     OExternalLockGuard aGuard( this );
 414
 415     sal_Int32 nRet = 0;
 416
 417     for ( sal_Int32 i = 0, nCount = GetChildCount(); i < nCount; i++ )
 418     {
 419         if ( IsChildSelected( i ) )
 420             ++nRet;
 421     }
 422
 423     return nRet;
 424 }
 425
 426
 427
 428 Reference< XAccessible > OAccessibleMenuComponent::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 429 {
 430     OExternalLockGuard aGuard( this );
 431
 432     if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
 433         throw IndexOutOfBoundsException();
 434
 435     Reference< XAccessible > xChild;
 436
 437     for ( sal_Int32 i = 0, j = 0, nCount = GetChildCount(); i < nCount; i++ )
 438     {
 439         if ( IsChildSelected( i ) && ( j++ == nSelectedChildIndex ) )
 440         {
 441             xChild = GetChild( i );
 442             break;
 443         }
 444     }
 445
 446     return xChild;
 447 }
 448
 449
 450
 451 void OAccessibleMenuComponent::deselectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 452 {
 453     OExternalLockGuard aGuard( this );
 454
 455     if ( nChildIndex < 0 || nChildIndex >= GetChildCount() )
 456         throw IndexOutOfBoundsException();
 457
 458     DeSelectAll();
 459 }
 460
 461
 462
 463 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */