accessibility/source/standard/accessiblemenucomponent.cxx

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