accessibility/source/helper/acc_factory.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 <config_feature_desktop.h>
  21
  22 #include <toolkit/awt/vclxwindows.hxx>
  23 #include <toolkit/helper/accessiblefactory.hxx>
  24 #include <vcl/accessiblefactory.hxx>
  25 #include <standard/svtaccessiblenumericfield.hxx>
  26 #include <standard/vclxaccessiblebutton.hxx>
  27 #include <standard/vclxaccessiblecheckbox.hxx>
  28 #include <standard/vclxaccessibledropdowncombobox.hxx>
  29 #include <standard/vclxaccessiblecombobox.hxx>
  30 #include <standard/vclxaccessibledropdownlistbox.hxx>
  31 #include <standard/vclxaccessibleedit.hxx>
  32 #include <standard/vclxaccessiblefixedhyperlink.hxx>
  33 #include <standard/vclxaccessiblefixedtext.hxx>
  34 #include <standard/vclxaccessibleheaderbar.hxx>
  35 #include <standard/vclxaccessiblelistbox.hxx>
  36 #include <standard/vclxaccessibleradiobutton.hxx>
  37 #include <standard/vclxaccessiblescrollbar.hxx>
  38 #include <standard/vclxaccessibletoolbox.hxx>
  39 #include <toolkit/awt/vclxaccessiblecomponent.hxx>
  40 #include <standard/vclxaccessiblestatusbar.hxx>
  41 #include <standard/vclxaccessibletabcontrol.hxx>
  42 #include <standard/vclxaccessibletabpagewindow.hxx>
  43 #include <standard/vclxaccessiblemenubar.hxx>
  44 #include <standard/vclxaccessiblepopupmenu.hxx>
  45 #include <extended/accessibletablistbox.hxx>
  46 #include <extended/AccessibleBrowseBox.hxx>
  47 #include <extended/accessibleiconchoicectrl.hxx>
  48 #include <extended/AccessibleIconView.hxx>
  49 #include <extended/accessibletabbar.hxx>
  50 #include <extended/accessiblelistbox.hxx>
  51 #include <extended/AccessibleBrowseBoxHeaderBar.hxx>
  52 #include <extended/textwindowaccessibility.hxx>
  53 #include <extended/AccessibleBrowseBoxTableCell.hxx>
  54 #include <extended/AccessibleBrowseBoxHeaderCell.hxx>
  55 #include <extended/AccessibleBrowseBoxCheckBoxCell.hxx>
  56 #include <extended/accessibleeditbrowseboxcell.hxx>
  57 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  58 #include <vcl/toolkit/lstbox.hxx>
  59 #include <vcl/toolkit/combobox.hxx>
  60 #include <extended/AccessibleGridControl.hxx>
  61 #include <vcl/accessibletable.hxx>
  62
  63 #include <floatingwindowaccessible.hxx>
  64
  65 using namespace ::accessibility;
  66 using namespace ::com::sun::star::uno;
  67 using namespace ::com::sun::star::awt;
  68 using namespace ::com::sun::star::accessibility;
  69 using namespace ::vcl;
  70 using namespace ::vcl::table;
  71
  72 namespace {
  73
  74 bool hasFloatingChild(vcl::Window *pWindow)
  75 {
  76     vcl::Window * pChild = pWindow->GetAccessibleChildWindow(0);
  77     return pChild && pChild->GetType() == WindowType::FLOATINGWINDOW;
  78 }
  79
  80 // IAccessibleFactory
  81 class AccessibleFactory :public ::toolkit::IAccessibleFactory
  82                         ,public ::vcl::IAccessibleFactory
  83 {
  84 public:
  85     AccessibleFactory();
  86
  87     // ::toolkit::IAccessibleFactory
  88     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  89         createAccessibleContext( VCLXButton* _pXWindow ) override;
  90     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  91         createAccessibleContext( VCLXCheckBox* _pXWindow ) override;
  92     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  93         createAccessibleContext( VCLXRadioButton* _pXWindow ) override;
  94     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  95         createAccessibleContext( VCLXListBox* _pXWindow ) override;
  96     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  97         createAccessibleContext( VCLXFixedText* _pXWindow ) override;
  98     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  99         createAccessibleContext( VCLXFixedHyperlink* _pXWindow ) override;
 100     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 101         createAccessibleContext( VCLXScrollBar* _pXWindow ) override;
 102     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 103         createAccessibleContext( VCLXEdit* _pXWindow ) override;
 104     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 105         createAccessibleContext( VCLXComboBox* _pXWindow ) override;
 106     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 107         createAccessibleContext( VCLXToolBox* _pXWindow ) override;
 108     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 109         createAccessibleContext( VCLXHeaderBar* _pXWindow ) override;
 110     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 111         createAccessibleContext( SVTXNumericField* _pXWindow ) override;
 112     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 113         createAccessibleContext( VCLXWindow* _pXWindow ) override;
 114     virtual css::uno::Reference< css::accessibility::XAccessible >
 115         createAccessible( Menu* _pMenu, bool _bIsMenuBar ) override;
 116
 117     // ::vcl::IAccessibleFactory
 118     virtual vcl::IAccessibleTabListBox*
 119         createAccessibleTabListBox(
 120             const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
 121             SvHeaderTabListBox& rBox
 122         ) const override;
 123
 124     virtual vcl::IAccessibleBrowseBox*
 125         createAccessibleBrowseBox(
 126             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 127             vcl::IAccessibleTableProvider& _rBrowseBox
 128         ) const override;
 129
 130     virtual IAccessibleTableControl*
 131         createAccessibleTableControl(
 132             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 133             IAccessibleTable& _rTable
 134         ) const override;
 135
 136     virtual css::uno::Reference< css::accessibility::XAccessible >
 137         createAccessibleIconChoiceCtrl(
 138             SvtIconChoiceCtrl& _rIconCtrl,
 139             const css::uno::Reference< css::accessibility::XAccessible >& _xParent
 140         ) const override;
 141
 142     virtual css::uno::Reference< css::accessibility::XAccessible >
 143         createAccessibleTabBar(
 144             TabBar& _rTabBar
 145         ) const override;
 146
 147     virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 148         createAccessibleTextWindowContext(
 149             VCLXWindow* pVclXWindow, TextEngine& rEngine, TextView& rView
 150         ) const override;
 151
 152     virtual css::uno::Reference< css::accessibility::XAccessible >
 153         createAccessibleTreeListBox(
 154             SvTreeListBox& _rListBox,
 155             const css::uno::Reference< css::accessibility::XAccessible >& _xParent
 156         ) const override;
 157
 158     virtual css::uno::Reference< css::accessibility::XAccessible >
 159         createAccessibleIconView(
 160             SvTreeListBox& _rListBox,
 161             const css::uno::Reference< css::accessibility::XAccessible >& _xParent
 162         ) const override;
 163
 164     virtual css::uno::Reference< css::accessibility::XAccessible >
 165         createAccessibleBrowseBoxHeaderBar(
 166             const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
 167             vcl::IAccessibleTableProvider& _rOwningTable,
 168             AccessibleBrowseBoxObjType _eObjType
 169         ) const override;
 170
 171     virtual css::uno::Reference< css::accessibility::XAccessible >
 172         createAccessibleBrowseBoxTableCell(
 173             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 174             vcl::IAccessibleTableProvider& _rBrowseBox,
 175             const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
 176             sal_Int32 _nRowId,
 177             sal_uInt16 _nColId,
 178             sal_Int32 _nOffset
 179         ) const override;
 180
 181     virtual css::uno::Reference< css::accessibility::XAccessible >
 182         createAccessibleBrowseBoxHeaderCell(
 183             sal_Int32 _nColumnRowId,
 184             const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
 185             vcl::IAccessibleTableProvider& _rBrowseBox,
 186             const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
 187             AccessibleBrowseBoxObjType  _eObjType
 188         ) const override;
 189
 190     virtual css::uno::Reference< css::accessibility::XAccessible >
 191         createAccessibleCheckBoxCell(
 192             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 193             vcl::IAccessibleTableProvider& _rBrowseBox,
 194             const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
 195             sal_Int32 _nRowPos,
 196             sal_uInt16 _nColPos,
 197             const TriState& _eState,
 198             bool _bIsTriState
 199         ) const override;
 200
 201     virtual css::uno::Reference< css::accessibility::XAccessible >
 202         createEditBrowseBoxTableCellAccess(
 203             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 204             const css::uno::Reference< css::accessibility::XAccessible >& _rxControlAccessible,
 205             const css::uno::Reference< css::awt::XWindow >& _rxFocusWindow,
 206             vcl::IAccessibleTableProvider& _rBrowseBox,
 207             sal_Int32 _nRowPos,
 208             sal_uInt16 _nColPos
 209         ) const override;
 210
 211 protected:
 212     virtual ~AccessibleFactory() override;
 213 };
 214
 215 AccessibleFactory::AccessibleFactory()
 216 {
 217 }
 218
 219 AccessibleFactory::~AccessibleFactory()
 220 {
 221 }
 222
 223 Reference< XAccessible > AccessibleFactory::createAccessible( Menu* _pMenu, bool _bIsMenuBar )
 224 {
 225     rtl::Reference<OAccessibleMenuBaseComponent> pAccessible;
 226     if ( _bIsMenuBar )
 227         pAccessible = new VCLXAccessibleMenuBar( _pMenu );
 228     else
 229         pAccessible = new VCLXAccessiblePopupMenu( _pMenu );
 230     pAccessible->SetStates();
 231     return pAccessible;
 232 }
 233
 234 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXButton* _pXWindow )
 235 {
 236     return new VCLXAccessibleButton( _pXWindow );
 237 }
 238
 239 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXCheckBox* _pXWindow )
 240 {
 241     return new VCLXAccessibleCheckBox( _pXWindow );
 242 }
 243
 244 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXRadioButton* _pXWindow )
 245 {
 246     return new VCLXAccessibleRadioButton( _pXWindow );
 247 }
 248
 249 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXListBox* _pXWindow )
 250 {
 251     bool bIsDropDownBox = false;
 252     VclPtr< ListBox > pBox = _pXWindow->GetAs< ListBox >();
 253     if ( pBox )
 254         bIsDropDownBox = ( ( pBox->GetStyle() & WB_DROPDOWN ) == WB_DROPDOWN );
 255
 256     if ( bIsDropDownBox )
 257         return new VCLXAccessibleDropDownListBox( _pXWindow );
 258     else
 259         return new VCLXAccessibleListBox( _pXWindow );
 260 }
 261
 262 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXFixedText* _pXWindow )
 263 {
 264     return new VCLXAccessibleFixedText( _pXWindow );
 265 }
 266
 267 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXFixedHyperlink* _pXWindow )
 268 {
 269     return new VCLXAccessibleFixedHyperlink( _pXWindow );
 270 }
 271
 272 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXScrollBar* _pXWindow )
 273 {
 274     return new VCLXAccessibleScrollBar( _pXWindow );
 275 }
 276
 277 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXEdit* _pXWindow )
 278 {
 279     return new VCLXAccessibleEdit( _pXWindow );
 280 }
 281
 282 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXComboBox* _pXWindow )
 283 {
 284     bool bIsDropDownBox = false;
 285     VclPtr< ComboBox > pBox = _pXWindow->GetAs< ComboBox >();
 286     if ( pBox )
 287         bIsDropDownBox = ( ( pBox->GetStyle() & WB_DROPDOWN ) == WB_DROPDOWN );
 288
 289     if ( bIsDropDownBox )
 290         return new VCLXAccessibleDropDownComboBox( _pXWindow );
 291     else
 292         return new VCLXAccessibleComboBox( _pXWindow );
 293 }
 294
 295 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXWindow* _pXWindow )
 296 {
 297     Reference< XAccessibleContext > xContext;
 298
 299     VclPtr<vcl::Window> pWindow = _pXWindow->GetWindow();
 300     if ( pWindow )
 301     {
 302         WindowType nType = pWindow->GetType();
 303
 304         if ( nType == WindowType::MENUBARWINDOW || pWindow->IsMenuFloatingWindow() || pWindow->IsToolbarFloatingWindow() )
 305         {
 306             Reference< XAccessible > xAcc( pWindow->GetAccessible() );
 307             if ( xAcc.is() )
 308             {
 309                 Reference< XAccessibleContext > xCont( xAcc->getAccessibleContext() );
 310                 if ( pWindow->GetType() == WindowType::MENUBARWINDOW ||
 311                     ( xCont.is() && xCont->getAccessibleRole() == AccessibleRole::POPUP_MENU ) )
 312                 {
 313                     xContext = xCont;
 314                 }
 315             }
 316         }
 317
 318         else if ( nType == WindowType::STATUSBAR )
 319         {
 320             xContext = new VCLXAccessibleStatusBar(_pXWindow);
 321         }
 322
 323         else if ( nType == WindowType::TABCONTROL )
 324         {
 325             xContext = new VCLXAccessibleTabControl(_pXWindow);
 326         }
 327
 328         else if ( nType == WindowType::TABPAGE && pWindow->GetAccessibleParentWindow() && pWindow->GetAccessibleParentWindow()->GetType() == WindowType::TABCONTROL )
 329         {
 330             xContext = new VCLXAccessibleTabPageWindow( _pXWindow );
 331         }
 332
 333         else if ( nType == WindowType::FLOATINGWINDOW )
 334         {
 335             xContext = new FloatingWindowAccessible( _pXWindow );
 336         }
 337
 338         else if ( nType == WindowType::BORDERWINDOW && hasFloatingChild( pWindow ) )
 339         {
 340             xContext = new FloatingWindowAccessible( _pXWindow );
 341         }
 342
 343         else if ( ( nType == WindowType::HELPTEXTWINDOW ) || ( nType == WindowType::FIXEDLINE ) )
 344         {
 345             xContext = new VCLXAccessibleFixedText(_pXWindow);
 346         }
 347         else
 348         {
 349             xContext = new VCLXAccessibleComponent(_pXWindow);
 350         }
 351     }
 352     return xContext;
 353 }
 354
 355 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXToolBox* _pXWindow )
 356 {
 357     return new VCLXAccessibleToolBox( _pXWindow );
 358 }
 359
 360 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( VCLXHeaderBar* _pXWindow )
 361 {
 362     return new VCLXAccessibleHeaderBar(_pXWindow);
 363 }
 364
 365 Reference< XAccessibleContext > AccessibleFactory::createAccessibleContext( SVTXNumericField* _pXWindow )
 366 {
 367     return new SVTXAccessibleNumericField( _pXWindow );
 368 }
 369
 370 vcl::IAccessibleTabListBox* AccessibleFactory::createAccessibleTabListBox(
 371     const Reference< XAccessible >& rxParent, SvHeaderTabListBox& rBox ) const
 372 {
 373     return new AccessibleTabListBox( rxParent, rBox );
 374 }
 375
 376 vcl::IAccessibleBrowseBox* AccessibleFactory::createAccessibleBrowseBox(
 377     const Reference< XAccessible >& _rxParent, vcl::IAccessibleTableProvider& _rBrowseBox ) const
 378 {
 379     return new AccessibleBrowseBoxAccess( _rxParent, _rBrowseBox );
 380 }
 381
 382 IAccessibleTableControl* AccessibleFactory::createAccessibleTableControl(
 383     const Reference< XAccessible >& _rxParent, IAccessibleTable& _rTable ) const
 384 {
 385     return new AccessibleGridControlAccess( _rxParent, _rTable );
 386 }
 387
 388 Reference< XAccessible > AccessibleFactory::createAccessibleIconChoiceCtrl(
 389     SvtIconChoiceCtrl& _rIconCtrl, const Reference< XAccessible >& _xParent ) const
 390 {
 391     return new AccessibleIconChoiceCtrl( _rIconCtrl, _xParent );
 392 }
 393
 394 Reference< XAccessible > AccessibleFactory::createAccessibleTabBar( TabBar& _rTabBar ) const
 395 {
 396     return new AccessibleTabBar( &_rTabBar );
 397 }
 398
 399 Reference< XAccessibleContext > AccessibleFactory::createAccessibleTextWindowContext(
 400     VCLXWindow* pVclXWindow, TextEngine& rEngine, TextView& rView ) const
 401 {
 402     return new Document( pVclXWindow, rEngine, rView );
 403 }
 404
 405 Reference< XAccessible > AccessibleFactory::createAccessibleTreeListBox(
 406     SvTreeListBox& _rListBox, const Reference< XAccessible >& _xParent ) const
 407 {
 408     return new AccessibleListBox( _rListBox, _xParent );
 409 }
 410
 411 Reference< XAccessible > AccessibleFactory::createAccessibleIconView(
 412     SvTreeListBox& _rListBox, const Reference< XAccessible >& _xParent ) const
 413 {
 414     return new AccessibleIconView( _rListBox, _xParent );
 415 }
 416
 417 Reference< XAccessible > AccessibleFactory::createAccessibleBrowseBoxHeaderBar(
 418     const Reference< XAccessible >& rxParent, vcl::IAccessibleTableProvider& _rOwningTable,
 419     AccessibleBrowseBoxObjType _eObjType ) const
 420 {
 421     return new AccessibleBrowseBoxHeaderBar( rxParent, _rOwningTable, _eObjType );
 422 }
 423
 424 Reference< XAccessible > AccessibleFactory::createAccessibleBrowseBoxTableCell(
 425     const Reference< XAccessible >& _rxParent, vcl::IAccessibleTableProvider& _rBrowseBox,
 426     const Reference< XWindow >& _xFocusWindow, sal_Int32 _nRowId, sal_uInt16 _nColId, sal_Int32 _nOffset ) const
 427 {
 428     return new AccessibleBrowseBoxTableCell( _rxParent, _rBrowseBox, _xFocusWindow,
 429         _nRowId, _nColId, _nOffset );
 430 }
 431
 432 Reference< XAccessible > AccessibleFactory::createAccessibleBrowseBoxHeaderCell(
 433     sal_Int32 _nColumnRowId, const Reference< XAccessible >& rxParent, vcl::IAccessibleTableProvider& _rBrowseBox,
 434     const Reference< XWindow >& _xFocusWindow, AccessibleBrowseBoxObjType  _eObjType ) const
 435 {
 436     return new AccessibleBrowseBoxHeaderCell( _nColumnRowId, rxParent, _rBrowseBox,
 437         _xFocusWindow, _eObjType );
 438 }
 439
 440 Reference< XAccessible > AccessibleFactory::createAccessibleCheckBoxCell(
 441     const Reference< XAccessible >& _rxParent, vcl::IAccessibleTableProvider& _rBrowseBox,
 442     const Reference< XWindow >& _xFocusWindow, sal_Int32 _nRowPos, sal_uInt16 _nColPos,
 443     const TriState& _eState, bool _bIsTriState ) const
 444 {
 445     return new AccessibleCheckBoxCell( _rxParent, _rBrowseBox, _xFocusWindow,
 446         _nRowPos, _nColPos, _eState, _bIsTriState );
 447 }
 448
 449 Reference< XAccessible > AccessibleFactory::createEditBrowseBoxTableCellAccess(
 450     const Reference< XAccessible >& _rxParent, const Reference< XAccessible >& _rxControlAccessible,
 451     const Reference< XWindow >& _rxFocusWindow, vcl::IAccessibleTableProvider& _rBrowseBox,
 452     sal_Int32 _nRowPos, sal_uInt16 _nColPos ) const
 453 {
 454     return new EditBrowseBoxTableCellAccess( _rxParent, _rxControlAccessible,
 455         _rxFocusWindow, _rBrowseBox, _nRowPos, _nColPos );
 456 }
 457
 458 } // anonymous namespace
 459
 460 #if HAVE_FEATURE_DESKTOP
 461 /* this is the entry point to retrieve a factory for the toolkit-level Accessible/Contexts supplied
 462     by this library
 463
 464     This function implements the factory function needed in toolkit
 465     (of type GetStandardAccComponentFactory).
 466 */
 467 extern "C"
 468 {
 469     SAL_DLLPUBLIC_EXPORT void* getStandardAccessibleFactory()
 470     {
 471         ::toolkit::IAccessibleFactory* pFactory = new AccessibleFactory;
 472         pFactory->acquire();
 473         return pFactory;
 474     }
 475 }
 476
 477 /** this is the entry point to retrieve a factory for the svtools-level Accessible/Contexts supplied
 478     by this library
 479
 480     This function implements the factory function needed in svtools
 481     (of type GetSvtAccessibilityComponentFactory).
 482 */
 483 extern "C"
 484 {
 485     SAL_DLLPUBLIC_EXPORT void* getSvtAccessibilityComponentFactory()
 486     {
 487         ::vcl::IAccessibleFactory* pFactory = new AccessibleFactory;
 488         pFactory->acquire();
 489         return pFactory;
 490     }
 491 }
 492 #endif // HAVE_FEATURE_DESKTOP
 493
 494 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */