accessibility/source/extended/AccessibleBrowseBoxHeaderBar.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: AccessibleBrowseBoxHeaderBar.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/AccessibleBrowseBoxHeaderBar.hxx"
  36 #include <svtools/accessibletableprovider.hxx>
  37
  38 // ============================================================================
  39
  40 using ::rtl::OUString;
  41
  42 using ::com::sun::star::uno::Reference;
  43 using ::com::sun::star::uno::Sequence;
  44 using ::com::sun::star::uno::Any;
  45
  46 using namespace ::com::sun::star;
  47 using namespace ::com::sun::star::accessibility;
  48 using namespace ::svt;
  49
  50 // ============================================================================
  51
  52 namespace accessibility {
  53
  54 // ============================================================================
  55
  56 // Ctor/Dtor/disposing --------------------------------------------------------
  57
  58 DBG_NAME( AccessibleBrowseBoxHeaderBar )
  59
  60 AccessibleBrowseBoxHeaderBar::AccessibleBrowseBoxHeaderBar(
  61         const Reference< XAccessible >& rxParent,
  62         IAccessibleTableProvider&                      rBrowseBox,
  63         AccessibleBrowseBoxObjType      eObjType ) :
  64     AccessibleBrowseBoxTableBase( rxParent, rBrowseBox,eObjType )
  65 {
  66     DBG_CTOR( AccessibleBrowseBoxHeaderBar, NULL );
  67
  68     DBG_ASSERT( isRowBar() || isColumnBar(),
  69         "accessibility/extended/AccessibleBrowseBoxHeaderBar - invalid object type" );
  70 }
  71
  72 AccessibleBrowseBoxHeaderBar::~AccessibleBrowseBoxHeaderBar()
  73 {
  74     DBG_DTOR( AccessibleBrowseBoxHeaderBar, NULL );
  75 }
  76
  77 // XAccessibleContext ---------------------------------------------------------
  78
  79 Reference< XAccessible > SAL_CALL
  80 AccessibleBrowseBoxHeaderBar::getAccessibleChild( sal_Int32 nChildIndex )
  81     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
  82 {
  83     BBSolarGuard aSolarGuard;
  84     ::osl::MutexGuard aGuard( getOslMutex() );
  85     ensureIsAlive();
  86     ensureIsValidHeaderIndex( nChildIndex );
  87     return implGetChild( nChildIndex, implToVCLColumnPos( nChildIndex ) );
  88 }
  89
  90 sal_Int32 SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleIndexInParent()
  91     throw ( uno::RuntimeException )
  92 {
  93     return isRowBar() ? BBINDEX_ROWHEADERBAR : BBINDEX_COLUMNHEADERBAR;
  94 }
  95
  96 // XAccessibleComponent -------------------------------------------------------
  97
  98 Reference< XAccessible > SAL_CALL
  99 AccessibleBrowseBoxHeaderBar::getAccessibleAtPoint( const awt::Point& rPoint )
 100     throw ( uno::RuntimeException )
 101 {
 102     BBSolarGuard aSolarGuard;
 103     ::osl::MutexGuard aGuard( getOslMutex() );
 104     ensureIsAlive();
 105
 106     sal_Int32 nRow = 0;
 107     sal_uInt16 nColumnPos = 0;
 108     sal_Bool bConverted = isRowBar() ?
 109         mpBrowseBox->ConvertPointToRowHeader( nRow, VCLPoint( rPoint ) ) :
 110         mpBrowseBox->ConvertPointToColumnHeader( nColumnPos, VCLPoint( rPoint ) );
 111
 112     return bConverted ? implGetChild( nRow, nColumnPos ) : Reference< XAccessible >();
 113 }
 114
 115 void SAL_CALL AccessibleBrowseBoxHeaderBar::grabFocus()
 116     throw ( uno::RuntimeException )
 117 {
 118     ensureIsAlive();
 119     // focus on header not supported
 120 }
 121
 122 Any SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleKeyBinding()
 123     throw ( uno::RuntimeException )
 124 {
 125     ensureIsAlive();
 126     return Any();   // no special key bindings for header
 127 }
 128
 129 // XAccessibleTable -----------------------------------------------------------
 130
 131 OUString SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleRowDescription( sal_Int32 nRow )
 132     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 133 {
 134     BBSolarGuard aSolarGuard;
 135     ::osl::MutexGuard aGuard( getOslMutex() );
 136     ensureIsAlive();
 137     ensureIsValidRow( nRow );
 138     return OUString();  // no headers in headers
 139 }
 140
 141 OUString SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleColumnDescription( sal_Int32 nColumn )
 142     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 143 {
 144     BBSolarGuard aSolarGuard;
 145     ::osl::MutexGuard aGuard( getOslMutex() );
 146     ensureIsAlive();
 147     ensureIsValidColumn( nColumn );
 148     return OUString();  // no headers in headers
 149 }
 150
 151 Reference< XAccessibleTable > SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleRowHeaders()
 152     throw ( uno::RuntimeException )
 153 {
 154     ensureIsAlive();
 155     return NULL;        // no headers in headers
 156 }
 157
 158 Reference< XAccessibleTable > SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleColumnHeaders()
 159     throw ( uno::RuntimeException )
 160 {
 161     ensureIsAlive();
 162     return NULL;        // no headers in headers
 163 }
 164
 165 Sequence< sal_Int32 > SAL_CALL AccessibleBrowseBoxHeaderBar::getSelectedAccessibleRows()
 166     throw ( uno::RuntimeException )
 167 {
 168     BBSolarGuard aSolarGuard;
 169     ::osl::MutexGuard aGuard( getOslMutex() );
 170     ensureIsAlive();
 171
 172     Sequence< sal_Int32 > aSelSeq;
 173     // row of column header bar not selectable
 174     if( isRowBar() )
 175         implGetSelectedRows( aSelSeq );
 176     return aSelSeq;
 177 }
 178
 179 Sequence< sal_Int32 > SAL_CALL AccessibleBrowseBoxHeaderBar::getSelectedAccessibleColumns()
 180     throw ( uno::RuntimeException )
 181 {
 182     BBSolarGuard aSolarGuard;
 183     ::osl::MutexGuard aGuard( getOslMutex() );
 184     ensureIsAlive();
 185
 186     Sequence< sal_Int32 > aSelSeq;
 187     // column of row header bar ("handle column") not selectable
 188     if( isColumnBar() )
 189         implGetSelectedColumns( aSelSeq );
 190     return aSelSeq;
 191 }
 192
 193 sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleRowSelected( sal_Int32 nRow )
 194     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 195 {
 196     BBSolarGuard aSolarGuard;
 197     ::osl::MutexGuard aGuard( getOslMutex() );
 198     ensureIsAlive();
 199     ensureIsValidRow( nRow );
 200     return isRowBar() ? implIsRowSelected( nRow ) : sal_False;
 201 }
 202
 203 sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleColumnSelected( sal_Int32 nColumn )
 204     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 205 {
 206     BBSolarGuard aSolarGuard;
 207     ::osl::MutexGuard aGuard( getOslMutex() );
 208     ensureIsAlive();
 209     ensureIsValidColumn( nColumn );
 210     return isColumnBar() ? implIsColumnSelected( nColumn ) : sal_False;
 211 }
 212
 213 Reference< XAccessible > SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleCellAt(
 214         sal_Int32 nRow, sal_Int32 nColumn )
 215     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 216 {
 217     BBSolarGuard aSolarGuard;
 218     ::osl::MutexGuard aGuard( getOslMutex() );
 219     ensureIsAlive();
 220     ensureIsValidAddress( nRow, nColumn );
 221     return implGetChild( nRow, implToVCLColumnPos( nColumn ) );
 222 }
 223
 224 sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleSelected(
 225         sal_Int32 nRow, sal_Int32 nColumn )
 226     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 227 {
 228     BBSolarGuard aSolarGuard;
 229     ::osl::MutexGuard aGuard( getOslMutex() );
 230     ensureIsAlive();
 231     ensureIsValidAddress( nRow, nColumn );
 232     return isRowBar() ? implIsRowSelected( nRow ) : implIsColumnSelected( nColumn );
 233 }
 234
 235 // XAccessibleSelection -------------------------------------------------------
 236
 237 void SAL_CALL AccessibleBrowseBoxHeaderBar::selectAccessibleChild( sal_Int32 nChildIndex )
 238     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 239 {
 240     BBSolarGuard aSolarGuard;
 241     ::osl::MutexGuard aGuard( getOslMutex() );
 242     ensureIsAlive();
 243     ensureIsValidHeaderIndex( nChildIndex );
 244     if( isRowBar() )
 245         implSelectRow( nChildIndex, sal_True );
 246     else
 247         implSelectColumn( implToVCLColumnPos( nChildIndex ), sal_True );
 248 }
 249
 250 sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleChildSelected( sal_Int32 nChildIndex )
 251     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 252 {
 253     // using interface methods - no mutex
 254     return isRowBar() ?
 255         isAccessibleRowSelected( nChildIndex ) :
 256         isAccessibleColumnSelected( nChildIndex );
 257 }
 258
 259 void SAL_CALL AccessibleBrowseBoxHeaderBar::clearAccessibleSelection()
 260     throw ( uno::RuntimeException )
 261 {
 262     BBSolarGuard aSolarGuard;
 263     ::osl::MutexGuard aGuard( getOslMutex() );
 264     ensureIsAlive();
 265     mpBrowseBox->SetNoSelection();
 266 }
 267
 268 void SAL_CALL AccessibleBrowseBoxHeaderBar::selectAllAccessibleChildren()
 269     throw ( uno::RuntimeException )
 270 {
 271     BBSolarGuard aSolarGuard;
 272     ::osl::MutexGuard aGuard( getOslMutex() );
 273     ensureIsAlive();
 274     // no multiselection of columns possible
 275     if( isRowBar() )
 276         mpBrowseBox->SelectAll();
 277     else
 278         implSelectColumn( implToVCLColumnPos( 0 ), sal_True );
 279 }
 280
 281 sal_Int32 SAL_CALL AccessibleBrowseBoxHeaderBar::getSelectedAccessibleChildCount()
 282     throw ( uno::RuntimeException )
 283 {
 284     BBSolarGuard aSolarGuard;
 285     ::osl::MutexGuard aGuard( getOslMutex() );
 286     ensureIsAlive();
 287     return isRowBar() ? implGetSelectedRowCount() : implGetSelectedColumnCount();
 288 }
 289
 290 Reference< XAccessible > SAL_CALL
 291 AccessibleBrowseBoxHeaderBar::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex )
 292     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 293 {
 294     BBSolarGuard aSolarGuard;
 295     ::osl::MutexGuard aGuard( getOslMutex() );
 296     ensureIsAlive();
 297
 298     // method may throw lang::IndexOutOfBoundsException
 299     sal_Int32 nIndex = implGetChildIndexFromSelectedIndex( nSelectedChildIndex );
 300     return implGetChild( nIndex, implToVCLColumnPos( nIndex ) );
 301 }
 302
 303 void SAL_CALL AccessibleBrowseBoxHeaderBar::deselectAccessibleChild(
 304         sal_Int32 nSelectedChildIndex )
 305     throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
 306 {
 307     BBSolarGuard aSolarGuard;
 308     ::osl::MutexGuard aGuard( getOslMutex() );
 309     ensureIsAlive();
 310
 311     // method may throw lang::IndexOutOfBoundsException
 312     if ( isAccessibleChildSelected(nSelectedChildIndex) )
 313     {
 314         if( isRowBar() )
 315             implSelectRow( nSelectedChildIndex, sal_False );
 316         else
 317             implSelectColumn( implToVCLColumnPos( nSelectedChildIndex ), sal_False );
 318     }
 319 }
 320
 321 // XInterface -----------------------------------------------------------------
 322
 323 Any SAL_CALL AccessibleBrowseBoxHeaderBar::queryInterface( const uno::Type& rType )
 324     throw ( uno::RuntimeException )
 325 {
 326     Any aAny( AccessibleBrowseBoxTableBase::queryInterface( rType ) );
 327     return aAny.hasValue() ?
 328         aAny : AccessibleBrowseBoxHeaderBarImplHelper::queryInterface( rType );
 329 }
 330
 331 void SAL_CALL AccessibleBrowseBoxHeaderBar::acquire() throw ()
 332 {
 333     AccessibleBrowseBoxTableBase::acquire();
 334 }
 335
 336 void SAL_CALL AccessibleBrowseBoxHeaderBar::release() throw ()
 337 {
 338     AccessibleBrowseBoxTableBase::release();
 339 }
 340
 341 // XServiceInfo ---------------------------------------------------------------
 342
 343 OUString SAL_CALL AccessibleBrowseBoxHeaderBar::getImplementationName()
 344     throw ( uno::RuntimeException )
 345 {
 346     return OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.svtools.AccessibleBrowseBoxHeaderBar" ) );
 347 }
 348
 349 Sequence< sal_Int8 > SAL_CALL AccessibleBrowseBoxHeaderBar::getImplementationId()
 350     throw ( uno::RuntimeException )
 351 {
 352     ::osl::MutexGuard aGuard( getOslGlobalMutex() );
 353     static Sequence< sal_Int8 > aId;
 354     implCreateUuid( aId );
 355     return aId;
 356 }
 357
 358 // internal virtual methods ---------------------------------------------------
 359
 360 Rectangle AccessibleBrowseBoxHeaderBar::implGetBoundingBox()
 361 {
 362     return mpBrowseBox->calcHeaderRect(isColumnBar(),FALSE);
 363 }
 364
 365 Rectangle AccessibleBrowseBoxHeaderBar::implGetBoundingBoxOnScreen()
 366 {
 367     return mpBrowseBox->calcHeaderRect(isColumnBar(),TRUE);
 368 }
 369
 370 sal_Int32 AccessibleBrowseBoxHeaderBar::implGetRowCount() const
 371 {
 372     // column header bar: only 1 row
 373     return isRowBar() ? AccessibleBrowseBoxTableBase::implGetRowCount() : 1;
 374 }
 375
 376 sal_Int32 AccessibleBrowseBoxHeaderBar::implGetColumnCount() const
 377 {
 378     // row header bar ("handle column"): only 1 column
 379     return isColumnBar() ? AccessibleBrowseBoxTableBase::implGetColumnCount() : 1;
 380 }
 381
 382 // internal helper methods ----------------------------------------------------
 383
 384 Reference< XAccessible > AccessibleBrowseBoxHeaderBar::implGetChild(
 385         sal_Int32 nRow, sal_uInt16 nColumnPos )
 386 {
 387     return isRowBar() ?
 388         mpBrowseBox->CreateAccessibleRowHeader( nRow ) :
 389         mpBrowseBox->CreateAccessibleColumnHeader( nColumnPos );
 390 }
 391
 392 sal_Int32 AccessibleBrowseBoxHeaderBar::implGetChildIndexFromSelectedIndex(
 393         sal_Int32 nSelectedChildIndex )
 394     throw ( lang::IndexOutOfBoundsException )
 395 {
 396     Sequence< sal_Int32 > aSelSeq;
 397     if( isRowBar() )
 398         implGetSelectedRows( aSelSeq );
 399     else
 400         implGetSelectedColumns( aSelSeq );
 401
 402     if( (nSelectedChildIndex < 0) || (nSelectedChildIndex >= aSelSeq.getLength()) )
 403         throw lang::IndexOutOfBoundsException();
 404
 405     return aSelSeq[ nSelectedChildIndex ];
 406 }
 407
 408 void AccessibleBrowseBoxHeaderBar::ensureIsValidHeaderIndex( sal_Int32 nIndex )
 409     throw ( lang::IndexOutOfBoundsException )
 410 {
 411     if( isRowBar() )
 412         ensureIsValidRow( nIndex );
 413     else
 414         ensureIsValidColumn( nIndex );
 415 }
 416
 417 // ============================================================================
 418
 419 } // namespace accessibility
 420
 421 // ============================================================================
 422