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