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