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 <memory>
  23 #include <utility>
  24
  25 /* Somehow, under same circumstances, MSVC creates object code for 2
  26  * inlined functions. Nobody here uses them, so simply define them away
  27  * so that there be no dupplicate symbols anymore.
  28
  29  * The symbols "extents" and "indices" come from boost::multi_array.
  30  */
  31
  32 #ifdef indices
  33 #undef indices
  34 #endif
  35 #define indices dummy2_indices
  36
  37 #ifdef extents
  38 #undef extents
  39 #endif
  40 #define extents dummy2_extents
  41
  42 #include "scitems.hxx"
  43 #include <editeng/eeitem.hxx>
  44 #include <tools/gen.hxx>
  45 #include "AccessibleText.hxx"
  46 #include "editsrc.hxx"
  47 #include <svx/AccessibleTextHelper.hxx>
  48 #include "AccessiblePreviewHeaderCell.hxx"
  49 #include "AccessibilityHints.hxx"
  50 #include "prevwsh.hxx"
  51 #include "miscuno.hxx"
  52 #include "prevloc.hxx"
  53 #include "scresid.hxx"
  54 #include "sc.hrc"
  55
  56 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  57 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  58
  59 #include <vcl/window.hxx>
  60 #include <vcl/svapp.hxx>
  61 #include <svl/smplhint.hxx>
  62 #include <unotools/accessiblestatesethelper.hxx>
  63 #include <comphelper/sequence.hxx>
  64 #include <comphelper/servicehelper.hxx>
  65 #include <toolkit/helper/convert.hxx>
  66
  67 #ifdef indices
  68 #undef indices
  69 #endif
  70
  71 #ifdef extents
  72 #undef extents
  73 #endif
  74
  75 using namespace ::com::sun::star;
  76 using namespace ::com::sun::star::accessibility;
  77
  78 //=====  internal  ============================================================
  79
  80 ScAccessiblePreviewHeaderCell::ScAccessiblePreviewHeaderCell( const ::com::sun::star::uno::Reference<
  81                                 ::com::sun::star::accessibility::XAccessible>& rxParent,
  82                             ScPreviewShell* pViewShell,
  83                             const ScAddress& rCellPos, bool bIsColHdr, bool bIsRowHdr,
  84                             sal_Int32 nIndex ) :
  85     ScAccessibleContextBase( rxParent, AccessibleRole::TABLE_CELL ),
  86     mpViewShell( pViewShell ),
  87     mpTextHelper( NULL ),
  88     mnIndex( nIndex ),
  89     maCellPos( rCellPos ),
  90     mbColumnHeader( bIsColHdr ),
  91     mbRowHeader( bIsRowHdr ),
  92     mpTableInfo( NULL )
  93 {
  94     if (mpViewShell)
  95         mpViewShell->AddAccessibilityObject(*this);
  96 }
  97
  98 ScAccessiblePreviewHeaderCell::~ScAccessiblePreviewHeaderCell()
  99 {
 100     if (mpViewShell)
 101         mpViewShell->RemoveAccessibilityObject(*this);
 102 }
 103
 104 void SAL_CALL ScAccessiblePreviewHeaderCell::disposing()
 105 {
 106     SolarMutexGuard aGuard;
 107     if (mpViewShell)
 108     {
 109         mpViewShell->RemoveAccessibilityObject(*this);
 110         mpViewShell = NULL;
 111     }
 112
 113        if (mpTableInfo)
 114         DELETEZ (mpTableInfo);
 115
 116     ScAccessibleContextBase::disposing();
 117 }
 118
 119 //=====  SfxListener  =====================================================
 120
 121 void ScAccessiblePreviewHeaderCell::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
 122 {
 123     const SfxSimpleHint* pSimpleHint = dynamic_cast<const SfxSimpleHint*>(&rHint);
 124     if (pSimpleHint)
 125     {
 126         sal_uLong nId = pSimpleHint->GetId();
 127         if (nId == SC_HINT_ACC_VISAREACHANGED)
 128         {
 129             if (mpTextHelper)
 130                 mpTextHelper->UpdateChildren();
 131         }
 132         else if ( nId == SFX_HINT_DATACHANGED )
 133         {
 134             //  column / row layout may change with any document change,
 135             //  so it must be invalidated
 136             DELETEZ( mpTableInfo );
 137         }
 138     }
 139
 140     ScAccessibleContextBase::Notify(rBC, rHint);
 141 }
 142
 143 //=====  XInterface  =====================================================
 144
 145 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::queryInterface( uno::Type const & rType )
 146     throw (uno::RuntimeException, std::exception)
 147 {
 148     uno::Any aAny (ScAccessiblePreviewHeaderCellImpl::queryInterface(rType));
 149     return aAny.hasValue() ? aAny : ScAccessibleContextBase::queryInterface(rType);
 150 }
 151
 152 void SAL_CALL ScAccessiblePreviewHeaderCell::acquire()
 153     throw ()
 154 {
 155     ScAccessibleContextBase::acquire();
 156 }
 157
 158 void SAL_CALL ScAccessiblePreviewHeaderCell::release()
 159     throw ()
 160 {
 161     ScAccessibleContextBase::release();
 162 }
 163
 164 //=====  XAccessibleValue  ================================================
 165
 166 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getCurrentValue() throw (uno::RuntimeException, std::exception)
 167 {
 168      SolarMutexGuard aGuard;
 169     IsObjectValid();
 170
 171     double fValue(0.0);
 172     if (mbColumnHeader)
 173         fValue = maCellPos.Col();
 174     else
 175         fValue = maCellPos.Row();
 176
 177     uno::Any aAny;
 178     aAny <<= fValue;
 179     return aAny;
 180 }
 181
 182 sal_Bool SAL_CALL ScAccessiblePreviewHeaderCell::setCurrentValue( const uno::Any& /* aNumber */ )
 183                                                                 throw (uno::RuntimeException, std::exception)
 184 {
 185     //  it is not possible to set a value
 186     return false;
 187 }
 188
 189 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMaximumValue() throw (uno::RuntimeException, std::exception)
 190 {
 191      SolarMutexGuard aGuard;
 192     IsObjectValid();
 193
 194     double fValue(0.0);
 195     if (mbColumnHeader)
 196         fValue = MAXCOL;
 197     else
 198         fValue = MAXROW;
 199     uno::Any aAny;
 200     aAny <<= fValue;
 201     return aAny;
 202 }
 203
 204 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMinimumValue() throw (uno::RuntimeException, std::exception)
 205 {
 206     double fValue(0.0);
 207     uno::Any aAny;
 208     aAny <<= fValue;
 209     return aAny;
 210 }
 211
 212 //=====  XAccessibleComponent  ============================================
 213
 214 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleAtPoint( const awt::Point& rPoint )
 215                                 throw (uno::RuntimeException, std::exception)
 216 {
 217     uno::Reference<XAccessible> xRet;
 218     if (containsPoint(rPoint))
 219     {
 220          SolarMutexGuard aGuard;
 221         IsObjectValid();
 222
 223         if(!mpTextHelper)
 224             CreateTextHelper();
 225
 226         xRet = mpTextHelper->GetAt(rPoint);
 227     }
 228
 229     return xRet;
 230 }
 231
 232 void SAL_CALL ScAccessiblePreviewHeaderCell::grabFocus() throw (uno::RuntimeException, std::exception)
 233 {
 234      SolarMutexGuard aGuard;
 235     IsObjectValid();
 236     if (getAccessibleParent().is())
 237     {
 238         uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
 239         if (xAccessibleComponent.is())
 240             xAccessibleComponent->grabFocus();
 241     }
 242 }
 243
 244 //=====  XAccessibleContext  ==============================================
 245
 246 sal_Int32 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleChildCount() throw(uno::RuntimeException, std::exception)
 247 {
 248     SolarMutexGuard aGuard;
 249     IsObjectValid();
 250     if (!mpTextHelper)
 251         CreateTextHelper();
 252     return mpTextHelper->GetChildCount();
 253 }
 254
 255 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleChild(sal_Int32 nIndex)
 256                             throw (uno::RuntimeException, lang::IndexOutOfBoundsException, std::exception)
 257 {
 258     SolarMutexGuard aGuard;
 259     IsObjectValid();
 260     if (!mpTextHelper)
 261         CreateTextHelper();
 262     return mpTextHelper->GetChild(nIndex);
 263 }
 264
 265 sal_Int32 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleIndexInParent() throw (uno::RuntimeException, std::exception)
 266 {
 267     return mnIndex;
 268 }
 269
 270 uno::Reference<XAccessibleStateSet> SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleStateSet()
 271                             throw(uno::RuntimeException, std::exception)
 272 {
 273     SolarMutexGuard aGuard;
 274
 275     uno::Reference<XAccessibleStateSet> xParentStates;
 276     if (getAccessibleParent().is())
 277     {
 278         uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
 279         xParentStates = xParentContext->getAccessibleStateSet();
 280     }
 281     utl::AccessibleStateSetHelper* pStateSet = new utl::AccessibleStateSetHelper();
 282     if (IsDefunc(xParentStates))
 283         pStateSet->AddState(AccessibleStateType::DEFUNC);
 284     else
 285     {
 286         pStateSet->AddState(AccessibleStateType::ENABLED);
 287         pStateSet->AddState(AccessibleStateType::MULTI_LINE);
 288         if (isShowing())
 289             pStateSet->AddState(AccessibleStateType::SHOWING);
 290         pStateSet->AddState(AccessibleStateType::TRANSIENT);
 291         if (isVisible())
 292             pStateSet->AddState(AccessibleStateType::VISIBLE);
 293     }
 294     return pStateSet;
 295 }
 296
 297 //=====  XServiceInfo  ====================================================
 298
 299 OUString SAL_CALL ScAccessiblePreviewHeaderCell::getImplementationName() throw(uno::RuntimeException, std::exception)
 300 {
 301     return OUString("ScAccessiblePreviewHeaderCell");
 302 }
 303
 304 uno::Sequence<OUString> SAL_CALL ScAccessiblePreviewHeaderCell::getSupportedServiceNames()
 305                                                     throw(uno::RuntimeException, std::exception)
 306 {
 307     uno::Sequence< OUString > aSequence = ScAccessibleContextBase::getSupportedServiceNames();
 308     sal_Int32 nOldSize(aSequence.getLength());
 309     aSequence.realloc(nOldSize + 1);
 310
 311     aSequence[nOldSize] = "com.sun.star.table.AccessibleCellView";
 312
 313     return aSequence;
 314 }
 315
 316 //=====  XTypeProvider  =======================================================
 317
 318 uno::Sequence< uno::Type > SAL_CALL ScAccessiblePreviewHeaderCell::getTypes()
 319         throw (uno::RuntimeException, std::exception)
 320 {
 321     return comphelper::concatSequences(ScAccessiblePreviewHeaderCellImpl::getTypes(), ScAccessibleContextBase::getTypes());
 322 }
 323
 324 uno::Sequence<sal_Int8> SAL_CALL
 325     ScAccessiblePreviewHeaderCell::getImplementationId()
 326     throw (uno::RuntimeException, std::exception)
 327 {
 328     return css::uno::Sequence<sal_Int8>();
 329 }
 330
 331 //====  internal  =========================================================
 332
 333 Rectangle ScAccessiblePreviewHeaderCell::GetBoundingBoxOnScreen() const throw (uno::RuntimeException, std::exception)
 334 {
 335     Rectangle aCellRect;
 336
 337     FillTableInfo();
 338
 339     if (mpTableInfo)
 340     {
 341         const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[maCellPos.Col()];
 342         const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[maCellPos.Row()];
 343
 344         aCellRect = Rectangle( rColInfo.nPixelStart, rRowInfo.nPixelStart, rColInfo.nPixelEnd, rRowInfo.nPixelEnd );
 345     }
 346
 347     if (mpViewShell)
 348     {
 349         vcl::Window* pWindow = mpViewShell->GetWindow();
 350         if (pWindow)
 351         {
 352             Rectangle aRect = pWindow->GetWindowExtentsRelative(NULL);
 353             aCellRect.setX(aCellRect.getX() + aRect.getX());
 354             aCellRect.setY(aCellRect.getY() + aRect.getY());
 355         }
 356     }
 357     return aCellRect;
 358 }
 359
 360 Rectangle ScAccessiblePreviewHeaderCell::GetBoundingBox() const throw (uno::RuntimeException, std::exception)
 361 {
 362     FillTableInfo();
 363
 364     if (mpTableInfo)
 365     {
 366         const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[maCellPos.Col()];
 367         const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[maCellPos.Row()];
 368
 369         Rectangle aCellRect( rColInfo.nPixelStart, rRowInfo.nPixelStart, rColInfo.nPixelEnd, rRowInfo.nPixelEnd );
 370         uno::Reference<XAccessible> xAccParent = const_cast<ScAccessiblePreviewHeaderCell*>(this)->getAccessibleParent();
 371         if (xAccParent.is())
 372         {
 373             uno::Reference<XAccessibleContext> xAccParentContext = xAccParent->getAccessibleContext();
 374             uno::Reference<XAccessibleComponent> xAccParentComp (xAccParentContext, uno::UNO_QUERY);
 375             if (xAccParentComp.is())
 376             {
 377                 Rectangle aParentRect (VCLRectangle(xAccParentComp->getBounds()));
 378                 aCellRect.setX(aCellRect.getX() - aParentRect.getX());
 379                 aCellRect.setY(aCellRect.getY() - aParentRect.getY());
 380             }
 381         }
 382         return aCellRect;
 383     }
 384     return Rectangle();
 385 }
 386
 387 OUString SAL_CALL ScAccessiblePreviewHeaderCell::createAccessibleDescription() throw(uno::RuntimeException)
 388 {
 389     OUString sDescription = OUString(ScResId(STR_ACC_HEADERCELL_DESCR));
 390     return sDescription;
 391 }
 392
 393 OUString SAL_CALL ScAccessiblePreviewHeaderCell::createAccessibleName() throw(uno::RuntimeException, std::exception)
 394 {
 395     OUString sName = OUString(ScResId(STR_ACC_HEADERCELL_NAME));
 396
 397     if ( mbColumnHeader )
 398     {
 399         if ( mbRowHeader )
 400         {
 401             //! name for corner cell?
 402
 403 //          sName = "Column/Row Header";
 404         }
 405         else
 406         {
 407             // name of column header
 408             sName += ScColToAlpha( maCellPos.Col() );
 409         }
 410     }
 411     else
 412     {
 413         // name of row header
 414         sName += OUString::number(  ( maCellPos.Row() + 1 ) );
 415     }
 416
 417     return sName;
 418 }
 419
 420 bool ScAccessiblePreviewHeaderCell::IsDefunc( const uno::Reference<XAccessibleStateSet>& rxParentStates )
 421 {
 422     return ScAccessibleContextBase::IsDefunc() || (mpViewShell == NULL) || !getAccessibleParent().is() ||
 423         (rxParentStates.is() && rxParentStates->contains(AccessibleStateType::DEFUNC));
 424 }
 425
 426 void ScAccessiblePreviewHeaderCell::CreateTextHelper()
 427 {
 428     if (!mpTextHelper)
 429     {
 430         ::std::unique_ptr < ScAccessibleTextData > pAccessiblePreviewHeaderCellTextData
 431             (new ScAccessiblePreviewHeaderCellTextData(mpViewShell, OUString(getAccessibleName()), maCellPos, mbColumnHeader, mbRowHeader));
 432         ::std::unique_ptr< SvxEditSource > pEditSource (new ScAccessibilityEditSource(std::move(pAccessiblePreviewHeaderCellTextData)));
 433
 434         mpTextHelper = new ::accessibility::AccessibleTextHelper(std::move(pEditSource));
 435         mpTextHelper->SetEventSource(this);
 436     }
 437 }
 438
 439 void ScAccessiblePreviewHeaderCell::FillTableInfo() const
 440 {
 441     if ( mpViewShell && !mpTableInfo )
 442     {
 443         Size aOutputSize;
 444         vcl::Window* pWindow = mpViewShell->GetWindow();
 445         if ( pWindow )
 446             aOutputSize = pWindow->GetOutputSizePixel();
 447         Point aPoint;
 448         Rectangle aVisRect( aPoint, aOutputSize );
 449
 450         mpTableInfo = new ScPreviewTableInfo;
 451         mpViewShell->GetLocationData().GetTableInfo( aVisRect, *mpTableInfo );
 452     }
 453 }
 454
 455 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */