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