sc/source/ui/Accessibility/AccessiblePreviewHeaderCell.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 <sal/config.h>
  21
  22 #include <tools/gen.hxx>
  23 #include <AccessibleText.hxx>
  24 #include <editsrc.hxx>
  25 #include <svx/AccessibleTextHelper.hxx>
  26 #include <AccessiblePreviewHeaderCell.hxx>
  27 #include <prevwsh.hxx>
  28 #include <prevloc.hxx>
  29 #include <strings.hxx>
  30
  31 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  32 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  33 #include <comphelper/sequence.hxx>
  34
  35 #include <vcl/window.hxx>
  36 #include <vcl/svapp.hxx>
  37 #include <svl/hint.hxx>
  38 #include <toolkit/helper/convert.hxx>
  39
  40 #ifdef indices
  41 #undef indices
  42 #endif
  43
  44 #ifdef extents
  45 #undef extents
  46 #endif
  47
  48 using namespace ::com::sun::star;
  49 using namespace ::com::sun::star::accessibility;
  50
  51 //=====  internal  ============================================================
  52
  53 ScAccessiblePreviewHeaderCell::ScAccessiblePreviewHeaderCell( const css::uno::Reference<css::accessibility::XAccessible>& rxParent,
  54                             ScPreviewShell* pViewShell,
  55                             const ScAddress& rCellPos, bool bIsColHdr, bool bIsRowHdr,
  56                             sal_Int32 nIndex ) :
  57     ScAccessibleContextBase( rxParent, AccessibleRole::TABLE_CELL ),
  58     mpViewShell( pViewShell ),
  59     mnIndex( nIndex ),
  60     maCellPos( rCellPos ),
  61     mbColumnHeader( bIsColHdr ),
  62     mbRowHeader( bIsRowHdr )
  63 {
  64     if (mpViewShell)
  65         mpViewShell->AddAccessibilityObject(*this);
  66 }
  67
  68 ScAccessiblePreviewHeaderCell::~ScAccessiblePreviewHeaderCell()
  69 {
  70     if (mpViewShell)
  71         mpViewShell->RemoveAccessibilityObject(*this);
  72 }
  73
  74 void SAL_CALL ScAccessiblePreviewHeaderCell::disposing()
  75 {
  76     SolarMutexGuard aGuard;
  77     if (mpViewShell)
  78     {
  79         mpViewShell->RemoveAccessibilityObject(*this);
  80         mpViewShell = nullptr;
  81     }
  82
  83     mpTableInfo.reset();
  84
  85     ScAccessibleContextBase::disposing();
  86 }
  87
  88 //=====  SfxListener  =====================================================
  89
  90 void ScAccessiblePreviewHeaderCell::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
  91 {
  92     const SfxHintId nId = rHint.GetId();
  93     if (nId == SfxHintId::ScAccVisAreaChanged)
  94     {
  95         if (mxTextHelper)
  96             mxTextHelper->UpdateChildren();
  97     }
  98     else if ( nId == SfxHintId::DataChanged )
  99     {
 100         //  column / row layout may change with any document change,
 101         //  so it must be invalidated
 102         mpTableInfo.reset();
 103     }
 104
 105     ScAccessibleContextBase::Notify(rBC, rHint);
 106 }
 107
 108 //=====  XInterface  =====================================================
 109
 110 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::queryInterface( uno::Type const & rType )
 111 {
 112     uno::Any aAny (ScAccessiblePreviewHeaderCellImpl::queryInterface(rType));
 113     return aAny.hasValue() ? aAny : ScAccessibleContextBase::queryInterface(rType);
 114 }
 115
 116 void SAL_CALL ScAccessiblePreviewHeaderCell::acquire()
 117     noexcept
 118 {
 119     ScAccessibleContextBase::acquire();
 120 }
 121
 122 void SAL_CALL ScAccessiblePreviewHeaderCell::release()
 123     noexcept
 124 {
 125     ScAccessibleContextBase::release();
 126 }
 127
 128 //=====  XAccessibleValue  ================================================
 129
 130 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getCurrentValue()
 131 {
 132     SolarMutexGuard aGuard;
 133     IsObjectValid();
 134
 135     double fValue(0.0);
 136     if (mbColumnHeader)
 137         fValue = maCellPos.Col();
 138     else
 139         fValue = maCellPos.Row();
 140
 141     return uno::Any(fValue);
 142 }
 143
 144 sal_Bool SAL_CALL ScAccessiblePreviewHeaderCell::setCurrentValue( const uno::Any& /* aNumber */ )
 145 {
 146     //  it is not possible to set a value
 147     return false;
 148 }
 149
 150 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMaximumValue()
 151 {
 152     SolarMutexGuard aGuard;
 153     IsObjectValid();
 154
 155     double fValue(0.0);
 156     ScDocument& rDoc = mpViewShell->GetDocument();
 157     if (mbColumnHeader)
 158         fValue = rDoc.MaxCol();
 159     else
 160         fValue = rDoc.MaxRow();
 161     return uno::Any(fValue);
 162 }
 163
 164 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMinimumValue()
 165 {
 166     return uno::Any(0.0);
 167 }
 168
 169 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMinimumIncrement()
 170 {
 171     // value can't be changed, s. 'setCurrentValue'
 172     return uno::Any();
 173 }
 174
 175 //=====  XAccessibleComponent  ============================================
 176
 177 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleAtPoint( const awt::Point& rPoint )
 178 {
 179     uno::Reference<XAccessible> xRet;
 180     if (containsPoint(rPoint))
 181     {
 182         SolarMutexGuard aGuard;
 183         IsObjectValid();
 184
 185         if(!mxTextHelper)
 186             CreateTextHelper();
 187
 188         xRet = mxTextHelper->GetAt(rPoint);
 189     }
 190
 191     return xRet;
 192 }
 193
 194 void SAL_CALL ScAccessiblePreviewHeaderCell::grabFocus()
 195 {
 196     SolarMutexGuard aGuard;
 197     IsObjectValid();
 198     if (getAccessibleParent().is())
 199     {
 200         uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
 201         if (xAccessibleComponent.is())
 202             xAccessibleComponent->grabFocus();
 203     }
 204 }
 205
 206 //=====  XAccessibleContext  ==============================================
 207
 208 sal_Int64 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleChildCount()
 209 {
 210     SolarMutexGuard aGuard;
 211     IsObjectValid();
 212     if (!mxTextHelper)
 213         CreateTextHelper();
 214     return mxTextHelper->GetChildCount();
 215 }
 216
 217 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleChild(sal_Int64 nIndex)
 218 {
 219     SolarMutexGuard aGuard;
 220     IsObjectValid();
 221     if (!mxTextHelper)
 222         CreateTextHelper();
 223     return mxTextHelper->GetChild(nIndex);
 224 }
 225
 226 sal_Int64 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleIndexInParent()
 227 {
 228     return mnIndex;
 229 }
 230
 231 sal_Int64 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleStateSet()
 232 {
 233     SolarMutexGuard aGuard;
 234
 235     sal_Int64 nParentStates = 0;
 236     if (getAccessibleParent().is())
 237     {
 238         uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
 239         nParentStates = xParentContext->getAccessibleStateSet();
 240     }
 241     sal_Int64 nStateSet = 0;
 242     if (IsDefunc(nParentStates))
 243         nStateSet |= AccessibleStateType::DEFUNC;
 244     else
 245     {
 246         nStateSet |= AccessibleStateType::ENABLED;
 247         nStateSet |= AccessibleStateType::MULTI_LINE;
 248         if (isShowing())
 249             nStateSet |= AccessibleStateType::SHOWING;
 250         nStateSet |= AccessibleStateType::TRANSIENT;
 251         if (isVisible())
 252             nStateSet |= AccessibleStateType::VISIBLE;
 253     }
 254     return nStateSet;
 255 }
 256
 257 //=====  XServiceInfo  ====================================================
 258
 259 OUString SAL_CALL ScAccessiblePreviewHeaderCell::getImplementationName()
 260 {
 261     return "ScAccessiblePreviewHeaderCell";
 262 }
 263
 264 uno::Sequence<OUString> SAL_CALL ScAccessiblePreviewHeaderCell::getSupportedServiceNames()
 265 {
 266     const css::uno::Sequence<OUString> vals { "com.sun.star.table.AccessibleCellView" };
 267     return comphelper::concatSequences(ScAccessibleContextBase::getSupportedServiceNames(), vals);
 268 }
 269
 270 //=====  XTypeProvider  =======================================================
 271
 272 uno::Sequence< uno::Type > SAL_CALL ScAccessiblePreviewHeaderCell::getTypes()
 273 {
 274     return comphelper::concatSequences(ScAccessiblePreviewHeaderCellImpl::getTypes(), ScAccessibleContextBase::getTypes());
 275 }
 276
 277 uno::Sequence<sal_Int8> SAL_CALL
 278     ScAccessiblePreviewHeaderCell::getImplementationId()
 279 {
 280     return css::uno::Sequence<sal_Int8>();
 281 }
 282
 283 //====  internal  =========================================================
 284
 285 tools::Rectangle ScAccessiblePreviewHeaderCell::GetBoundingBoxOnScreen() const
 286 {
 287     tools::Rectangle aCellRect;
 288
 289     FillTableInfo();
 290
 291     if (mpTableInfo)
 292     {
 293         const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[maCellPos.Col()];
 294         const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[maCellPos.Row()];
 295
 296         aCellRect = tools::Rectangle( rColInfo.nPixelStart, rRowInfo.nPixelStart, rColInfo.nPixelEnd, rRowInfo.nPixelEnd );
 297     }
 298
 299     if (mpViewShell)
 300     {
 301         vcl::Window* pWindow = mpViewShell->GetWindow();
 302         if (pWindow)
 303         {
 304             tools::Rectangle aRect = pWindow->GetWindowExtentsRelative(nullptr);
 305             aCellRect.Move(aRect.Left(), aRect.Top());
 306         }
 307     }
 308     return aCellRect;
 309 }
 310
 311 tools::Rectangle ScAccessiblePreviewHeaderCell::GetBoundingBox() const
 312 {
 313     FillTableInfo();
 314
 315     if (mpTableInfo)
 316     {
 317         const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[maCellPos.Col()];
 318         const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[maCellPos.Row()];
 319
 320         tools::Rectangle aCellRect( rColInfo.nPixelStart, rRowInfo.nPixelStart, rColInfo.nPixelEnd, rRowInfo.nPixelEnd );
 321         uno::Reference<XAccessible> xAccParent = const_cast<ScAccessiblePreviewHeaderCell*>(this)->getAccessibleParent();
 322         if (xAccParent.is())
 323         {
 324             uno::Reference<XAccessibleContext> xAccParentContext = xAccParent->getAccessibleContext();
 325             uno::Reference<XAccessibleComponent> xAccParentComp (xAccParentContext, uno::UNO_QUERY);
 326             if (xAccParentComp.is())
 327             {
 328                 tools::Rectangle aParentRect (VCLRectangle(xAccParentComp->getBounds()));
 329                 aCellRect.Move(-aParentRect.Left(), -aParentRect.Top());
 330             }
 331         }
 332         return aCellRect;
 333     }
 334     return tools::Rectangle();
 335 }
 336
 337 OUString ScAccessiblePreviewHeaderCell::createAccessibleDescription()
 338 {
 339     return STR_ACC_HEADERCELL_DESCR;
 340 }
 341
 342 OUString ScAccessiblePreviewHeaderCell::createAccessibleName()
 343 {
 344     OUString sName = STR_ACC_HEADERCELL_NAME;
 345
 346     if ( mbColumnHeader )
 347     {
 348         if ( mbRowHeader )
 349         {
 350             //! name for corner cell?
 351
 352 //          sName = "Column/Row Header";
 353         }
 354         else
 355         {
 356             // name of column header
 357             sName += ScColToAlpha( maCellPos.Col() );
 358         }
 359     }
 360     else
 361     {
 362         // name of row header
 363         sName += OUString::number(  maCellPos.Row() + 1 );
 364     }
 365
 366     return sName;
 367 }
 368
 369 bool ScAccessiblePreviewHeaderCell::IsDefunc( sal_Int64 nParentStates )
 370 {
 371     return ScAccessibleContextBase::IsDefunc() || (mpViewShell == nullptr) || !getAccessibleParent().is() ||
 372         (nParentStates & AccessibleStateType::DEFUNC);
 373 }
 374
 375 void ScAccessiblePreviewHeaderCell::CreateTextHelper()
 376 {
 377     if (!mxTextHelper)
 378     {
 379         mxTextHelper.reset( new ::accessibility::AccessibleTextHelper(
 380             std::make_unique<ScAccessibilityEditSource>(
 381                 std::make_unique<ScAccessiblePreviewHeaderCellTextData>(
 382                     mpViewShell, getAccessibleName(), maCellPos,
 383                     mbColumnHeader, mbRowHeader))) );
 384         mxTextHelper->SetEventSource(this);
 385     }
 386 }
 387
 388 void ScAccessiblePreviewHeaderCell::FillTableInfo() const
 389 {
 390     if ( mpViewShell && !mpTableInfo )
 391     {
 392         Size aOutputSize;
 393         vcl::Window* pWindow = mpViewShell->GetWindow();
 394         if ( pWindow )
 395             aOutputSize = pWindow->GetOutputSizePixel();
 396         tools::Rectangle aVisRect( Point(), aOutputSize );
 397
 398         mpTableInfo.reset( new ScPreviewTableInfo );
 399         mpViewShell->GetLocationData().GetTableInfo( aVisRect, *mpTableInfo );
 400     }
 401 }
 402
 403 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */