accessibility/source/extended/AccessibleBrowseBox.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleBrowseBox.cxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_accessibility.hxx"
  33 #include "accessibility/extended/AccessibleBrowseBox.hxx"
  34 #include "accessibility/extended/AccessibleBrowseBoxTable.hxx"
  35 #include "accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx"
  36 #include <svtools/accessibletableprovider.hxx>
  37 #include <comphelper/types.hxx>
  38 #include <toolkit/helper/vclunohelper.hxx>
  39
  40 // ============================================================================
  41
  42 namespace accessibility
  43 {
  44
  45 // ============================================================================
  46
  47 using ::rtl::OUString;
  48
  49 using namespace ::com::sun::star::uno;
  50 using namespace ::com::sun::star;
  51 using namespace ::com::sun::star::lang;
  52 using namespace ::com::sun::star::accessibility;
  53 using namespace ::svt;
  54
  55 // ============================================================================
  56 class AccessibleBrowseBoxImpl
  57 {
  58 public:
  59     /// the XAccessible which created the AccessibleBrowseBox
  60     WeakReference< XAccessible >                                m_aCreator;
  61
  62     /** The data table child. */
  63     Reference<
  64         ::com::sun::star::accessibility::XAccessible >          mxTable;
  65     AccessibleBrowseBoxTable*                                                                   m_pTable;
  66
  67     /** The header bar for rows ("handle column"). */
  68     Reference<
  69         ::com::sun::star::accessibility::XAccessible >          mxRowHeaderBar;
  70     AccessibleBrowseBoxHeaderBar*                                                               m_pRowHeaderBar;
  71
  72     /** The header bar for columns (first row of the table). */
  73     Reference<
  74         ::com::sun::star::accessibility::XAccessible >          mxColumnHeaderBar;
  75     AccessibleBrowseBoxHeaderBar*                                                               m_pColumnHeaderBar;
  76 };
  77
  78 // Ctor/Dtor/disposing --------------------------------------------------------
  79
  80 DBG_NAME( AccessibleBrowseBox )
  81
  82 AccessibleBrowseBox::AccessibleBrowseBox(
  83             const Reference< XAccessible >& _rxParent, const Reference< XAccessible >& _rxCreator,
  84             IAccessibleTableProvider& _rBrowseBox )
  85     : AccessibleBrowseBoxBase( _rxParent, _rBrowseBox,NULL, BBTYPE_BROWSEBOX )
  86 {
  87     DBG_CTOR( AccessibleBrowseBox, NULL );
  88     m_pImpl.reset( new AccessibleBrowseBoxImpl() );
  89     m_pImpl->m_aCreator = _rxCreator;
  90
  91     m_xFocusWindow = VCLUnoHelper::GetInterface(mpBrowseBox->GetWindowInstance());
  92 }
  93 // -----------------------------------------------------------------------------
  94 void AccessibleBrowseBox::setCreator( const Reference< XAccessible >& _rxCreator )
  95 {
  96 #if OSL_DEBUG_LEVEL > 0
  97     Reference< XAccessible > xCreator = (Reference< XAccessible >)m_pImpl->m_aCreator;
  98     DBG_ASSERT( !xCreator.is(), "accessibility/extended/AccessibleBrowseBox::setCreator: creator already set!" );
  99 #endif
 100     m_pImpl->m_aCreator = _rxCreator;
 101 }
 102
 103 // -----------------------------------------------------------------------------
 104 AccessibleBrowseBox::~AccessibleBrowseBox()
 105 {
 106     DBG_DTOR( AccessibleBrowseBox, NULL );
 107 }
 108 // -----------------------------------------------------------------------------
 109
 110 void SAL_CALL AccessibleBrowseBox::disposing()
 111 {
 112     ::osl::MutexGuard aGuard( getOslMutex() );
 113
 114     m_pImpl->m_pTable                   = NULL;
 115     m_pImpl->m_pColumnHeaderBar = NULL;
 116     m_pImpl->m_pRowHeaderBar    = NULL;
 117     m_pImpl->m_aCreator         = Reference< XAccessible >();
 118
 119     Reference< XAccessible >  xTable = m_pImpl->mxTable;
 120
 121     Reference< XComponent > xComp( m_pImpl->mxTable, UNO_QUERY );
 122     if ( xComp.is() )
 123     {
 124         xComp->dispose();
 125
 126     }
 127 //!    ::comphelper::disposeComponent(m_pImpl->mxTable);
 128     ::comphelper::disposeComponent(m_pImpl->mxRowHeaderBar);
 129     ::comphelper::disposeComponent(m_pImpl->mxColumnHeaderBar);
 130
 131     AccessibleBrowseBoxBase::disposing();
 132 }
 133 // -----------------------------------------------------------------------------
 134
 135 // XAccessibleContext ---------------------------------------------------------
 136
 137 sal_Int32 SAL_CALL AccessibleBrowseBox::getAccessibleChildCount()
 138     throw ( uno::RuntimeException )
 139 {
 140     BBSolarGuard aSolarGuard;
 141     ::osl::MutexGuard aGuard( getOslMutex() );
 142     ensureIsAlive();
 143     return BBINDEX_FIRSTCONTROL + mpBrowseBox->GetAccessibleControlCount();
 144 }
 145 // -----------------------------------------------------------------------------
 146
 147 Reference< XAccessible > SAL_CALL
 148 AccessibleBrowseBox::getAccessibleChild( sal_Int32 nChildIndex )
 149     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 150 {
 151     BBSolarGuard aSolarGuard;
 152     ::osl::MutexGuard aGuard( getOslMutex() );
 153     ensureIsAlive();
 154
 155     Reference< XAccessible > xRet;
 156     if( nChildIndex >= 0 )
 157     {
 158         if( nChildIndex < BBINDEX_FIRSTCONTROL )
 159             xRet = implGetFixedChild( nChildIndex );
 160         else
 161         {
 162             // additional controls
 163             nChildIndex -= BBINDEX_FIRSTCONTROL;
 164             if( nChildIndex < mpBrowseBox->GetAccessibleControlCount() )
 165                 xRet = mpBrowseBox->CreateAccessibleControl( nChildIndex );
 166         }
 167     }
 168
 169     if( !xRet.is() )
 170         throw lang::IndexOutOfBoundsException();
 171     return xRet;
 172 }
 173 // -----------------------------------------------------------------------------
 174
 175 //sal_Int16 SAL_CALL AccessibleBrowseBox::getAccessibleRole()
 176 //    throw ( uno::RuntimeException )
 177 //{
 178 //    ensureIsAlive();
 179 //    return AccessibleRole::PANEL;
 180 //}
 181 // -----------------------------------------------------------------------------
 182
 183 // XAccessibleComponent -------------------------------------------------------
 184
 185 Reference< XAccessible > SAL_CALL
 186 AccessibleBrowseBox::getAccessibleAtPoint( const awt::Point& rPoint )
 187     throw ( uno::RuntimeException )
 188 {
 189     BBSolarGuard aSolarGuard;
 190     ::osl::MutexGuard aGuard( getOslMutex() );
 191     ensureIsAlive();
 192
 193     Reference< XAccessible > xChild;
 194     sal_Int32 nIndex = 0;
 195     if( mpBrowseBox->ConvertPointToControlIndex( nIndex, VCLPoint( rPoint ) ) )
 196         xChild = mpBrowseBox->CreateAccessibleControl( nIndex );
 197     else
 198     {
 199         // try whether point is in one of the fixed children
 200         // (table, header bars, corner control)
 201         Point aPoint( VCLPoint( rPoint ) );
 202         for( nIndex = 0; (nIndex < BBINDEX_FIRSTCONTROL) && !xChild.is(); ++nIndex )
 203         {
 204             Reference< XAccessible > xCurrChild( implGetFixedChild( nIndex ) );
 205             Reference< XAccessibleComponent >
 206                 xCurrChildComp( xCurrChild, uno::UNO_QUERY );
 207
 208             if( xCurrChildComp.is() &&
 209                     VCLRectangle( xCurrChildComp->getBounds() ).IsInside( aPoint ) )
 210                 xChild = xCurrChild;
 211         }
 212     }
 213     return xChild;
 214 }
 215 // -----------------------------------------------------------------------------
 216
 217 void SAL_CALL AccessibleBrowseBox::grabFocus()
 218     throw ( uno::RuntimeException )
 219 {
 220     BBSolarGuard aSolarGuard;
 221     ::osl::MutexGuard aGuard( getOslMutex() );
 222     ensureIsAlive();
 223     mpBrowseBox->GrabFocus();
 224 }
 225 // -----------------------------------------------------------------------------
 226
 227 Any SAL_CALL AccessibleBrowseBox::getAccessibleKeyBinding()
 228     throw ( uno::RuntimeException )
 229 {
 230     ensureIsAlive();
 231     return Any();
 232 }
 233 // -----------------------------------------------------------------------------
 234
 235 // XServiceInfo ---------------------------------------------------------------
 236
 237 OUString SAL_CALL AccessibleBrowseBox::getImplementationName()
 238     throw ( uno::RuntimeException )
 239 {
 240     return OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.svtools.AccessibleBrowseBox" ) );
 241 }
 242 // -----------------------------------------------------------------------------
 243
 244 // internal virtual methods ---------------------------------------------------
 245
 246 Rectangle AccessibleBrowseBox::implGetBoundingBox()
 247 {
 248     Window* pParent = mpBrowseBox->GetAccessibleParentWindow();
 249     DBG_ASSERT( pParent, "implGetBoundingBox - missing parent window" );
 250     return mpBrowseBox->GetWindowExtentsRelative( pParent );
 251 }
 252 // -----------------------------------------------------------------------------
 253
 254 Rectangle AccessibleBrowseBox::implGetBoundingBoxOnScreen()
 255 {
 256     return mpBrowseBox->GetWindowExtentsRelative( NULL );
 257 }
 258 // -----------------------------------------------------------------------------
 259
 260 // internal helper methods ----------------------------------------------------
 261
 262 Reference< XAccessible > AccessibleBrowseBox::implGetTable()
 263 {
 264     if( !m_pImpl->mxTable.is() )
 265     {
 266         m_pImpl->m_pTable = createAccessibleTable();
 267         m_pImpl->mxTable  = m_pImpl->m_pTable;
 268
 269     }
 270     return m_pImpl->mxTable;
 271 }
 272 // -----------------------------------------------------------------------------
 273
 274 Reference< XAccessible >
 275 AccessibleBrowseBox::implGetHeaderBar( AccessibleBrowseBoxObjType eObjType )
 276 {
 277     Reference< XAccessible > xRet;
 278     Reference< XAccessible >* pxMember = NULL;
 279
 280     if( eObjType == BBTYPE_ROWHEADERBAR )
 281         pxMember = &m_pImpl->mxRowHeaderBar;
 282     else if( eObjType ==  BBTYPE_COLUMNHEADERBAR )
 283         pxMember = &m_pImpl->mxColumnHeaderBar;
 284
 285     if( pxMember )
 286     {
 287         if( !pxMember->is() )
 288         {
 289             AccessibleBrowseBoxHeaderBar* pHeaderBar = new AccessibleBrowseBoxHeaderBar(
 290                 (Reference< XAccessible >)m_pImpl->m_aCreator, *mpBrowseBox, eObjType );
 291
 292             if ( BBTYPE_COLUMNHEADERBAR == eObjType)
 293                 m_pImpl->m_pColumnHeaderBar = pHeaderBar;
 294             else
 295                 m_pImpl->m_pRowHeaderBar        = pHeaderBar;
 296
 297             *pxMember = pHeaderBar;
 298         }
 299         xRet = *pxMember;
 300     }
 301     return xRet;
 302 }
 303 // -----------------------------------------------------------------------------
 304
 305 Reference< XAccessible >
 306 AccessibleBrowseBox::implGetFixedChild( sal_Int32 nChildIndex )
 307 {
 308     Reference< XAccessible > xRet;
 309     switch( nChildIndex )
 310     {
 311         case BBINDEX_COLUMNHEADERBAR:
 312             xRet = implGetHeaderBar( BBTYPE_COLUMNHEADERBAR );
 313         break;
 314         case BBINDEX_ROWHEADERBAR:
 315             xRet = implGetHeaderBar( BBTYPE_ROWHEADERBAR );
 316         break;
 317         case BBINDEX_TABLE:
 318             xRet = implGetTable();
 319         break;
 320     }
 321     return xRet;
 322 }
 323 // -----------------------------------------------------------------------------
 324 AccessibleBrowseBoxTable* AccessibleBrowseBox::createAccessibleTable()
 325 {
 326     Reference< XAccessible > xCreator = (Reference< XAccessible >)m_pImpl->m_aCreator;
 327     DBG_ASSERT( xCreator.is(), "accessibility/extended/AccessibleBrowseBox::createAccessibleTable: my creator died - how this?" );
 328     return new AccessibleBrowseBoxTable( xCreator, *mpBrowseBox );
 329 }
 330 // -----------------------------------------------------------------------------
 331 void AccessibleBrowseBox::commitTableEvent(sal_Int16 _nEventId,const Any& _rNewValue,const Any& _rOldValue)
 332 {
 333     if ( m_pImpl->mxTable.is() )
 334     {
 335         m_pImpl->m_pTable->commitEvent(_nEventId,_rNewValue,_rOldValue);
 336     }
 337 }
 338 // -----------------------------------------------------------------------------
 339 void AccessibleBrowseBox::commitHeaderBarEvent( sal_Int16 _nEventId,
 340                                                 const Any& _rNewValue,
 341                                                 const Any& _rOldValue,sal_Bool _bColumnHeaderBar)
 342 {
 343     Reference< XAccessible > xHeaderBar = _bColumnHeaderBar ? m_pImpl->mxColumnHeaderBar : m_pImpl->mxRowHeaderBar;
 344     AccessibleBrowseBoxHeaderBar* pHeaderBar = _bColumnHeaderBar ? m_pImpl->m_pColumnHeaderBar : m_pImpl->m_pRowHeaderBar;
 345     if ( xHeaderBar.is() )
 346         pHeaderBar->commitEvent(_nEventId,_rNewValue,_rOldValue);
 347 }
 348
 349 // ============================================================================
 350 // = AccessibleBrowseBoxAccess
 351 // ============================================================================
 352 DBG_NAME( AccessibleBrowseBoxAccess )
 353 // -----------------------------------------------------------------------------
 354 AccessibleBrowseBoxAccess::AccessibleBrowseBoxAccess( const Reference< XAccessible >& _rxParent, IAccessibleTableProvider& _rBrowseBox )
 355         :m_xParent( _rxParent )
 356         ,m_rBrowseBox( _rBrowseBox )
 357         ,m_pContext( NULL )
 358 {
 359     DBG_CTOR( AccessibleBrowseBoxAccess, NULL );
 360 }
 361
 362 // -----------------------------------------------------------------------------
 363 AccessibleBrowseBoxAccess::~AccessibleBrowseBoxAccess()
 364 {
 365     DBG_DTOR( AccessibleBrowseBoxAccess, NULL );
 366 }
 367
 368 // -----------------------------------------------------------------------------
 369 void AccessibleBrowseBoxAccess::dispose()
 370 {
 371     ::osl::MutexGuard aGuard( m_aMutex );
 372
 373     m_pContext = NULL;
 374     ::comphelper::disposeComponent( m_xContext );
 375 }
 376
 377 // -----------------------------------------------------------------------------
 378 Reference< XAccessibleContext > SAL_CALL AccessibleBrowseBoxAccess::getAccessibleContext() throw ( RuntimeException )
 379 {
 380     ::osl::MutexGuard aGuard( m_aMutex );
 381
 382     DBG_ASSERT( ( m_pContext && m_xContext.is() ) || ( !m_pContext && !m_xContext.is() ),
 383         "accessibility/extended/AccessibleBrowseBoxAccess::getAccessibleContext: inconsistency!" );
 384
 385     // if the context died meanwhile (we're no listener, so it won't tell us explicitily when this happens),
 386     // then reset an re-create.
 387     if ( m_pContext && !m_pContext->isAlive() )
 388         m_xContext = m_pContext = NULL;
 389
 390     if ( !m_xContext.is() )
 391         m_xContext = m_pContext = new AccessibleBrowseBox( m_xParent, this, m_rBrowseBox );
 392
 393     return m_xContext;
 394 }
 395
 396 // -----------------------------------------------------------------------------
 397 bool AccessibleBrowseBoxAccess::isContextAlive() const
 398 {
 399     return  ( NULL != m_pContext ) && m_pContext->isAlive();
 400 }
 401
 402 // ============================================================================
 403
 404 }   // namespace accessibility