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