sc/source/ui/Accessibility/AccessiblePreviewCell.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 #include "scitems.hxx"
  26 #include <editeng/eeitem.hxx>
  27 #include <tools/gen.hxx>
  28 #include "AccessibleText.hxx"
  29 #include "editsrc.hxx"
  30 #include "AccessiblePreviewCell.hxx"
  31 #include "AccessibilityHints.hxx"
  32 #include "prevwsh.hxx"
  33 #include "prevloc.hxx"
  34 #include "document.hxx"
  35 #include <svx/AccessibleTextHelper.hxx>
  36 #include <unotools/accessiblestatesethelper.hxx>
  37 #include <editeng/brushitem.hxx>
  38 #include <vcl/window.hxx>
  39 #include <vcl/svapp.hxx>
  40 #include <toolkit/helper/convert.hxx>
  41 #include <comphelper/servicehelper.hxx>
  42 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  43
  44 using namespace ::com::sun::star;
  45 using namespace ::com::sun::star::accessibility;
  46
  47 //=====  internal  ============================================================
  48
  49 ScAccessiblePreviewCell::ScAccessiblePreviewCell( const ::com::sun::star::uno::Reference<
  50                                 ::com::sun::star::accessibility::XAccessible>& rxParent,
  51                             ScPreviewShell* pViewShell, /* const */ ScAddress& rCellAddress,
  52                             sal_Int32 nIndex ) :
  53     ScAccessibleCellBase( rxParent, ( pViewShell ? &pViewShell->GetDocument() : NULL ), rCellAddress, nIndex ),
  54     mpViewShell( pViewShell ),
  55     mpTextHelper(NULL)
  56 {
  57     if (mpViewShell)
  58         mpViewShell->AddAccessibilityObject(*this);
  59 }
  60
  61 ScAccessiblePreviewCell::~ScAccessiblePreviewCell()
  62 {
  63     if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
  64     {
  65         // increment refcount to prevent double call off dtor
  66         osl_atomic_increment( &m_refCount );
  67         // call dispose to inform object which have a weak reference to this object
  68         dispose();
  69     }
  70 }
  71
  72 void SAL_CALL ScAccessiblePreviewCell::disposing()
  73 {
  74     SolarMutexGuard aGuard;
  75     if (mpViewShell)
  76     {
  77         mpViewShell->RemoveAccessibilityObject(*this);
  78         mpViewShell = NULL;
  79     }
  80
  81     if (mpTextHelper)
  82         DELETEZ(mpTextHelper);
  83
  84     ScAccessibleCellBase::disposing();
  85 }
  86
  87 void ScAccessiblePreviewCell::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
  88 {
  89     const SfxSimpleHint* pSimpleHint = dynamic_cast<const SfxSimpleHint*>(&rHint);
  90     if (pSimpleHint && pSimpleHint->GetId() == SC_HINT_ACC_VISAREACHANGED)
  91     {
  92         if (mpTextHelper)
  93             mpTextHelper->UpdateChildren();
  94     }
  95
  96     ScAccessibleContextBase::Notify(rBC, rHint);
  97 }
  98
  99 //=====  XAccessibleComponent  ============================================
 100
 101 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewCell::getAccessibleAtPoint( const awt::Point& rPoint )
 102                                 throw (uno::RuntimeException, std::exception)
 103 {
 104     uno::Reference<XAccessible> xRet;
 105     if (containsPoint(rPoint))
 106     {
 107          SolarMutexGuard aGuard;
 108         IsObjectValid();
 109
 110         if(!mpTextHelper)
 111             CreateTextHelper();
 112
 113         xRet = mpTextHelper->GetAt(rPoint);
 114     }
 115
 116     return xRet;
 117 }
 118
 119 void SAL_CALL ScAccessiblePreviewCell::grabFocus() throw (uno::RuntimeException, std::exception)
 120 {
 121      SolarMutexGuard aGuard;
 122     IsObjectValid();
 123     if (getAccessibleParent().is())
 124     {
 125         uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
 126         if (xAccessibleComponent.is())
 127             xAccessibleComponent->grabFocus();
 128     }
 129 }
 130
 131 //=====  XAccessibleContext  ==============================================
 132
 133 sal_Int32 SAL_CALL ScAccessiblePreviewCell::getAccessibleChildCount() throw(uno::RuntimeException, std::exception)
 134 {
 135     SolarMutexGuard aGuard;
 136     IsObjectValid();
 137     if (!mpTextHelper)
 138         CreateTextHelper();
 139     return mpTextHelper->GetChildCount();
 140 }
 141
 142 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewCell::getAccessibleChild(sal_Int32 nIndex)
 143                             throw (uno::RuntimeException, lang::IndexOutOfBoundsException, std::exception)
 144 {
 145     SolarMutexGuard aGuard;
 146     IsObjectValid();
 147     if (!mpTextHelper)
 148         CreateTextHelper();
 149     return mpTextHelper->GetChild(nIndex);
 150 }
 151
 152 uno::Reference<XAccessibleStateSet> SAL_CALL ScAccessiblePreviewCell::getAccessibleStateSet()
 153                             throw(uno::RuntimeException, std::exception)
 154 {
 155     SolarMutexGuard aGuard;
 156
 157     uno::Reference<XAccessibleStateSet> xParentStates;
 158     if (getAccessibleParent().is())
 159     {
 160         uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
 161         xParentStates = xParentContext->getAccessibleStateSet();
 162     }
 163     utl::AccessibleStateSetHelper* pStateSet = new utl::AccessibleStateSetHelper();
 164     if (IsDefunc(xParentStates))
 165         pStateSet->AddState(AccessibleStateType::DEFUNC);
 166     else
 167     {
 168         pStateSet->AddState(AccessibleStateType::ENABLED);
 169         pStateSet->AddState(AccessibleStateType::MULTI_LINE);
 170         if (IsOpaque(xParentStates))
 171             pStateSet->AddState(AccessibleStateType::OPAQUE);
 172         if (isShowing())
 173             pStateSet->AddState(AccessibleStateType::SHOWING);
 174         pStateSet->AddState(AccessibleStateType::TRANSIENT);
 175         if (isVisible())
 176             pStateSet->AddState(AccessibleStateType::VISIBLE);
 177         // MANAGES_DESCENDANTS (for paragraphs)
 178         pStateSet->AddState(AccessibleStateType::MANAGES_DESCENDANTS);
 179     }
 180     return pStateSet;
 181 }
 182
 183 //=====  XServiceInfo  ====================================================
 184
 185 OUString SAL_CALL ScAccessiblePreviewCell::getImplementationName() throw(uno::RuntimeException, std::exception)
 186 {
 187     return OUString("ScAccessiblePreviewCell");
 188 }
 189
 190 uno::Sequence<OUString> SAL_CALL ScAccessiblePreviewCell::getSupportedServiceNames()
 191                                                     throw(uno::RuntimeException, std::exception)
 192 {
 193     uno::Sequence< OUString > aSequence = ScAccessibleContextBase::getSupportedServiceNames();
 194     sal_Int32 nOldSize(aSequence.getLength());
 195     aSequence.realloc(nOldSize + 1);
 196
 197     aSequence[nOldSize] = "com.sun.star.table.AccessibleCellView";
 198
 199     return aSequence;
 200 }
 201
 202 //=====  XTypeProvider  =======================================================
 203
 204 uno::Sequence<sal_Int8> SAL_CALL
 205     ScAccessiblePreviewCell::getImplementationId()
 206     throw (uno::RuntimeException, std::exception)
 207 {
 208     return css::uno::Sequence<sal_Int8>();
 209 }
 210
 211 //====  internal  =========================================================
 212
 213 Rectangle ScAccessiblePreviewCell::GetBoundingBoxOnScreen() const throw (uno::RuntimeException, std::exception)
 214 {
 215     Rectangle aCellRect;
 216     if (mpViewShell)
 217     {
 218         mpViewShell->GetLocationData().GetCellPosition( maCellAddress, aCellRect );
 219         vcl::Window* pWindow = mpViewShell->GetWindow();
 220         if (pWindow)
 221         {
 222             Rectangle aRect = pWindow->GetWindowExtentsRelative(NULL);
 223             aCellRect.setX(aCellRect.getX() + aRect.getX());
 224             aCellRect.setY(aCellRect.getY() + aRect.getY());
 225         }
 226     }
 227     return aCellRect;
 228 }
 229
 230 Rectangle ScAccessiblePreviewCell::GetBoundingBox() const throw (uno::RuntimeException, std::exception)
 231 {
 232     Rectangle aCellRect;
 233     if (mpViewShell)
 234     {
 235         mpViewShell->GetLocationData().GetCellPosition( maCellAddress, aCellRect );
 236         uno::Reference<XAccessible> xAccParent = const_cast<ScAccessiblePreviewCell*>(this)->getAccessibleParent();
 237         if (xAccParent.is())
 238         {
 239             uno::Reference<XAccessibleContext> xAccParentContext = xAccParent->getAccessibleContext();
 240             uno::Reference<XAccessibleComponent> xAccParentComp (xAccParentContext, uno::UNO_QUERY);
 241             if (xAccParentComp.is())
 242             {
 243                 Rectangle aParentRect (VCLRectangle(xAccParentComp->getBounds()));
 244                 aCellRect.setX(aCellRect.getX() - aParentRect.getX());
 245                 aCellRect.setY(aCellRect.getY() - aParentRect.getY());
 246             }
 247         }
 248     }
 249     return aCellRect;
 250 }
 251
 252 bool ScAccessiblePreviewCell::IsDefunc(
 253     const uno::Reference<XAccessibleStateSet>& rxParentStates)
 254 {
 255     return ScAccessibleContextBase::IsDefunc() || (mpDoc == NULL) || (mpViewShell == NULL) || !getAccessibleParent().is() ||
 256          (rxParentStates.is() && rxParentStates->contains(AccessibleStateType::DEFUNC));
 257 }
 258
 259 bool ScAccessiblePreviewCell::IsEditable(
 260     const uno::Reference<XAccessibleStateSet>& /* rxParentStates */)
 261 {
 262     return false;
 263 }
 264
 265 bool ScAccessiblePreviewCell::IsOpaque(
 266     const uno::Reference<XAccessibleStateSet>& /* rxParentStates */)
 267 {
 268     // test whether there is a background color
 269     //! could be moved to ScAccessibleCellBase
 270
 271     bool bOpaque(true);
 272     if (mpDoc)
 273     {
 274         const SvxBrushItem* pItem = static_cast<const SvxBrushItem*>(mpDoc->GetAttr(
 275             maCellAddress.Col(), maCellAddress.Row(), maCellAddress.Tab(), ATTR_BACKGROUND));
 276         if (pItem)
 277             bOpaque = pItem->GetColor() != COL_TRANSPARENT;
 278     }
 279     return bOpaque;
 280 }
 281
 282 void ScAccessiblePreviewCell::CreateTextHelper()
 283 {
 284     if (!mpTextHelper)
 285     {
 286         ::std::unique_ptr < ScAccessibleTextData > pAccessiblePreviewCellTextData
 287             (new ScAccessiblePreviewCellTextData(mpViewShell, maCellAddress));
 288         ::std::unique_ptr< SvxEditSource > pEditSource (new ScAccessibilityEditSource(std::move(pAccessiblePreviewCellTextData)));
 289
 290         mpTextHelper = new ::accessibility::AccessibleTextHelper( std::move(pEditSource) );
 291         mpTextHelper->SetEventSource( this );
 292
 293         // paragraphs in preview are transient
 294         ::accessibility::AccessibleTextHelper::VectorOfStates aChildStates;
 295         aChildStates.push_back( AccessibleStateType::TRANSIENT );
 296         mpTextHelper->SetAdditionalChildStates( aChildStates );
 297     }
 298 }
 299
 300 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */