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 "accessibility/extended/AccessibleBrowseBox.hxx"
  21 #include "accessibility/extended/AccessibleBrowseBoxTable.hxx"
  22 #include "accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx"
  23 #include <svtools/accessibletableprovider.hxx>
  24 #include <comphelper/types.hxx>
  25 #include <toolkit/helper/vclunohelper.hxx>
  26
  27
  28
  29 namespace accessibility
  30 {
  31
  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 using namespace ::svt;
  39
  40
  41 class AccessibleBrowseBoxImpl
  42 {
  43 public:
  44     /// the XAccessible which created the AccessibleBrowseBox
  45     WeakReference< XAccessible >                                m_aCreator;
  46
  47     /** The data table child. */
  48     Reference<
  49         ::com::sun::star::accessibility::XAccessible >          mxTable;
  50     AccessibleBrowseBoxTable*                                   m_pTable;
  51
  52     /** The header bar for rows ("handle column"). */
  53     Reference<
  54         ::com::sun::star::accessibility::XAccessible >          mxRowHeaderBar;
  55     AccessibleBrowseBoxHeaderBar*                               m_pRowHeaderBar;
  56
  57     /** The header bar for columns (first row of the table). */
  58     Reference<
  59         ::com::sun::star::accessibility::XAccessible >          mxColumnHeaderBar;
  60     AccessibleBrowseBoxHeaderBar*                               m_pColumnHeaderBar;
  61 };
  62
  63 // Ctor/Dtor/disposing --------------------------------------------------------
  64
  65 AccessibleBrowseBox::AccessibleBrowseBox(
  66             const Reference< XAccessible >& _rxParent, const Reference< XAccessible >& _rxCreator,
  67             IAccessibleTableProvider& _rBrowseBox )
  68     : AccessibleBrowseBoxBase( _rxParent, _rBrowseBox,NULL, BBTYPE_BROWSEBOX )
  69 {
  70     m_xImpl.reset( new AccessibleBrowseBoxImpl() );
  71     m_xImpl->m_aCreator = _rxCreator;
  72
  73     m_xFocusWindow = VCLUnoHelper::GetInterface(mpBrowseBox->GetWindowInstance());
  74 }
  75
  76 void AccessibleBrowseBox::setCreator( const Reference< XAccessible >& _rxCreator )
  77 {
  78 #if OSL_DEBUG_LEVEL > 0
  79     Reference< XAccessible > xCreator(m_xImpl->m_aCreator);
  80     OSL_ENSURE( !xCreator.is(), "accessibility/extended/AccessibleBrowseBox::setCreator: creator already set!" );
  81 #endif
  82     m_xImpl->m_aCreator = _rxCreator;
  83 }
  84
  85
  86 AccessibleBrowseBox::~AccessibleBrowseBox()
  87 {
  88 }
  89
  90
  91 void SAL_CALL AccessibleBrowseBox::disposing()
  92 {
  93     ::osl::MutexGuard aGuard( getOslMutex() );
  94
  95     m_xImpl->m_pTable           = NULL;
  96     m_xImpl->m_pColumnHeaderBar = NULL;
  97     m_xImpl->m_pRowHeaderBar    = NULL;
  98     m_xImpl->m_aCreator.clear();
  99
 100     Reference< XAccessible >  xTable = m_xImpl->mxTable;
 101
 102     Reference< XComponent > xComp( m_xImpl->mxTable, UNO_QUERY );
 103     if ( xComp.is() )
 104     {
 105         xComp->dispose();
 106
 107     }
 108 //!    ::comphelper::disposeComponent(m_xImpl->mxTable);
 109     ::comphelper::disposeComponent(m_xImpl->mxRowHeaderBar);
 110     ::comphelper::disposeComponent(m_xImpl->mxColumnHeaderBar);
 111
 112     AccessibleBrowseBoxBase::disposing();
 113 }
 114
 115
 116 // XAccessibleContext ---------------------------------------------------------
 117
 118 sal_Int32 SAL_CALL AccessibleBrowseBox::getAccessibleChildCount()
 119     throw ( uno::RuntimeException, std::exception )
 120 {
 121     SolarMutexGuard aSolarGuard;
 122     ::osl::MutexGuard aGuard( getOslMutex() );
 123     ensureIsAlive();
 124     return BBINDEX_FIRSTCONTROL + mpBrowseBox->GetAccessibleControlCount();
 125 }
 126
 127
 128 Reference< XAccessible > SAL_CALL
 129 AccessibleBrowseBox::getAccessibleChild( sal_Int32 nChildIndex )
 130     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException, std::exception )
 131 {
 132     SolarMutexGuard aSolarGuard;
 133     ::osl::MutexGuard aGuard( getOslMutex() );
 134     ensureIsAlive();
 135
 136     Reference< XAccessible > xRet;
 137     if( nChildIndex >= 0 )
 138     {
 139         if( nChildIndex < BBINDEX_FIRSTCONTROL )
 140             xRet = implGetFixedChild( nChildIndex );
 141         else
 142         {
 143             // additional controls
 144             nChildIndex -= BBINDEX_FIRSTCONTROL;
 145             if( nChildIndex < mpBrowseBox->GetAccessibleControlCount() )
 146                 xRet = mpBrowseBox->CreateAccessibleControl( nChildIndex );
 147         }
 148     }
 149
 150     if( !xRet.is() )
 151         throw lang::IndexOutOfBoundsException();
 152     return xRet;
 153 }
 154
 155 // XAccessibleComponent -------------------------------------------------------
 156
 157 Reference< XAccessible > SAL_CALL
 158 AccessibleBrowseBox::getAccessibleAtPoint( const awt::Point& rPoint )
 159     throw ( uno::RuntimeException, std::exception )
 160 {
 161     SolarMutexGuard aSolarGuard;
 162     ::osl::MutexGuard aGuard( getOslMutex() );
 163     ensureIsAlive();
 164
 165     Reference< XAccessible > xChild;
 166     sal_Int32 nIndex = 0;
 167     if( mpBrowseBox->ConvertPointToControlIndex( nIndex, VCLPoint( rPoint ) ) )
 168         xChild = mpBrowseBox->CreateAccessibleControl( nIndex );
 169     else
 170     {
 171         // try whether point is in one of the fixed children
 172         // (table, header bars, corner control)
 173         Point aPoint( VCLPoint( rPoint ) );
 174         for( nIndex = 0; (nIndex < BBINDEX_FIRSTCONTROL) && !xChild.is(); ++nIndex )
 175         {
 176             Reference< XAccessible > xCurrChild( implGetFixedChild( nIndex ) );
 177             Reference< XAccessibleComponent >
 178                 xCurrChildComp( xCurrChild, uno::UNO_QUERY );
 179
 180             if( xCurrChildComp.is() &&
 181                     VCLRectangle( xCurrChildComp->getBounds() ).IsInside( aPoint ) )
 182                 xChild = xCurrChild;
 183         }
 184     }
 185     return xChild;
 186 }
 187
 188
 189 void SAL_CALL AccessibleBrowseBox::grabFocus()
 190     throw ( uno::RuntimeException, std::exception )
 191 {
 192     SolarMutexGuard aSolarGuard;
 193     ::osl::MutexGuard aGuard( getOslMutex() );
 194     ensureIsAlive();
 195     mpBrowseBox->GrabFocus();
 196 }
 197
 198 // XServiceInfo ---------------------------------------------------------------
 199
 200 OUString SAL_CALL AccessibleBrowseBox::getImplementationName()
 201     throw ( uno::RuntimeException, std::exception )
 202 {
 203     return OUString( "com.sun.star.comp.svtools.AccessibleBrowseBox" );
 204 }
 205
 206
 207 // internal virtual methods ---------------------------------------------------
 208
 209 Rectangle AccessibleBrowseBox::implGetBoundingBox()
 210 {
 211     vcl::Window* pParent = mpBrowseBox->GetAccessibleParentWindow();
 212     OSL_ENSURE( pParent, "implGetBoundingBox - missing parent window" );
 213     return mpBrowseBox->GetWindowExtentsRelative( pParent );
 214 }
 215
 216
 217 Rectangle AccessibleBrowseBox::implGetBoundingBoxOnScreen()
 218 {
 219     return mpBrowseBox->GetWindowExtentsRelative( NULL );
 220 }
 221
 222
 223 // internal helper methods ----------------------------------------------------
 224
 225 Reference< XAccessible > AccessibleBrowseBox::implGetTable()
 226 {
 227     if( !m_xImpl->mxTable.is() )
 228     {
 229         m_xImpl->m_pTable = createAccessibleTable();
 230         m_xImpl->mxTable  = m_xImpl->m_pTable;
 231
 232     }
 233     return m_xImpl->mxTable;
 234 }
 235
 236
 237 Reference< XAccessible >
 238 AccessibleBrowseBox::implGetHeaderBar( AccessibleBrowseBoxObjType eObjType )
 239 {
 240     Reference< XAccessible > xRet;
 241     Reference< XAccessible >* pxMember = NULL;
 242
 243     if( eObjType == BBTYPE_ROWHEADERBAR )
 244         pxMember = &m_xImpl->mxRowHeaderBar;
 245     else if( eObjType ==  BBTYPE_COLUMNHEADERBAR )
 246         pxMember = &m_xImpl->mxColumnHeaderBar;
 247
 248     if( pxMember )
 249     {
 250         if( !pxMember->is() )
 251         {
 252             AccessibleBrowseBoxHeaderBar* pHeaderBar = new AccessibleBrowseBoxHeaderBar(
 253                 m_xImpl->m_aCreator, *mpBrowseBox, eObjType );
 254
 255             if ( BBTYPE_COLUMNHEADERBAR == eObjType)
 256                 m_xImpl->m_pColumnHeaderBar = pHeaderBar;
 257             else
 258                 m_xImpl->m_pRowHeaderBar    = pHeaderBar;
 259
 260             *pxMember = pHeaderBar;
 261         }
 262         xRet = *pxMember;
 263     }
 264     return xRet;
 265 }
 266
 267
 268 Reference< XAccessible >
 269 AccessibleBrowseBox::implGetFixedChild( sal_Int32 nChildIndex )
 270 {
 271     Reference< XAccessible > xRet;
 272     switch( nChildIndex )
 273     {
 274         case BBINDEX_COLUMNHEADERBAR:
 275             xRet = implGetHeaderBar( BBTYPE_COLUMNHEADERBAR );
 276         break;
 277         case BBINDEX_ROWHEADERBAR:
 278             xRet = implGetHeaderBar( BBTYPE_ROWHEADERBAR );
 279         break;
 280         case BBINDEX_TABLE:
 281             xRet = implGetTable();
 282         break;
 283     }
 284     return xRet;
 285 }
 286
 287 AccessibleBrowseBoxTable* AccessibleBrowseBox::createAccessibleTable()
 288 {
 289     Reference< XAccessible > xCreator(m_xImpl->m_aCreator);
 290     OSL_ENSURE( xCreator.is(), "accessibility/extended/AccessibleBrowseBox::createAccessibleTable: my creator died - how this?" );
 291     return new AccessibleBrowseBoxTable( xCreator, *mpBrowseBox );
 292 }
 293
 294 void AccessibleBrowseBox::commitTableEvent(sal_Int16 _nEventId,const Any& _rNewValue,const Any& _rOldValue)
 295 {
 296     if ( m_xImpl->mxTable.is() )
 297     {
 298         m_xImpl->m_pTable->commitEvent(_nEventId,_rNewValue,_rOldValue);
 299     }
 300 }
 301
 302 void AccessibleBrowseBox::commitHeaderBarEvent( sal_Int16 _nEventId,
 303                                                 const Any& _rNewValue,
 304                                                 const Any& _rOldValue,bool _bColumnHeaderBar)
 305 {
 306     Reference< XAccessible > xHeaderBar = _bColumnHeaderBar ? m_xImpl->mxColumnHeaderBar : m_xImpl->mxRowHeaderBar;
 307     AccessibleBrowseBoxHeaderBar* pHeaderBar = _bColumnHeaderBar ? m_xImpl->m_pColumnHeaderBar : m_xImpl->m_pRowHeaderBar;
 308     if ( xHeaderBar.is() )
 309         pHeaderBar->commitEvent(_nEventId,_rNewValue,_rOldValue);
 310 }
 311
 312
 313 // = AccessibleBrowseBoxAccess
 314
 315 AccessibleBrowseBoxAccess::AccessibleBrowseBoxAccess( const Reference< XAccessible >& _rxParent, IAccessibleTableProvider& _rBrowseBox )
 316         :m_xParent( _rxParent )
 317         ,m_rBrowseBox( _rBrowseBox )
 318         ,m_pContext( NULL )
 319 {
 320 }
 321
 322
 323 AccessibleBrowseBoxAccess::~AccessibleBrowseBoxAccess()
 324 {
 325 }
 326
 327
 328 void AccessibleBrowseBoxAccess::dispose()
 329 {
 330     ::osl::MutexGuard aGuard( m_aMutex );
 331
 332     m_pContext = NULL;
 333     ::comphelper::disposeComponent( m_xContext );
 334 }
 335
 336
 337 Reference< XAccessibleContext > SAL_CALL AccessibleBrowseBoxAccess::getAccessibleContext() throw ( RuntimeException, std::exception )
 338 {
 339     ::osl::MutexGuard aGuard( m_aMutex );
 340
 341     OSL_ENSURE( ( m_pContext && m_xContext.is() ) || ( !m_pContext && !m_xContext.is() ),
 342         "accessibility/extended/AccessibleBrowseBoxAccess::getAccessibleContext: inconsistency!" );
 343
 344     // if the context died meanwhile (there is no listener, so it won't tell us explicitily when this happens),
 345     // then reset and re-create.
 346     if ( m_pContext && !m_pContext->isAlive() )
 347         m_xContext = m_pContext = NULL;
 348
 349     if ( !m_xContext.is() )
 350         m_xContext = m_pContext = new AccessibleBrowseBox( m_xParent, this, m_rBrowseBox );
 351
 352     return m_xContext;
 353 }
 354
 355
 356 bool AccessibleBrowseBoxAccess::isContextAlive() const
 357 {
 358     return  ( NULL != m_pContext ) && m_pContext->isAlive();
 359 }
 360
 361
 362
 363 }   // namespace accessibility
 364
 365 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */