accessibility/source/extended/AccessibleBrowseBoxTableBase.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: AccessibleBrowseBoxTableBase.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
  34
  35 #include "accessibility/extended/AccessibleBrowseBoxTableBase.hxx"
  36 #include <svtools/accessibletableprovider.hxx>
  37 #include <tools/multisel.hxx>
  38 #include <comphelper/sequence.hxx>
  39
  40 // ============================================================================
  41
  42 using ::rtl::OUString;
  43
  44 using ::com::sun::star::uno::Reference;
  45 using ::com::sun::star::uno::Sequence;
  46 using ::com::sun::star::uno::Any;
  47
  48 using namespace ::com::sun::star;
  49 using namespace ::com::sun::star::accessibility;
  50 using namespace ::svt;
  51
  52 // ============================================================================
  53
  54 namespace accessibility {
  55
  56 // ============================================================================
  57
  58 // Ctor/Dtor/disposing --------------------------------------------------------
  59
  60 DBG_NAME( AccessibleBrowseBoxTableBase )
  61
  62 AccessibleBrowseBoxTableBase::AccessibleBrowseBoxTableBase(
  63         const Reference< XAccessible >& rxParent,
  64         IAccessibleTableProvider&                      rBrowseBox,
  65         AccessibleBrowseBoxObjType      eObjType ) :
  66     BrowseBoxAccessibleElement( rxParent, rBrowseBox,NULL, eObjType )
  67 {
  68     DBG_CTOR( AccessibleBrowseBoxTableBase, NULL );
  69 }
  70
  71 AccessibleBrowseBoxTableBase::~AccessibleBrowseBoxTableBase()
  72 {
  73     DBG_DTOR( AccessibleBrowseBoxTableBase, NULL );
  74 }
  75
  76 // XAccessibleContext ---------------------------------------------------------
  77
  78 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleChildCount()
  79     throw ( uno::RuntimeException )
  80 {
  81     BBSolarGuard aSolarGuard;
  82     ::osl::MutexGuard aGuard( getOslMutex() );
  83     ensureIsAlive();
  84     return implGetChildCount();
  85 }
  86
  87 sal_Int16 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleRole()
  88     throw ( uno::RuntimeException )
  89 {
  90     ensureIsAlive();
  91     return AccessibleRole::TABLE;
  92 }
  93
  94 // XAccessibleTable -----------------------------------------------------------
  95
  96 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleRowCount()
  97     throw ( uno::RuntimeException )
  98 {
  99     BBSolarGuard aSolarGuard;
 100     ::osl::MutexGuard aGuard( getOslMutex() );
 101     ensureIsAlive();
 102     return implGetRowCount();
 103 }
 104
 105 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleColumnCount()
 106     throw ( uno::RuntimeException )
 107 {
 108     BBSolarGuard aSolarGuard;
 109     ::osl::MutexGuard aGuard( getOslMutex() );
 110     ensureIsAlive();
 111     return implGetColumnCount();
 112 }
 113
 114 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleRowExtentAt(
 115         sal_Int32 nRow, sal_Int32 nColumn )
 116     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 117 {
 118     BBSolarGuard aSolarGuard;
 119     ::osl::MutexGuard aGuard( getOslMutex() );
 120     ensureIsAlive();
 121     ensureIsValidAddress( nRow, nColumn );
 122     return 1;   // merged cells not supported
 123 }
 124
 125 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleColumnExtentAt(
 126         sal_Int32 nRow, sal_Int32 nColumn )
 127     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 128 {
 129     BBSolarGuard aSolarGuard;
 130     ::osl::MutexGuard aGuard( getOslMutex() );
 131     ensureIsAlive();
 132     ensureIsValidAddress( nRow, nColumn );
 133     return 1;   // merged cells not supported
 134 }
 135
 136 Reference< XAccessible > SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleCaption()
 137     throw ( uno::RuntimeException )
 138 {
 139     ensureIsAlive();
 140     return NULL;    // not supported
 141 }
 142
 143 Reference< XAccessible > SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleSummary()
 144     throw ( uno::RuntimeException )
 145 {
 146     ensureIsAlive();
 147     return NULL;    // not supported
 148 }
 149
 150 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleIndex(
 151         sal_Int32 nRow, sal_Int32 nColumn )
 152     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 153 {
 154     BBSolarGuard aSolarGuard;
 155     ::osl::MutexGuard aGuard( getOslMutex() );
 156     ensureIsAlive();
 157     ensureIsValidAddress( nRow, nColumn );
 158     return implGetChildIndex( nRow, nColumn );
 159 }
 160
 161 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleRow( sal_Int32 nChildIndex )
 162     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 163 {
 164     BBSolarGuard aSolarGuard;
 165     ::osl::MutexGuard aGuard( getOslMutex() );
 166     ensureIsAlive();
 167     ensureIsValidIndex( nChildIndex );
 168     return implGetRow( nChildIndex );
 169 }
 170
 171 sal_Int32 SAL_CALL AccessibleBrowseBoxTableBase::getAccessibleColumn( sal_Int32 nChildIndex )
 172     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 173 {
 174     BBSolarGuard aSolarGuard;
 175     ::osl::MutexGuard aGuard( getOslMutex() );
 176     ensureIsAlive();
 177     ensureIsValidIndex( nChildIndex );
 178     return implGetColumn( nChildIndex );
 179 }
 180
 181 // XInterface -----------------------------------------------------------------
 182
 183 Any SAL_CALL AccessibleBrowseBoxTableBase::queryInterface( const uno::Type& rType )
 184     throw ( uno::RuntimeException )
 185 {
 186     Any aAny( BrowseBoxAccessibleElement::queryInterface( rType ) );
 187     return aAny.hasValue() ?
 188         aAny : AccessibleBrowseBoxTableImplHelper::queryInterface( rType );
 189 }
 190
 191 void SAL_CALL AccessibleBrowseBoxTableBase::acquire() throw ()
 192 {
 193     BrowseBoxAccessibleElement::acquire();
 194 }
 195
 196 void SAL_CALL AccessibleBrowseBoxTableBase::release() throw ()
 197 {
 198     BrowseBoxAccessibleElement::release();
 199 }
 200
 201 // XTypeProvider --------------------------------------------------------------
 202
 203 Sequence< uno::Type > SAL_CALL AccessibleBrowseBoxTableBase::getTypes()
 204     throw ( uno::RuntimeException )
 205 {
 206     return ::comphelper::concatSequences(
 207         BrowseBoxAccessibleElement::getTypes(),
 208         AccessibleBrowseBoxTableImplHelper::getTypes() );
 209 }
 210
 211 Sequence< sal_Int8 > SAL_CALL AccessibleBrowseBoxTableBase::getImplementationId()
 212     throw ( uno::RuntimeException )
 213 {
 214     ::osl::MutexGuard aGuard( getOslGlobalMutex() );
 215     static Sequence< sal_Int8 > aId;
 216     implCreateUuid( aId );
 217     return aId;
 218 }
 219
 220 // internal virtual methods ---------------------------------------------------
 221
 222 sal_Int32 AccessibleBrowseBoxTableBase::implGetRowCount() const
 223 {
 224     return mpBrowseBox->GetRowCount();
 225 }
 226
 227 sal_Int32 AccessibleBrowseBoxTableBase::implGetColumnCount() const
 228 {
 229     sal_uInt16 nColumns = mpBrowseBox->GetColumnCount();
 230     // do not count the "handle column"
 231     if( nColumns && implHasHandleColumn() )
 232         --nColumns;
 233     return nColumns;
 234 }
 235
 236 // internal helper methods ----------------------------------------------------
 237
 238 sal_Bool AccessibleBrowseBoxTableBase::implHasHandleColumn() const
 239 {
 240     return mpBrowseBox->HasRowHeader();
 241 }
 242
 243 sal_uInt16 AccessibleBrowseBoxTableBase::implToVCLColumnPos( sal_Int32 nColumn ) const
 244 {
 245     sal_uInt16 nVCLPos = 0;
 246     if( (0 <= nColumn) && (nColumn < implGetColumnCount()) )
 247     {
 248         // regard "handle column"
 249         if( implHasHandleColumn() )
 250             ++nColumn;
 251         nVCLPos = static_cast< sal_uInt16 >( nColumn );
 252     }
 253     return nVCLPos;
 254 }
 255
 256 sal_Int32 AccessibleBrowseBoxTableBase::implGetChildCount() const
 257 {
 258     return implGetRowCount() * implGetColumnCount();
 259 }
 260
 261 sal_Int32 AccessibleBrowseBoxTableBase::implGetRow( sal_Int32 nChildIndex ) const
 262 {
 263     sal_Int32 nColumns = implGetColumnCount();
 264     return nColumns ? (nChildIndex / nColumns) : 0;
 265 }
 266
 267 sal_Int32 AccessibleBrowseBoxTableBase::implGetColumn( sal_Int32 nChildIndex ) const
 268 {
 269     sal_Int32 nColumns = implGetColumnCount();
 270     return nColumns ? (nChildIndex % nColumns) : 0;
 271 }
 272
 273 sal_Int32 AccessibleBrowseBoxTableBase::implGetChildIndex(
 274         sal_Int32 nRow, sal_Int32 nColumn ) const
 275 {
 276     return nRow * implGetColumnCount() + nColumn;
 277 }
 278
 279 sal_Bool AccessibleBrowseBoxTableBase::implIsRowSelected( sal_Int32 nRow ) const
 280 {
 281     return mpBrowseBox->IsRowSelected( nRow );
 282 }
 283
 284 sal_Bool AccessibleBrowseBoxTableBase::implIsColumnSelected( sal_Int32 nColumn ) const
 285 {
 286     if( implHasHandleColumn() )
 287         --nColumn;
 288     return mpBrowseBox->IsColumnSelected( nColumn );
 289 }
 290
 291 void AccessibleBrowseBoxTableBase::implSelectRow( sal_Int32 nRow, sal_Bool bSelect )
 292 {
 293     mpBrowseBox->SelectRow( nRow, bSelect, sal_True );
 294 }
 295
 296 void AccessibleBrowseBoxTableBase::implSelectColumn( sal_Int32 nColumnPos, sal_Bool bSelect )
 297 {
 298     mpBrowseBox->SelectColumn( (sal_uInt16)nColumnPos, bSelect );
 299 }
 300
 301 sal_Int32 AccessibleBrowseBoxTableBase::implGetSelectedRowCount() const
 302 {
 303     return mpBrowseBox->GetSelectedRowCount();
 304 }
 305
 306 sal_Int32 AccessibleBrowseBoxTableBase::implGetSelectedColumnCount() const
 307 {
 308     return mpBrowseBox->GetSelectedColumnCount();
 309 }
 310
 311 void AccessibleBrowseBoxTableBase::implGetSelectedRows( Sequence< sal_Int32 >& rSeq )
 312 {
 313     mpBrowseBox->GetAllSelectedRows( rSeq );
 314 }
 315
 316 void AccessibleBrowseBoxTableBase::implGetSelectedColumns( Sequence< sal_Int32 >& rSeq )
 317 {
 318     mpBrowseBox->GetAllSelectedColumns( rSeq );
 319 }
 320
 321 void AccessibleBrowseBoxTableBase::ensureIsValidRow( sal_Int32 nRow )
 322     throw ( lang::IndexOutOfBoundsException )
 323 {
 324     if( nRow >= implGetRowCount() )
 325         throw lang::IndexOutOfBoundsException(
 326             OUString( RTL_CONSTASCII_USTRINGPARAM( "row index is invalid" ) ), *this );
 327 }
 328
 329 void AccessibleBrowseBoxTableBase::ensureIsValidColumn( sal_Int32 nColumn )
 330     throw ( lang::IndexOutOfBoundsException )
 331 {
 332     if( nColumn >= implGetColumnCount() )
 333         throw lang::IndexOutOfBoundsException(
 334             OUString( RTL_CONSTASCII_USTRINGPARAM("column index is invalid") ), *this );
 335 }
 336
 337 void AccessibleBrowseBoxTableBase::ensureIsValidAddress(
 338         sal_Int32 nRow, sal_Int32 nColumn )
 339     throw ( lang::IndexOutOfBoundsException )
 340 {
 341     ensureIsValidRow( nRow );
 342     ensureIsValidColumn( nColumn );
 343 }
 344
 345 void AccessibleBrowseBoxTableBase::ensureIsValidIndex( sal_Int32 nChildIndex )
 346     throw ( lang::IndexOutOfBoundsException )
 347 {
 348     if( nChildIndex >= implGetChildCount() )
 349         throw lang::IndexOutOfBoundsException(
 350             OUString( RTL_CONSTASCII_USTRINGPARAM("child index is invalid") ), *this );
 351 }
 352
 353 // ============================================================================
 354
 355 } // namespace accessibility
 356
 357 // ============================================================================
 358