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