sw/source/core/access/acccell.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/log.hxx>
  21 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  22 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  23 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  24 #include <cppuhelper/supportsservice.hxx>
  25 #include <cppuhelper/typeprovider.hxx>
  26 #include <vcl/svapp.hxx>
  27 #include <cellfrm.hxx>
  28 #include <tabfrm.hxx>
  29 #include <swtable.hxx>
  30 #include <crsrsh.hxx>
  31 #include <viscrs.hxx>
  32 #include "accfrmobj.hxx"
  33 #include "accfrmobjslist.hxx"
  34 #include <frmfmt.hxx>
  35 #include <cellatr.hxx>
  36 #include <accmap.hxx>
  37 #include "acccell.hxx"
  38
  39 #include <cfloat>
  40 #include <string_view>
  41
  42 #include <editeng/brushitem.hxx>
  43 #include <swatrset.hxx>
  44 #include <frmatr.hxx>
  45 #include "acctable.hxx"
  46
  47 using namespace ::com::sun::star;
  48 using namespace ::com::sun::star::accessibility;
  49 using namespace sw::access;
  50
  51 constexpr OUStringLiteral sImplementationName = u"com.sun.star.comp.Writer.SwAccessibleCellView";
  52
  53 bool SwAccessibleCell::IsSelected()
  54 {
  55     bool bRet = false;
  56
  57     assert(GetMap());
  58     const SwViewShell *pVSh = GetMap()->GetShell();
  59     assert(pVSh);
  60     if( auto pCSh = dynamic_cast<const SwCursorShell*>(pVSh) )
  61     {
  62         if( pCSh->IsTableMode() )
  63         {
  64             const SwCellFrame *pCFrame =
  65                 static_cast< const SwCellFrame * >( GetFrame() );
  66             SwTableBox *pBox =
  67                 const_cast< SwTableBox *>( pCFrame->GetTabBox() );
  68             SwSelBoxes const& rBoxes(pCSh->GetTableCursor()->GetSelectedBoxes());
  69             bRet = rBoxes.find(pBox) != rBoxes.end();
  70         }
  71     }
  72
  73     return bRet;
  74 }
  75
  76 void SwAccessibleCell::GetStates( sal_Int64& rStateSet )
  77 {
  78     SwAccessibleContext::GetStates( rStateSet );
  79
  80     // SELECTABLE
  81     const SwViewShell *pVSh = GetMap()->GetShell();
  82     assert(pVSh);
  83     if( dynamic_cast<const SwCursorShell*>( pVSh) !=  nullptr )
  84         rStateSet |= AccessibleStateType::SELECTABLE;
  85     //Add resizable state to table cell.
  86     rStateSet |= AccessibleStateType::RESIZABLE;
  87
  88     if (IsDisposing()) // tdf#135098
  89         return;
  90
  91     // SELECTED
  92     if( IsSelected() )
  93     {
  94         rStateSet |= AccessibleStateType::SELECTED;
  95         SAL_WARN_IF(!m_bIsSelected, "sw.a11y", "bSelected out of sync");
  96         ::rtl::Reference < SwAccessibleContext > xThis( this );
  97         GetMap()->SetCursorContext( xThis );
  98     }
  99 }
 100
 101 SwAccessibleCell::SwAccessibleCell(std::shared_ptr<SwAccessibleMap> const& pInitMap,
 102                                     const SwCellFrame *pCellFrame )
 103     : SwAccessibleContext( pInitMap, AccessibleRole::TABLE_CELL, pCellFrame )
 104     , m_aSelectionHelper( *this )
 105     , m_bIsSelected( false )
 106 {
 107     OUString sBoxName( pCellFrame->GetTabBox()->GetName() );
 108     SetName( sBoxName );
 109
 110     m_bIsSelected = IsSelected();
 111
 112     css::uno::Reference<css::accessibility::XAccessible> xTableReference(
 113         getAccessibleParentImpl());
 114     css::uno::Reference<css::accessibility::XAccessibleContext> xContextTable(
 115         xTableReference, css::uno::UNO_QUERY);
 116     SAL_WARN_IF(
 117         (!xContextTable.is()
 118          || xContextTable->getAccessibleRole() != AccessibleRole::TABLE),
 119         "sw.a11y", "bad accessible context");
 120     m_pAccTable = static_cast<SwAccessibleTable *>(xTableReference.get());
 121 }
 122
 123 bool SwAccessibleCell::InvalidateMyCursorPos()
 124 {
 125     bool bNew = IsSelected();
 126     bool bOld;
 127     {
 128         std::scoped_lock aGuard( m_Mutex );
 129         bOld = m_bIsSelected;
 130         m_bIsSelected = bNew;
 131     }
 132     if( bNew )
 133     {
 134         // remember that object as the one that has the caret. This is
 135         // necessary to notify that object if the cursor leaves it.
 136         ::rtl::Reference < SwAccessibleContext > xThis( this );
 137         GetMap()->SetCursorContext( xThis );
 138     }
 139
 140     bool bChanged = bOld != bNew;
 141     if( bChanged )
 142     {
 143         FireStateChangedEvent( AccessibleStateType::SELECTED, bNew );
 144         if (m_pAccTable.is())
 145         {
 146             m_pAccTable->AddSelectionCell(this,bNew);
 147         }
 148     }
 149     return bChanged;
 150 }
 151
 152 bool SwAccessibleCell::InvalidateChildrenCursorPos( const SwFrame *pFrame )
 153 {
 154     bool bChanged = false;
 155
 156     const SwAccessibleChildSList aVisList( GetVisArea(), *pFrame, *GetMap() );
 157     SwAccessibleChildSList::const_iterator aIter( aVisList.begin() );
 158     while( aIter != aVisList.end() )
 159     {
 160         const SwAccessibleChild& rLower = *aIter;
 161         const SwFrame *pLower = rLower.GetSwFrame();
 162         if( pLower )
 163         {
 164             if( rLower.IsAccessible( GetMap()->GetShell()->IsPreview() )  )
 165             {
 166                 ::rtl::Reference< SwAccessibleContext > xAccImpl(
 167                     GetMap()->GetContextImpl( pLower, false ) );
 168                 if( xAccImpl.is() )
 169                 {
 170                     assert(xAccImpl->GetFrame()->IsCellFrame());
 171                     bChanged = static_cast< SwAccessibleCell *>(
 172                             xAccImpl.get() )->InvalidateMyCursorPos();
 173                 }
 174                 else
 175                     bChanged = true; // If the context is not know we
 176                                          // don't know whether the selection
 177                                          // changed or not.
 178             }
 179             else
 180             {
 181                 // This is a box with sub rows.
 182                 bChanged |= InvalidateChildrenCursorPos( pLower );
 183             }
 184         }
 185         ++aIter;
 186     }
 187
 188     return bChanged;
 189 }
 190
 191 void SwAccessibleCell::InvalidateCursorPos_()
 192 {
 193     if (IsSelected())
 194     {
 195         const SwAccessibleChild aChild( GetChild( *(GetMap()), 0 ) );
 196         if( aChild.IsValid()  && aChild.GetSwFrame() )
 197         {
 198             ::rtl::Reference < SwAccessibleContext > xChildImpl( GetMap()->GetContextImpl( aChild.GetSwFrame())  );
 199             if (xChildImpl.is())
 200             {
 201                 AccessibleEventObject aEvent;
 202                 aEvent.EventId = AccessibleEventId::STATE_CHANGED;
 203                 aEvent.NewValue <<= AccessibleStateType::FOCUSED;
 204                 xChildImpl->FireAccessibleEvent( aEvent );
 205             }
 206         }
 207     }
 208
 209     const SwFrame *pParent = GetParent( SwAccessibleChild(GetFrame()), IsInPagePreview() );
 210     assert(pParent->IsTabFrame());
 211     const SwTabFrame *pTabFrame = static_cast< const SwTabFrame * >( pParent );
 212     if( pTabFrame->IsFollow() )
 213         pTabFrame = pTabFrame->FindMaster();
 214
 215     while( pTabFrame )
 216     {
 217         InvalidateChildrenCursorPos( pTabFrame );
 218         pTabFrame = pTabFrame->GetFollow();
 219     }
 220     if (m_pAccTable.is())
 221     {
 222         m_pAccTable->FireSelectionEvent();
 223     }
 224 }
 225
 226 bool SwAccessibleCell::HasCursor()
 227 {
 228     std::scoped_lock aGuard( m_Mutex );
 229     return m_bIsSelected;
 230 }
 231
 232 SwAccessibleCell::~SwAccessibleCell()
 233 {
 234 }
 235
 236 OUString SAL_CALL SwAccessibleCell::getAccessibleDescription()
 237 {
 238     return GetName();
 239 }
 240
 241 OUString SAL_CALL SwAccessibleCell::getImplementationName()
 242 {
 243     return sImplementationName;
 244 }
 245
 246 sal_Bool SAL_CALL SwAccessibleCell::supportsService(const OUString& sTestServiceName)
 247 {
 248     return cppu::supportsService(this, sTestServiceName);
 249 }
 250
 251 uno::Sequence< OUString > SAL_CALL SwAccessibleCell::getSupportedServiceNames()
 252 {
 253     return { "com.sun.star.table.AccessibleCellView", sAccessibleServiceName };
 254 }
 255
 256 void SwAccessibleCell::Dispose(bool bRecursive, bool bCanSkipInvisible)
 257 {
 258     const SwFrame *pParent = GetParent( SwAccessibleChild(GetFrame()), IsInPagePreview() );
 259     ::rtl::Reference< SwAccessibleContext > xAccImpl(
 260             GetMap()->GetContextImpl( pParent, false ) );
 261     if( xAccImpl.is() )
 262         xAccImpl->DisposeChild(SwAccessibleChild(GetFrame()), bRecursive, bCanSkipInvisible);
 263     SwAccessibleContext::Dispose( bRecursive );
 264 }
 265
 266 void SwAccessibleCell::InvalidatePosOrSize( const SwRect& rOldBox )
 267 {
 268     const SwFrame *pParent = GetParent( SwAccessibleChild(GetFrame()), IsInPagePreview() );
 269     ::rtl::Reference< SwAccessibleContext > xAccImpl(
 270             GetMap()->GetContextImpl( pParent, false ) );
 271     if( xAccImpl.is() )
 272         xAccImpl->InvalidateChildPosOrSize( SwAccessibleChild(GetFrame()), rOldBox );
 273     SwAccessibleContext::InvalidatePosOrSize( rOldBox );
 274 }
 275
 276 // XAccessibleInterface
 277
 278 uno::Any SwAccessibleCell::queryInterface( const uno::Type& rType )
 279 {
 280     if (rType == cppu::UnoType<XAccessibleExtendedAttributes>::get())
 281     {
 282         uno::Any aR;
 283         aR <<= uno::Reference<XAccessibleExtendedAttributes>(this);
 284         return aR;
 285     }
 286
 287     if (rType == cppu::UnoType<XAccessibleSelection>::get())
 288     {
 289         uno::Any aR;
 290         aR <<= uno::Reference<XAccessibleSelection>(this);
 291         return aR;
 292     }
 293     if ( rType == ::cppu::UnoType<XAccessibleValue>::get() )
 294     {
 295         uno::Reference<XAccessibleValue> xValue = this;
 296         uno::Any aRet;
 297         aRet <<= xValue;
 298         return aRet;
 299     }
 300     else
 301     {
 302         return SwAccessibleContext::queryInterface( rType );
 303     }
 304 }
 305
 306 // XTypeProvider
 307 uno::Sequence< uno::Type > SAL_CALL SwAccessibleCell::getTypes()
 308 {
 309     return cppu::OTypeCollection(
 310         ::cppu::UnoType<XAccessibleValue>::get(),
 311         SwAccessibleContext::getTypes() ).getTypes();
 312 }
 313
 314 uno::Sequence< sal_Int8 > SAL_CALL SwAccessibleCell::getImplementationId()
 315 {
 316     return css::uno::Sequence<sal_Int8>();
 317 }
 318
 319 // XAccessibleValue
 320
 321 SwFrameFormat* SwAccessibleCell::GetTableBoxFormat() const
 322 {
 323     assert(GetFrame());
 324     assert(GetFrame()->IsCellFrame());
 325
 326     const SwCellFrame* pCellFrame = static_cast<const SwCellFrame*>( GetFrame() );
 327     return pCellFrame->GetTabBox()->GetFrameFormat();
 328 }
 329
 330 //Implement TableCell currentValue
 331 uno::Any SwAccessibleCell::getCurrentValue( )
 332 {
 333     SolarMutexGuard aGuard;
 334
 335     ThrowIfDisposed();
 336
 337     return uno::Any( GetTableBoxFormat()->GetTableBoxValue().GetValue() );
 338 }
 339
 340 sal_Bool SwAccessibleCell::setCurrentValue( const uno::Any& aNumber )
 341 {
 342     SolarMutexGuard aGuard;
 343
 344     ThrowIfDisposed();
 345
 346     double fValue = 0;
 347     bool bValid = (aNumber >>= fValue);
 348     if( bValid )
 349     {
 350         SwTableBoxValue aValue( fValue );
 351         GetTableBoxFormat()->SetFormatAttr( aValue );
 352     }
 353     return bValid;
 354 }
 355
 356 uno::Any SwAccessibleCell::getMaximumValue( )
 357 {
 358     return uno::Any(DBL_MAX);
 359 }
 360
 361 uno::Any SwAccessibleCell::getMinimumValue(  )
 362 {
 363     return uno::Any(-DBL_MAX);
 364 }
 365
 366 uno::Any SwAccessibleCell::getMinimumIncrement(  )
 367 {
 368     return uno::Any();
 369 }
 370
 371 css::uno::Any SAL_CALL SwAccessibleCell::getExtendedAttributes()
 372 {
 373     SolarMutexGuard g;
 374
 375     css::uno::Any strRet;
 376     SwFrameFormat *pFrameFormat = GetTableBoxFormat();
 377     assert(pFrameFormat);
 378
 379     const SwTableBoxFormula& tbl_formula = pFrameFormat->GetTableBoxFormula();
 380
 381     OUString strFormula = tbl_formula.GetFormula()
 382                               .replaceAll(u"\\", u"\\\\")
 383                               .replaceAll(u";", u"\\;")
 384                               .replaceAll(u"=", u"\\=")
 385                               .replaceAll(u",", u"\\,")
 386                               .replaceAll(u":", u"\\:");
 387     OUString strFor = "Formula:" + strFormula + ";";
 388     strRet <<= strFor;
 389
 390     return strRet;
 391 }
 392
 393 sal_Int32 SAL_CALL SwAccessibleCell::getBackground()
 394 {
 395     SolarMutexGuard g;
 396
 397     const SvxBrushItem &rBack = GetFrame()->GetAttrSet()->GetBackground();
 398     Color crBack = rBack.GetColor();
 399
 400     if (COL_AUTO == crBack)
 401     {
 402         uno::Reference<XAccessible> xAccDoc = getAccessibleParent();
 403         if (xAccDoc.is())
 404         {
 405             uno::Reference<XAccessibleComponent> xComponentDoc(xAccDoc, uno::UNO_QUERY);
 406             if (xComponentDoc.is())
 407             {
 408                 crBack = Color(ColorTransparency, xComponentDoc->getBackground());
 409             }
 410         }
 411     }
 412     return sal_Int32(crBack);
 413 }
 414
 415 // XAccessibleSelection
 416 void SwAccessibleCell::selectAccessibleChild(
 417     sal_Int64 nChildIndex )
 418 {
 419     m_aSelectionHelper.selectAccessibleChild(nChildIndex);
 420 }
 421
 422 sal_Bool SwAccessibleCell::isAccessibleChildSelected(
 423     sal_Int64 nChildIndex )
 424 {
 425     return m_aSelectionHelper.isAccessibleChildSelected(nChildIndex);
 426 }
 427
 428 void SwAccessibleCell::clearAccessibleSelection(  )
 429 {
 430 }
 431
 432 void SwAccessibleCell::selectAllAccessibleChildren(  )
 433 {
 434     m_aSelectionHelper.selectAllAccessibleChildren();
 435 }
 436
 437 sal_Int64 SwAccessibleCell::getSelectedAccessibleChildCount(  )
 438 {
 439     return m_aSelectionHelper.getSelectedAccessibleChildCount();
 440 }
 441
 442 uno::Reference<XAccessible> SwAccessibleCell::getSelectedAccessibleChild(
 443     sal_Int64 nSelectedChildIndex )
 444 {
 445     return m_aSelectionHelper.getSelectedAccessibleChild(nSelectedChildIndex);
 446 }
 447
 448 void SwAccessibleCell::deselectAccessibleChild(
 449     sal_Int64 nSelectedChildIndex )
 450 {
 451     m_aSelectionHelper.deselectAccessibleChild(nSelectedChildIndex);
 452 }
 453
 454 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */