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