accessibility/source/extended/AccessibleBrowseBox.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 <extended/AccessibleBrowseBox.hxx>
  21 #include <extended/AccessibleBrowseBoxTable.hxx>
  22 #include <extended/AccessibleBrowseBoxHeaderBar.hxx>
  23 #include <com/sun/star/awt/XVclWindowPeer.hdl>
  24 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  25 #include <utility>
  26 #include <vcl/accessibletableprovider.hxx>
  27 #include <vcl/unohelp.hxx>
  28 #include <sal/types.h>
  29
  30
  31 namespace accessibility
  32 {
  33
  34 using namespace ::com::sun::star::uno;
  35 using namespace ::com::sun::star;
  36 using namespace ::com::sun::star::lang;
  37 using namespace ::com::sun::star::accessibility;
  38
  39 // Ctor/Dtor/disposing
  40
  41 AccessibleBrowseBox::AccessibleBrowseBox(
  42             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent, const css::uno::Reference< css::accessibility::XAccessible >& _rxCreator,
  43             ::vcl::IAccessibleTableProvider& _rBrowseBox )
  44     : AccessibleBrowseBoxBase(_rxParent, _rBrowseBox, nullptr, AccessibleBrowseBoxObjType::BrowseBox)
  45     , m_aCreator(_rxCreator)
  46 {
  47     m_xFocusWindow.set(mpBrowseBox->GetWindowInstance()->GetComponentInterface(), css::uno::UNO_QUERY);
  48 }
  49
  50 void AccessibleBrowseBox::setCreator( const css::uno::Reference< css::accessibility::XAccessible >& _rxCreator )
  51 {
  52 #if OSL_DEBUG_LEVEL > 0
  53     css::uno::Reference< css::accessibility::XAccessible > xCreator(m_aCreator);
  54     OSL_ENSURE( !xCreator.is(), "extended/AccessibleBrowseBox::setCreator: creator already set!" );
  55 #endif
  56     m_aCreator = _rxCreator;
  57 }
  58
  59
  60 AccessibleBrowseBox::~AccessibleBrowseBox()
  61 {
  62 }
  63
  64
  65 void SAL_CALL AccessibleBrowseBox::disposing()
  66 {
  67     ::osl::MutexGuard aGuard( getMutex() );
  68
  69     m_aCreator.clear();
  70
  71     if ( mxTable.is() )
  72     {
  73         mxTable->dispose();
  74         mxTable.clear();
  75     }
  76     if ( mxRowHeaderBar.is() )
  77     {
  78         mxRowHeaderBar->dispose();
  79         mxRowHeaderBar.clear();
  80     }
  81     if ( mxColumnHeaderBar.is() )
  82     {
  83         mxColumnHeaderBar->dispose();
  84         mxColumnHeaderBar.clear();
  85     }
  86
  87     AccessibleBrowseBoxBase::disposing();
  88 }
  89
  90
  91 // css::accessibility::XAccessibleContext
  92
  93 sal_Int64 SAL_CALL AccessibleBrowseBox::getAccessibleChildCount()
  94 {
  95     SolarMethodGuard aGuard(getMutex());
  96     ensureIsAlive();
  97
  98     return vcl::BBINDEX_FIRSTCONTROL + mpBrowseBox->GetAccessibleControlCount();
  99 }
 100
 101
 102 css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
 103 AccessibleBrowseBox::getAccessibleChild( sal_Int64 nChildIndex )
 104 {
 105     SolarMethodGuard aGuard(getMutex());
 106     ensureIsAlive();
 107
 108     if (nChildIndex < 0 || nChildIndex >= getAccessibleChildCount())
 109         throw lang::IndexOutOfBoundsException();
 110
 111     css::uno::Reference< css::accessibility::XAccessible > xRet;
 112     if( nChildIndex >= 0 )
 113     {
 114         if( nChildIndex < vcl::BBINDEX_FIRSTCONTROL )
 115             xRet = implGetFixedChild( nChildIndex );
 116         else
 117         {
 118             // additional controls
 119             nChildIndex -= vcl::BBINDEX_FIRSTCONTROL;
 120             if( nChildIndex < mpBrowseBox->GetAccessibleControlCount() )
 121                 xRet = mpBrowseBox->CreateAccessibleControl( nChildIndex );
 122         }
 123     }
 124
 125     if( !xRet.is() )
 126         throw lang::IndexOutOfBoundsException();
 127     return xRet;
 128 }
 129
 130 // css::accessibility::XAccessibleComponent
 131
 132 css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
 133 AccessibleBrowseBox::getAccessibleAtPoint( const awt::Point& rPoint )
 134 {
 135     SolarMethodGuard aGuard(getMutex());
 136     ensureIsAlive();
 137
 138     sal_Int32 nIndex = 0;
 139     if (mpBrowseBox->ConvertPointToControlIndex(nIndex, vcl::unohelper::ConvertToVCLPoint(rPoint)))
 140         return mpBrowseBox->CreateAccessibleControl(nIndex);
 141
 142     // try whether point is in one of the fixed children
 143     // (table, header bars, corner control)
 144     Point aPoint(vcl::unohelper::ConvertToVCLPoint(rPoint));
 145     for (nIndex = 0; nIndex < vcl::BBINDEX_FIRSTCONTROL; ++nIndex)
 146     {
 147         css::uno::Reference< css::accessibility::XAccessible > xCurrChild(implGetFixedChild(nIndex));
 148         css::uno::Reference< css::accessibility::XAccessibleComponent >
 149             xCurrChildComp( xCurrChild, uno::UNO_QUERY );
 150
 151         if (xCurrChildComp.is()
 152             && vcl::unohelper::ConvertToVCLRect(xCurrChildComp->getBounds()).Contains(aPoint))
 153             return xCurrChild;
 154     }
 155     return nullptr;
 156 }
 157
 158
 159 void SAL_CALL AccessibleBrowseBox::grabFocus()
 160 {
 161     SolarMethodGuard aGuard(getMutex());
 162     ensureIsAlive();
 163
 164     mpBrowseBox->GrabFocus();
 165 }
 166
 167 // XServiceInfo
 168 OUString SAL_CALL AccessibleBrowseBox::getImplementationName()
 169 {
 170     return u"com.sun.star.comp.svtools.AccessibleBrowseBox"_ustr;
 171 }
 172
 173 // internal virtual methods
 174 tools::Rectangle AccessibleBrowseBox::implGetBoundingBox()
 175 {
 176     vcl::Window* pParent = mpBrowseBox->GetAccessibleParentWindow();
 177     assert(pParent && "implGetBoundingBox - missing parent window");
 178     return mpBrowseBox->GetWindowExtentsRelative( *pParent );
 179 }
 180
 181 AbsoluteScreenPixelRectangle AccessibleBrowseBox::implGetBoundingBoxOnScreen()
 182 {
 183     return mpBrowseBox->GetWindowExtentsAbsolute();
 184 }
 185
 186 // internal helper methods
 187 css::uno::Reference< css::accessibility::XAccessible > AccessibleBrowseBox::implGetTable()
 188 {
 189     if( !mxTable.is() )
 190     {
 191         mxTable = createAccessibleTable();
 192
 193     }
 194     return mxTable;
 195 }
 196
 197 css::uno::Reference< css::accessibility::XAccessible >
 198 AccessibleBrowseBox::implGetHeaderBar(AccessibleBrowseBoxObjType eObjType)
 199 {
 200     if( eObjType == AccessibleBrowseBoxObjType::RowHeaderBar )
 201     {
 202         if (!mxRowHeaderBar.is())
 203             mxRowHeaderBar = new AccessibleBrowseBoxHeaderBar(m_aCreator, *mpBrowseBox, eObjType);
 204         return mxRowHeaderBar;
 205     }
 206     else if( eObjType == AccessibleBrowseBoxObjType::ColumnHeaderBar )
 207     {
 208         if (!mxColumnHeaderBar.is())
 209             mxColumnHeaderBar = new AccessibleBrowseBoxHeaderBar(m_aCreator, *mpBrowseBox, eObjType);
 210         return mxColumnHeaderBar;
 211     }
 212
 213     return css::uno::Reference<css::accessibility::XAccessible>();
 214 }
 215
 216 css::uno::Reference< css::accessibility::XAccessible >
 217 AccessibleBrowseBox::implGetFixedChild( sal_Int64 nChildIndex )
 218 {
 219     css::uno::Reference< css::accessibility::XAccessible > xRet;
 220     switch( nChildIndex )
 221     {
 222         case vcl::BBINDEX_COLUMNHEADERBAR:
 223             xRet = implGetHeaderBar( AccessibleBrowseBoxObjType::ColumnHeaderBar );
 224         break;
 225         case vcl::BBINDEX_ROWHEADERBAR:
 226             xRet = implGetHeaderBar( AccessibleBrowseBoxObjType::RowHeaderBar );
 227         break;
 228         case vcl::BBINDEX_TABLE:
 229             xRet = implGetTable();
 230         break;
 231     }
 232     return xRet;
 233 }
 234
 235 rtl::Reference<AccessibleBrowseBoxTable> AccessibleBrowseBox::createAccessibleTable()
 236 {
 237     css::uno::Reference< css::accessibility::XAccessible > xCreator(m_aCreator);
 238     OSL_ENSURE( xCreator.is(), "extended/AccessibleBrowseBox::createAccessibleTable: my creator died - how this?" );
 239     return new AccessibleBrowseBoxTable( xCreator, *mpBrowseBox );
 240 }
 241
 242 void AccessibleBrowseBox::commitTableEvent(sal_Int16 _nEventId,const Any& _rNewValue,const Any& _rOldValue)
 243 {
 244     if ( mxTable.is() )
 245     {
 246         mxTable->commitEvent(_nEventId,_rNewValue,_rOldValue);
 247     }
 248 }
 249
 250 void AccessibleBrowseBox::commitHeaderBarEvent( sal_Int16 _nEventId,
 251                                                 const Any& _rNewValue,
 252                                                 const Any& _rOldValue,bool _bColumnHeaderBar)
 253 {
 254     rtl::Reference< AccessibleBrowseBoxHeaderBar >& xHeaderBar = _bColumnHeaderBar ? mxColumnHeaderBar : mxRowHeaderBar;
 255     if ( xHeaderBar.is() )
 256         xHeaderBar->commitEvent(_nEventId,_rNewValue,_rOldValue);
 257 }
 258
 259
 260 // = AccessibleBrowseBoxAccess
 261
 262 AccessibleBrowseBoxAccess::AccessibleBrowseBoxAccess( css::uno::Reference< css::accessibility::XAccessible > _xParent, ::vcl::IAccessibleTableProvider& _rBrowseBox )
 263         :m_xParent(std::move( _xParent ))
 264         ,m_rBrowseBox( _rBrowseBox )
 265 {
 266 }
 267
 268
 269 AccessibleBrowseBoxAccess::~AccessibleBrowseBoxAccess()
 270 {
 271 }
 272
 273
 274 void AccessibleBrowseBoxAccess::dispose()
 275 {
 276     std::unique_lock aGuard( m_aMutex );
 277
 278     if (m_xContext.is())
 279     {
 280         m_xContext->dispose();
 281         m_xContext.clear();
 282     }
 283     m_xParent.clear();
 284 }
 285
 286
 287 css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL AccessibleBrowseBoxAccess::getAccessibleContext()
 288 {
 289     std::unique_lock aGuard( m_aMutex );
 290
 291     // if the context died meanwhile (there is no listener, so it won't tell us explicitly when this happens),
 292     // then reset and re-create.
 293     if ( m_xContext.is() && !m_xContext->isAlive() )
 294         m_xContext = nullptr;
 295
 296     if ( !m_xContext.is() )
 297         m_xContext = new AccessibleBrowseBox( m_xParent, this, m_rBrowseBox );
 298
 299     return m_xContext;
 300 }
 301
 302
 303
 304 } // namespace accessibility
 305
 306 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */