accessibility/source/extended/accessibletablistboxtable.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: accessibletablistboxtable.cxx,v $
  10  * $Revision: 1.5 $
  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
  34 #ifndef ACCESSIBILITY_EXT_ACCESSIBLETABLISTBOXTABLE_HXX_
  35 #include "accessibility/extended/accessibletablistboxtable.hxx"
  36 #endif
  37 #include "accessibility/extended/AccessibleBrowseBoxTableCell.hxx"
  38 #include "accessibility/extended/AccessibleBrowseBoxCheckBoxCell.hxx"
  39 #include <svtools/svtabbx.hxx>
  40 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  41
  42 //........................................................................
  43 namespace accessibility
  44 {
  45 //........................................................................
  46
  47     // class TLBSolarGuard ---------------------------------------------------------
  48
  49     /** Aquire the solar mutex. */
  50     class TLBSolarGuard : public ::vos::OGuard
  51     {
  52     public:
  53         inline TLBSolarGuard() : ::vos::OGuard( Application::GetSolarMutex() ) {}
  54     };
  55
  56     // class AccessibleTabListBoxTable ---------------------------------------------
  57
  58     using namespace ::com::sun::star::accessibility;
  59     using namespace ::com::sun::star::uno;
  60     using namespace ::com::sun::star::lang;
  61     using namespace ::com::sun::star;
  62
  63     DBG_NAME(AccessibleTabListBoxTable)
  64
  65     // -----------------------------------------------------------------------------
  66     // Ctor() and Dtor()
  67     // -----------------------------------------------------------------------------
  68     AccessibleTabListBoxTable::AccessibleTabListBoxTable( const Reference< XAccessible >& rxParent, SvHeaderTabListBox& rBox ) :
  69
  70         AccessibleBrowseBoxTable( rxParent, rBox ),
  71
  72         m_pTabListBox   ( &rBox )
  73
  74     {
  75         DBG_CTOR( AccessibleTabListBoxTable, NULL );
  76
  77         m_pTabListBox->AddEventListener( LINK( this, AccessibleTabListBoxTable, WindowEventListener ) );
  78     }
  79     // -----------------------------------------------------------------------------
  80     AccessibleTabListBoxTable::~AccessibleTabListBoxTable()
  81     {
  82         DBG_DTOR( AccessibleTabListBoxTable, NULL );
  83
  84         if ( isAlive() )
  85         {
  86             m_pTabListBox = NULL;
  87
  88             // increment ref count to prevent double call of Dtor
  89             osl_incrementInterlockedCount( &m_refCount );
  90             dispose();
  91         }
  92     }
  93     // -----------------------------------------------------------------------------
  94     void AccessibleTabListBoxTable::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  95     {
  96         if ( isAlive() )
  97         {
  98             ULONG nEventId = rVclWindowEvent.GetId();
  99             switch ( nEventId )
 100             {
 101                 case  VCLEVENT_OBJECT_DYING :
 102                 {
 103                     m_pTabListBox->RemoveEventListener( LINK( this, AccessibleTabListBoxTable, WindowEventListener ) );
 104                     m_pTabListBox = NULL;
 105                     break;
 106                 }
 107
 108                 case VCLEVENT_CONTROL_GETFOCUS :
 109                 case VCLEVENT_CONTROL_LOSEFOCUS :
 110                 {
 111                     uno::Any aOldValue, aNewValue;
 112                     if ( VCLEVENT_CONTROL_GETFOCUS == nEventId )
 113                         aNewValue <<= AccessibleStateType::FOCUSED;
 114                     else
 115                         aOldValue <<= AccessibleStateType::FOCUSED;
 116                     commitEvent( AccessibleEventId::STATE_CHANGED, aNewValue, aOldValue );
 117                     break;
 118                 }
 119
 120                 case VCLEVENT_LISTBOX_SELECT :
 121                 {
 122                     // First send an event that tells the listeners of a
 123                     // modified selection.  The active descendant event is
 124                     // send after that so that the receiving AT has time to
 125                     // read the text or name of the active child.
 126                     commitEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
 127                     if ( m_pTabListBox && m_pTabListBox->HasFocus() )
 128                     {
 129                         SvLBoxEntry* pEntry = static_cast< SvLBoxEntry* >( rVclWindowEvent.GetData() );
 130                         if ( pEntry )
 131                         {
 132                             sal_Int32 nRow = m_pTabListBox->GetEntryPos( pEntry );
 133                             USHORT nCol = m_pTabListBox->GetCurrColumn();
 134                             Reference< XAccessible > xChild =
 135                                 m_pTabListBox->CreateAccessibleCell( nRow, nCol );
 136                             uno::Any aOldValue, aNewValue;
 137
 138                             if ( m_pTabListBox->IsTransientChildrenDisabled() )
 139                             {
 140                                 aNewValue <<= AccessibleStateType::FOCUSED;
 141                                 TriState eState = STATE_DONTKNOW;
 142                                 if ( m_pTabListBox->IsCellCheckBox( nRow, nCol, eState ) )
 143                                 {
 144                                     AccessibleCheckBoxCell* pCell =
 145                                         static_cast< AccessibleCheckBoxCell* >( xChild.get() );
 146                                     pCell->commitEvent( AccessibleEventId::STATE_CHANGED, aNewValue, aOldValue );
 147                                 }
 148                                 else
 149                                 {
 150                                     AccessibleBrowseBoxTableCell* pCell =
 151                                         static_cast< AccessibleBrowseBoxTableCell* >( xChild.get() );
 152                                     pCell->commitEvent( AccessibleEventId::STATE_CHANGED, aNewValue, aOldValue );
 153                                 }
 154                             }
 155                             else
 156                             {
 157                                 aNewValue <<= xChild;
 158                                 commitEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aNewValue, aOldValue );
 159                             }
 160                         }
 161                     }
 162                     break;
 163                 }
 164
 165                 case VCLEVENT_CHECKBOX_TOGGLE :
 166                 {
 167                     if ( m_pTabListBox && m_pTabListBox->HasFocus() )
 168                     {
 169                         SvLBoxEntry* pEntry = static_cast< SvLBoxEntry* >( rVclWindowEvent.GetData() );
 170                         if ( pEntry )
 171                         {
 172                             sal_Int32 nRow = m_pTabListBox->GetEntryPos( pEntry );
 173                             USHORT nCol = m_pTabListBox->GetCurrColumn();
 174                             TriState eState = STATE_DONTKNOW;
 175                             if ( m_pTabListBox->IsCellCheckBox( nRow, nCol, eState ) )
 176                             {
 177                                 Reference< XAccessible > xChild =
 178                                     m_pTabListBox->CreateAccessibleCell( nRow, nCol );
 179                                 AccessibleCheckBoxCell* pCell =
 180                                     static_cast< AccessibleCheckBoxCell* >( xChild.get() );
 181                                 pCell->SetChecked( m_pTabListBox->IsItemChecked( pEntry, nCol ) );
 182                             }
 183                         }
 184                     }
 185                     break;
 186                 }
 187
 188                 case VCLEVENT_TABLECELL_NAMECHANGED :
 189                 {
 190                     if ( m_pTabListBox->IsTransientChildrenDisabled() )
 191                     {
 192                         commitEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
 193                         TabListBoxEventData* pData = static_cast< TabListBoxEventData* >( rVclWindowEvent.GetData() );
 194                         SvLBoxEntry* pEntry = pData != NULL ? pData->m_pEntry : NULL;
 195                         if ( pEntry )
 196                         {
 197                             sal_Int32 nRow = m_pTabListBox->GetEntryPos( pEntry );
 198                             USHORT nCol = pData->m_nColumn;
 199                             Reference< XAccessible > xChild =
 200                                 m_pTabListBox->CreateAccessibleCell( nRow, nCol );
 201                             uno::Any aOldValue, aNewValue;
 202                             aOldValue <<= ::rtl::OUString( pData->m_sOldText );
 203                             ::rtl::OUString sNewText( m_pTabListBox->GetCellText( nRow, nCol ) );
 204                             aNewValue <<= sNewText;
 205                             TriState eState = STATE_DONTKNOW;
 206
 207                             if ( m_pTabListBox->IsCellCheckBox( nRow, nCol, eState ) )
 208                             {
 209                                 AccessibleCheckBoxCell* pCell =
 210                                     static_cast< AccessibleCheckBoxCell* >( xChild.get() );
 211                                 pCell->commitEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
 212                             }
 213                             else
 214                             {
 215                                 AccessibleBrowseBoxTableCell* pCell =
 216                                     static_cast< AccessibleBrowseBoxTableCell* >( xChild.get() );
 217                                 pCell->nameChanged( sNewText, pData->m_sOldText );
 218                             }
 219                         }
 220                     }
 221                     break;
 222                 }
 223             }
 224         }
 225     }
 226     // -----------------------------------------------------------------------------
 227     IMPL_LINK( AccessibleTabListBoxTable, WindowEventListener, VclSimpleEvent*, pEvent )
 228     {
 229         DBG_ASSERT( pEvent && pEvent->ISA( VclWindowEvent ), "Unknown WindowEvent!" );
 230         if ( pEvent && pEvent->ISA( VclWindowEvent ) )
 231         {
 232             DBG_ASSERT( ( (VclWindowEvent*)pEvent )->GetWindow() && m_pTabListBox, "no event window" );
 233             ProcessWindowEvent( *(VclWindowEvent*)pEvent );
 234         }
 235         return 0;
 236     }
 237     // helpers --------------------------------------------------------------------
 238
 239     void AccessibleTabListBoxTable::ensureValidIndex( sal_Int32 _nIndex ) const
 240             SAL_THROW( ( IndexOutOfBoundsException ) )
 241     {
 242         if ( ( _nIndex < 0 ) || ( _nIndex >= implGetCellCount() ) )
 243             throw IndexOutOfBoundsException();
 244     }
 245
 246     sal_Bool AccessibleTabListBoxTable::implIsRowSelected( sal_Int32 _nRow ) const
 247     {
 248         return m_pTabListBox ? m_pTabListBox->IsSelected( m_pTabListBox->GetEntry( _nRow ) ) : sal_False;
 249     }
 250
 251     void AccessibleTabListBoxTable::implSelectRow( sal_Int32 _nRow, sal_Bool _bSelect )
 252     {
 253         if ( m_pTabListBox )
 254             m_pTabListBox->Select( m_pTabListBox->GetEntry( _nRow ), _bSelect );
 255     }
 256
 257     sal_Int32 AccessibleTabListBoxTable::implGetRowCount() const
 258     {
 259         return m_pTabListBox ? m_pTabListBox->GetEntryCount() : 0;
 260     }
 261
 262     sal_Int32 AccessibleTabListBoxTable::implGetColumnCount() const
 263     {
 264         return m_pTabListBox ? m_pTabListBox->GetColumnCount() : 0;
 265     }
 266
 267     sal_Int32 AccessibleTabListBoxTable::implGetSelRowCount() const
 268     {
 269         return m_pTabListBox ? m_pTabListBox->GetSelectionCount() : 0;
 270     }
 271
 272     sal_Int32 AccessibleTabListBoxTable::implGetSelRow( sal_Int32 nSelRow ) const
 273     {
 274         if ( m_pTabListBox )
 275         {
 276             sal_Int32 nRow = 0;
 277             SvLBoxEntry* pEntry = m_pTabListBox->FirstSelected();
 278             while ( pEntry )
 279             {
 280                 ++nRow;
 281                 if ( nRow == nSelRow )
 282                     return m_pTabListBox->GetEntryPos( pEntry );
 283                 pEntry = m_pTabListBox->NextSelected( pEntry );
 284             }
 285         }
 286
 287         return 0;
 288     }
 289     // -----------------------------------------------------------------------------
 290     // XInterface & XTypeProvider
 291     // -----------------------------------------------------------------------------
 292     IMPLEMENT_FORWARD_XINTERFACE2(AccessibleTabListBoxTable, AccessibleBrowseBoxTable, AccessibleTabListBoxTableImplHelper)
 293     IMPLEMENT_FORWARD_XTYPEPROVIDER2(AccessibleTabListBoxTable, AccessibleBrowseBoxTable, AccessibleTabListBoxTableImplHelper)
 294     // -----------------------------------------------------------------------------
 295     // XServiceInfo
 296     // -----------------------------------------------------------------------------
 297     ::rtl::OUString AccessibleTabListBoxTable::getImplementationName (void) throw (RuntimeException)
 298     {
 299         return ::rtl::OUString::createFromAscii("com.sun.star.comp.svtools.AccessibleTabListBoxTable");
 300     }
 301     // -----------------------------------------------------------------------------
 302     // XAccessibleSelection
 303     // -----------------------------------------------------------------------------
 304     void SAL_CALL AccessibleTabListBoxTable::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 305     {
 306         TLBSolarGuard aSolarGuard;
 307         ::osl::MutexGuard aGuard( getOslMutex() );
 308
 309         ensureIsAlive();
 310         ensureValidIndex( nChildIndex );
 311
 312         implSelectRow( implGetRow( nChildIndex ), sal_True );
 313     }
 314     // -----------------------------------------------------------------------------
 315     sal_Bool SAL_CALL AccessibleTabListBoxTable::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 316     {
 317         TLBSolarGuard aSolarGuard;
 318         ::osl::MutexGuard aGuard( getOslMutex() );
 319
 320         ensureIsAlive();
 321         ensureValidIndex( nChildIndex );
 322
 323         return implIsRowSelected( implGetRow( nChildIndex ) );
 324     }
 325     // -----------------------------------------------------------------------------
 326     void SAL_CALL AccessibleTabListBoxTable::clearAccessibleSelection(  ) throw (RuntimeException)
 327     {
 328         TLBSolarGuard aSolarGuard;
 329         ::osl::MutexGuard aGuard( getOslMutex() );
 330
 331         ensureIsAlive();
 332
 333         m_pTabListBox->SetNoSelection();
 334     }
 335     // -----------------------------------------------------------------------------
 336     void SAL_CALL AccessibleTabListBoxTable::selectAllAccessibleChildren(  ) throw (RuntimeException)
 337     {
 338         TLBSolarGuard aSolarGuard;
 339         ::osl::MutexGuard aGuard( getOslMutex() );
 340
 341         ensureIsAlive();
 342
 343         m_pTabListBox->SelectAll();
 344     }
 345     // -----------------------------------------------------------------------------
 346     sal_Int32 SAL_CALL AccessibleTabListBoxTable::getSelectedAccessibleChildCount(  ) throw (RuntimeException)
 347     {
 348         TLBSolarGuard aSolarGuard;
 349         ::osl::MutexGuard aGuard( getOslMutex() );
 350
 351         ensureIsAlive();
 352
 353         return implGetColumnCount() * implGetSelRowCount();
 354     }
 355     // -----------------------------------------------------------------------------
 356     Reference< XAccessible > SAL_CALL AccessibleTabListBoxTable::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 357     {
 358         TLBSolarGuard aSolarGuard;
 359         ::osl::MutexGuard aGuard( getOslMutex() );
 360
 361         ensureIsAlive();
 362
 363         sal_Int32 nRows = implGetSelRowCount();
 364         if ( nRows == 0 )
 365             throw IndexOutOfBoundsException();
 366
 367         sal_Int32 nRow = implGetSelRow( nSelectedChildIndex % nRows );
 368         sal_Int32 nColumn = nSelectedChildIndex / nRows;
 369         return getAccessibleCellAt( nRow, nColumn );
 370     }
 371     // -----------------------------------------------------------------------------
 372     void SAL_CALL AccessibleTabListBoxTable::deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 373     {
 374         TLBSolarGuard aSolarGuard;
 375         ::osl::MutexGuard aGuard( getOslMutex() );
 376
 377         ensureIsAlive();
 378         ensureValidIndex( nSelectedChildIndex );
 379
 380         implSelectRow( implGetRow( nSelectedChildIndex ), sal_False );
 381     }
 382
 383 //........................................................................
 384 }// namespace accessibility
 385 //........................................................................
 386