sd/source/ui/accessibility/AccessibleSlideSorterView.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 <AccessibleSlideSorterView.hxx>
  21 #include <AccessibleSlideSorterObject.hxx>
  22
  23 #include <SlideSorter.hxx>
  24 #include <controller/SlideSorterController.hxx>
  25 #include <controller/SlsPageSelector.hxx>
  26 #include <controller/SlsFocusManager.hxx>
  27 #include <controller/SlsSelectionManager.hxx>
  28 #include <view/SlideSorterView.hxx>
  29 #include <model/SlideSorterModel.hxx>
  30 #include <model/SlsPageDescriptor.hxx>
  31
  32 #include <ViewShell.hxx>
  33 #include <ViewShellHint.hxx>
  34 #include <sdpage.hxx>
  35 #include <drawdoc.hxx>
  36
  37 #include <sdresid.hxx>
  38 #include <strings.hrc>
  39 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  40 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  41 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  42 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  43 #include <comphelper/accessibleeventnotifier.hxx>
  44 #include <cppuhelper/supportsservice.hxx>
  45 #include <o3tl/safeint.hxx>
  46 #include <rtl/ref.hxx>
  47 #include <sal/log.hxx>
  48 #include <i18nlangtag/languagetag.hxx>
  49
  50 #include <vcl/settings.hxx>
  51 #include <vcl/svapp.hxx>
  52
  53 using namespace ::com::sun::star;
  54 using namespace ::com::sun::star::uno;
  55 using namespace ::com::sun::star::accessibility;
  56
  57 namespace accessibility {
  58
  59 /** Inner implementation class of the AccessibleSlideSorterView.
  60
  61     Note that some event broadcasting is done asynchronously because
  62     otherwise it could lead to deadlocks on (at least) some Solaris
  63     machines.  Probably (but unverified) this can happen on all GTK based
  64     systems.  The asynchronous broadcasting is just a workaround for a
  65     poorly understood problem.
  66 */
  67 class AccessibleSlideSorterView::Implementation
  68     : public SfxListener
  69 {
  70 public:
  71     Implementation (
  72         AccessibleSlideSorterView& rAccessibleSlideSorter,
  73         ::sd::slidesorter::SlideSorter& rSlideSorter,
  74         vcl::Window* pWindow);
  75     virtual ~Implementation() override;
  76
  77     void RequestUpdateChildren();
  78     void Clear();
  79     sal_Int32 GetVisibleChildCount() const;
  80     AccessibleSlideSorterObject* GetAccessibleChild (sal_Int32 nIndex);
  81     AccessibleSlideSorterObject* GetVisibleChild (sal_Int32 nIndex);
  82
  83     void ConnectListeners();
  84     void ReleaseListeners();
  85     void Notify (SfxBroadcaster& rBroadcaster, const SfxHint& rHint) override;
  86     DECL_LINK(WindowEventListener, VclWindowEvent&, void);
  87     DECL_LINK(SelectionChangeListener, LinkParamNone*, void);
  88     DECL_LINK(BroadcastSelectionChange, void*, void);
  89     DECL_LINK(FocusChangeListener, LinkParamNone*, void);
  90     DECL_LINK(VisibilityChangeListener, LinkParamNone*, void);
  91     DECL_LINK(UpdateChildrenCallback, void*, void);
  92
  93     void Activated();
  94 private:
  95     AccessibleSlideSorterView& mrAccessibleSlideSorter;
  96     ::sd::slidesorter::SlideSorter& mrSlideSorter;
  97     typedef ::std::vector<rtl::Reference<AccessibleSlideSorterObject> > PageObjectList;
  98     PageObjectList maPageObjects;
  99     sal_Int32 mnFirstVisibleChild;
 100     sal_Int32 mnLastVisibleChild;
 101     bool mbListeningToDocument;
 102     VclPtr<vcl::Window> mpWindow;
 103     sal_Int32 mnFocusedIndex;
 104     bool mbModelChangeLocked;
 105     ImplSVEvent * mnUpdateChildrenUserEventId;
 106     ImplSVEvent * mnSelectionChangeUserEventId;
 107
 108     void UpdateChildren();
 109 };
 110
 111 //===== AccessibleSlideSorterView =============================================
 112
 113 AccessibleSlideSorterView::AccessibleSlideSorterView(
 114     ::sd::slidesorter::SlideSorter& rSlideSorter,
 115     vcl::Window* pContentWindow)
 116     : AccessibleSlideSorterViewBase(m_aMutex),
 117       mrSlideSorter(rSlideSorter),
 118       mnClientId(0),
 119       mpContentWindow(pContentWindow)
 120 {
 121 }
 122
 123 void AccessibleSlideSorterView::Init()
 124 {
 125     mpImpl.reset(new Implementation(*this,mrSlideSorter,mpContentWindow));
 126 }
 127
 128 AccessibleSlideSorterView::~AccessibleSlideSorterView()
 129 {
 130     Destroyed ();
 131 }
 132
 133 void AccessibleSlideSorterView::FireAccessibleEvent (
 134     short nEventId,
 135     const uno::Any& rOldValue,
 136     const uno::Any& rNewValue )
 137 {
 138     if (mnClientId != 0)
 139     {
 140         AccessibleEventObject aEventObject;
 141
 142         aEventObject.Source = Reference<XWeak>(this);
 143         aEventObject.EventId = nEventId;
 144         aEventObject.NewValue = rNewValue;
 145         aEventObject.OldValue = rOldValue;
 146         aEventObject.IndexHint = -1;
 147
 148         comphelper::AccessibleEventNotifier::addEvent (mnClientId, aEventObject);
 149     }
 150 }
 151
 152 void SAL_CALL AccessibleSlideSorterView::disposing()
 153 {
 154     if (mnClientId != 0)
 155     {
 156         comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing( mnClientId, *this );
 157         mnClientId = 0;
 158     }
 159     mpImpl.reset();
 160 }
 161
 162 AccessibleSlideSorterObject* AccessibleSlideSorterView::GetAccessibleChildImplementation (
 163     sal_Int32 nIndex)
 164 {
 165     AccessibleSlideSorterObject* pResult = nullptr;
 166     ::osl::MutexGuard aGuard (m_aMutex);
 167
 168     if (nIndex>=0 && nIndex<mpImpl->GetVisibleChildCount())
 169         pResult = mpImpl->GetVisibleChild(nIndex);
 170
 171     return pResult;
 172 }
 173
 174 void AccessibleSlideSorterView::Destroyed()
 175 {
 176     ::osl::MutexGuard aGuard (m_aMutex);
 177
 178     // Send a disposing to all listeners.
 179     if (mnClientId != 0)
 180     {
 181         comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing( mnClientId, *this );
 182         mnClientId = 0;
 183     }
 184 }
 185
 186 //=====  XAccessible  =========================================================
 187
 188 Reference<XAccessibleContext > SAL_CALL
 189     AccessibleSlideSorterView::getAccessibleContext()
 190 {
 191     ThrowIfDisposed ();
 192     return this;
 193 }
 194
 195 //=====  XAccessibleContext  ==================================================
 196
 197 sal_Int64 SAL_CALL AccessibleSlideSorterView::getAccessibleChildCount()
 198 {
 199     ThrowIfDisposed();
 200     ::osl::MutexGuard aGuard (m_aMutex);
 201     return mpImpl->GetVisibleChildCount();
 202 }
 203
 204 Reference<XAccessible > SAL_CALL
 205     AccessibleSlideSorterView::getAccessibleChild (sal_Int64 nIndex)
 206 {
 207     ThrowIfDisposed();
 208     ::osl::MutexGuard aGuard (m_aMutex);
 209
 210     if (nIndex<0 || nIndex>=mpImpl->GetVisibleChildCount())
 211         throw lang::IndexOutOfBoundsException();
 212
 213     return  mpImpl->GetVisibleChild(nIndex);
 214 }
 215
 216 Reference<XAccessible > SAL_CALL AccessibleSlideSorterView::getAccessibleParent()
 217 {
 218     ThrowIfDisposed();
 219     const SolarMutexGuard aSolarGuard;
 220     Reference<XAccessible> xParent;
 221
 222     if (mpContentWindow != nullptr)
 223     {
 224         vcl::Window* pParent = mpContentWindow->GetAccessibleParentWindow();
 225         if (pParent != nullptr)
 226             xParent = pParent->GetAccessible();
 227     }
 228
 229     return xParent;
 230 }
 231
 232 sal_Int64 SAL_CALL AccessibleSlideSorterView::getAccessibleIndexInParent()
 233 {
 234     OSL_ASSERT(getAccessibleParent().is());
 235     ThrowIfDisposed();
 236     const SolarMutexGuard aSolarGuard;
 237     sal_Int64 nIndexInParent(-1);
 238
 239     Reference<XAccessibleContext> xParentContext (getAccessibleParent()->getAccessibleContext());
 240     if (xParentContext.is())
 241     {
 242         sal_Int64 nChildCount (xParentContext->getAccessibleChildCount());
 243         for (sal_Int64 i=0; i<nChildCount; ++i)
 244             if (xParentContext->getAccessibleChild(i).get()
 245                     == static_cast<XAccessible*>(this))
 246             {
 247                 nIndexInParent = i;
 248                 break;
 249             }
 250     }
 251
 252     return nIndexInParent;
 253 }
 254
 255 sal_Int16 SAL_CALL AccessibleSlideSorterView::getAccessibleRole()
 256 {
 257     ThrowIfDisposed();
 258     return AccessibleRole::DOCUMENT;
 259 }
 260
 261 OUString SAL_CALL AccessibleSlideSorterView::getAccessibleDescription()
 262 {
 263     ThrowIfDisposed();
 264     SolarMutexGuard aGuard;
 265
 266     return SdResId(SID_SD_A11Y_I_SLIDEVIEW_D);
 267 }
 268
 269 OUString SAL_CALL AccessibleSlideSorterView::getAccessibleName()
 270 {
 271     ThrowIfDisposed();
 272     SolarMutexGuard aGuard;
 273
 274     return SdResId(SID_SD_A11Y_I_SLIDEVIEW_N);
 275 }
 276
 277 Reference<XAccessibleRelationSet> SAL_CALL
 278     AccessibleSlideSorterView::getAccessibleRelationSet()
 279 {
 280     return Reference<XAccessibleRelationSet>();
 281 }
 282
 283 sal_Int64 SAL_CALL AccessibleSlideSorterView::getAccessibleStateSet()
 284 {
 285     ThrowIfDisposed();
 286     const SolarMutexGuard aSolarGuard;
 287     sal_Int64 nStateSet = 0;
 288
 289     nStateSet |= AccessibleStateType::FOCUSABLE;
 290     nStateSet |= AccessibleStateType::SELECTABLE;
 291     nStateSet |= AccessibleStateType::ENABLED;
 292     nStateSet |= AccessibleStateType::ACTIVE;
 293     nStateSet |= AccessibleStateType::MULTI_SELECTABLE;
 294     nStateSet |= AccessibleStateType::OPAQUE;
 295     if (mpContentWindow!=nullptr)
 296     {
 297         if (mpContentWindow->IsVisible())
 298             nStateSet |= AccessibleStateType::VISIBLE;
 299         if (mpContentWindow->IsReallyVisible())
 300             nStateSet |= AccessibleStateType::SHOWING;
 301     }
 302
 303     return nStateSet;
 304 }
 305
 306 lang::Locale SAL_CALL AccessibleSlideSorterView::getLocale()
 307 {
 308     ThrowIfDisposed ();
 309     Reference<XAccessibleContext> xParentContext;
 310     Reference<XAccessible> xParent (getAccessibleParent());
 311     if (xParent.is())
 312         xParentContext = xParent->getAccessibleContext();
 313
 314     if (xParentContext.is())
 315         return xParentContext->getLocale();
 316     else
 317         // Strange, no parent!  Anyway, return the default locale.
 318         return Application::GetSettings().GetLanguageTag().getLocale();
 319 }
 320
 321 void SAL_CALL AccessibleSlideSorterView::addAccessibleEventListener(
 322     const Reference<XAccessibleEventListener >& rxListener)
 323 {
 324     if (!rxListener.is())
 325         return;
 326
 327     const osl::MutexGuard aGuard(m_aMutex);
 328
 329     if (rBHelper.bDisposed || rBHelper.bInDispose)
 330     {
 331         uno::Reference<uno::XInterface> x (static_cast<lang::XComponent *>(this), uno::UNO_QUERY);
 332         rxListener->disposing (lang::EventObject (x));
 333     }
 334     else
 335     {
 336         if ( ! mnClientId)
 337             mnClientId = comphelper::AccessibleEventNotifier::registerClient();
 338         comphelper::AccessibleEventNotifier::addEventListener(mnClientId, rxListener);
 339     }
 340 }
 341
 342 void SAL_CALL AccessibleSlideSorterView::removeAccessibleEventListener(
 343     const Reference<XAccessibleEventListener >& rxListener)
 344 {
 345     ThrowIfDisposed();
 346     if (!rxListener.is())
 347         return;
 348
 349     const osl::MutexGuard aGuard(m_aMutex);
 350
 351     if (mnClientId == 0)
 352         return;
 353
 354     sal_Int32 nListenerCount = comphelper::AccessibleEventNotifier::removeEventListener(
 355         mnClientId, rxListener );
 356     if ( !nListenerCount )
 357     {
 358         // no listeners anymore -> revoke ourself. This may lead to
 359         // the notifier thread dying (if we were the last client),
 360         // and at least to us not firing any events anymore, in case
 361         // somebody calls NotifyAccessibleEvent, again
 362         comphelper::AccessibleEventNotifier::revokeClient( mnClientId );
 363         mnClientId = 0;
 364     }
 365 }
 366
 367 //===== XAccessibleComponent ==================================================
 368
 369 sal_Bool SAL_CALL AccessibleSlideSorterView::containsPoint (const awt::Point& aPoint)
 370 {
 371     ThrowIfDisposed();
 372     const awt::Rectangle aBBox (getBounds());
 373     return (aPoint.X >= 0)
 374         && (aPoint.X < aBBox.Width)
 375         && (aPoint.Y >= 0)
 376         && (aPoint.Y < aBBox.Height);
 377 }
 378
 379 Reference<XAccessible> SAL_CALL
 380     AccessibleSlideSorterView::getAccessibleAtPoint (const awt::Point& aPoint)
 381 {
 382     ThrowIfDisposed();
 383     Reference<XAccessible> xAccessible;
 384     const SolarMutexGuard aSolarGuard;
 385
 386     const Point aTestPoint (aPoint.X, aPoint.Y);
 387     ::sd::slidesorter::model::SharedPageDescriptor pHitDescriptor (
 388         mrSlideSorter.GetController().GetPageAt(aTestPoint));
 389     if (pHitDescriptor)
 390         xAccessible = mpImpl->GetAccessibleChild(
 391             (pHitDescriptor->GetPage()->GetPageNum()-1)/2);
 392
 393     return xAccessible;
 394 }
 395
 396 awt::Rectangle SAL_CALL AccessibleSlideSorterView::getBounds()
 397 {
 398     ThrowIfDisposed();
 399     const SolarMutexGuard aSolarGuard;
 400     awt::Rectangle aBBox;
 401
 402     if (mpContentWindow != nullptr)
 403     {
 404         const Point aPosition (mpContentWindow->GetPosPixel());
 405         const Size aSize (mpContentWindow->GetOutputSizePixel());
 406
 407         aBBox.X = aPosition.X();
 408         aBBox.Y = aPosition.Y();
 409         aBBox.Width = aSize.Width();
 410         aBBox.Height = aSize.Height();
 411     }
 412
 413     return aBBox;
 414 }
 415
 416 awt::Point SAL_CALL AccessibleSlideSorterView::getLocation()
 417 {
 418     ThrowIfDisposed();
 419     awt::Point aLocation;
 420
 421     if (mpContentWindow != nullptr)
 422     {
 423         const Point aPosition (mpContentWindow->GetPosPixel());
 424         aLocation.X = aPosition.X();
 425         aLocation.Y = aPosition.Y();
 426     }
 427
 428     return aLocation;
 429 }
 430
 431 /** Calculate the location on screen from the parent's location on screen
 432     and our own relative location.
 433 */
 434 awt::Point SAL_CALL AccessibleSlideSorterView::getLocationOnScreen()
 435 {
 436     ThrowIfDisposed();
 437     const SolarMutexGuard aSolarGuard;
 438     awt::Point aParentLocationOnScreen;
 439
 440     Reference<XAccessible> xParent (getAccessibleParent());
 441     if (xParent.is())
 442     {
 443         Reference<XAccessibleComponent> xParentComponent (
 444             xParent->getAccessibleContext(), uno::UNO_QUERY);
 445         if (xParentComponent.is())
 446             aParentLocationOnScreen = xParentComponent->getLocationOnScreen();
 447     }
 448
 449     awt::Point aLocationOnScreen (getLocation());
 450     aLocationOnScreen.X += aParentLocationOnScreen.X;
 451     aLocationOnScreen.Y += aParentLocationOnScreen.Y;
 452
 453     return aLocationOnScreen;
 454 }
 455
 456 awt::Size SAL_CALL AccessibleSlideSorterView::getSize()
 457 {
 458     ThrowIfDisposed();
 459     awt::Size aSize;
 460
 461     if (mpContentWindow != nullptr)
 462     {
 463         const Size aOutputSize (mpContentWindow->GetOutputSizePixel());
 464         aSize.Width = aOutputSize.Width();
 465         aSize.Height = aOutputSize.Height();
 466     }
 467
 468     return aSize;
 469 }
 470
 471 void SAL_CALL AccessibleSlideSorterView::grabFocus()
 472 {
 473     ThrowIfDisposed();
 474     const SolarMutexGuard aSolarGuard;
 475
 476     if (mpContentWindow)
 477         mpContentWindow->GrabFocus();
 478 }
 479
 480 sal_Int32 SAL_CALL AccessibleSlideSorterView::getForeground()
 481 {
 482     ThrowIfDisposed();
 483     svtools::ColorConfig aColorConfig;
 484     Color nColor = aColorConfig.GetColorValue( svtools::FONTCOLOR ).nColor;
 485     return static_cast<sal_Int32>(nColor);
 486 }
 487
 488 sal_Int32 SAL_CALL AccessibleSlideSorterView::getBackground()
 489 {
 490     ThrowIfDisposed();
 491     Color nColor = Application::GetSettings().GetStyleSettings().GetWindowColor();
 492     return sal_Int32(nColor);
 493 }
 494
 495 //===== XAccessibleSelection ==================================================
 496
 497 void SAL_CALL AccessibleSlideSorterView::selectAccessibleChild (sal_Int64 nChildIndex)
 498 {
 499     ThrowIfDisposed();
 500     const SolarMutexGuard aSolarGuard;
 501
 502     if (nChildIndex < 0 || nChildIndex >= getAccessibleChildCount())
 503         throw lang::IndexOutOfBoundsException();
 504
 505     AccessibleSlideSorterObject* pChild = mpImpl->GetAccessibleChild(nChildIndex);
 506     if (pChild == nullptr)
 507         throw lang::IndexOutOfBoundsException();
 508
 509     mrSlideSorter.GetController().GetPageSelector().SelectPage(pChild->GetPageNumber());
 510 }
 511
 512 sal_Bool SAL_CALL AccessibleSlideSorterView::isAccessibleChildSelected (sal_Int64 nChildIndex)
 513 {
 514     ThrowIfDisposed();
 515     bool bIsSelected = false;
 516     const SolarMutexGuard aSolarGuard;
 517
 518     if (nChildIndex < 0 || nChildIndex >= getAccessibleChildCount())
 519         throw lang::IndexOutOfBoundsException();
 520
 521     AccessibleSlideSorterObject* pChild = mpImpl->GetAccessibleChild(nChildIndex);
 522     if (pChild == nullptr)
 523         throw lang::IndexOutOfBoundsException();
 524
 525     bIsSelected = mrSlideSorter.GetController().GetPageSelector().IsPageSelected(
 526         pChild->GetPageNumber());
 527
 528     return bIsSelected;
 529 }
 530
 531 void SAL_CALL AccessibleSlideSorterView::clearAccessibleSelection()
 532 {
 533     ThrowIfDisposed();
 534     const SolarMutexGuard aSolarGuard;
 535
 536     mrSlideSorter.GetController().GetPageSelector().DeselectAllPages();
 537 }
 538
 539 void SAL_CALL AccessibleSlideSorterView::selectAllAccessibleChildren()
 540 {
 541     ThrowIfDisposed();
 542     const SolarMutexGuard aSolarGuard;
 543
 544     mrSlideSorter.GetController().GetPageSelector().SelectAllPages();
 545 }
 546
 547 sal_Int64 SAL_CALL AccessibleSlideSorterView::getSelectedAccessibleChildCount()
 548 {
 549     ThrowIfDisposed ();
 550     const SolarMutexGuard aSolarGuard;
 551     return mrSlideSorter.GetController().GetPageSelector().GetSelectedPageCount();
 552 }
 553
 554 Reference<XAccessible > SAL_CALL
 555     AccessibleSlideSorterView::getSelectedAccessibleChild (sal_Int64 nSelectedChildIndex )
 556 {
 557     ThrowIfDisposed ();
 558     const SolarMutexGuard aSolarGuard;
 559
 560     if (nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount())
 561         throw lang::IndexOutOfBoundsException();
 562
 563     Reference<XAccessible> xChild;
 564
 565     ::sd::slidesorter::controller::PageSelector& rSelector (
 566         mrSlideSorter.GetController().GetPageSelector());
 567     sal_Int32 nPageCount(rSelector.GetPageCount());
 568     sal_Int32 nSelectedCount = 0;
 569     for (sal_Int32 i=0; i<nPageCount; i++)
 570         if (rSelector.IsPageSelected(i))
 571         {
 572             if (nSelectedCount == nSelectedChildIndex)
 573             {
 574                 xChild = mpImpl->GetAccessibleChild(i);
 575                 break;
 576             }
 577             ++nSelectedCount;
 578         }
 579
 580     if ( ! xChild.is() )
 581         throw lang::IndexOutOfBoundsException();
 582
 583     return xChild;
 584 }
 585
 586 void SAL_CALL AccessibleSlideSorterView::deselectAccessibleChild (sal_Int64 nChildIndex)
 587 {
 588     ThrowIfDisposed();
 589     const SolarMutexGuard aSolarGuard;
 590
 591     if (nChildIndex < 0 || nChildIndex >= getAccessibleChildCount())
 592         throw lang::IndexOutOfBoundsException();
 593
 594     AccessibleSlideSorterObject* pChild = mpImpl->GetAccessibleChild(nChildIndex);
 595     if (pChild == nullptr)
 596         throw lang::IndexOutOfBoundsException();
 597
 598     mrSlideSorter.GetController().GetPageSelector().DeselectPage(pChild->GetPageNumber());
 599 }
 600
 601 // XServiceInfo
 602 OUString SAL_CALL
 603        AccessibleSlideSorterView::getImplementationName()
 604 {
 605     return u"AccessibleSlideSorterView"_ustr;
 606 }
 607
 608 sal_Bool SAL_CALL AccessibleSlideSorterView::supportsService (const OUString& sServiceName)
 609 {
 610     return cppu::supportsService(this, sServiceName);
 611 }
 612
 613 uno::Sequence< OUString> SAL_CALL
 614        AccessibleSlideSorterView::getSupportedServiceNames()
 615 {
 616     ThrowIfDisposed ();
 617
 618     return uno::Sequence<OUString> {
 619             u"com.sun.star.accessibility.Accessible"_ustr,
 620             u"com.sun.star.accessibility.AccessibleContext"_ustr,
 621             u"com.sun.star.drawing.AccessibleSlideSorterView"_ustr
 622     };
 623 }
 624
 625 void AccessibleSlideSorterView::ThrowIfDisposed()
 626 {
 627     if (rBHelper.bDisposed || rBHelper.bInDispose)
 628     {
 629         SAL_WARN("sd", "Calling disposed object. Throwing exception:");
 630         throw lang::DisposedException (u"object has been already disposed"_ustr,
 631             static_cast<uno::XWeak*>(this));
 632     }
 633 }
 634
 635 //===== AccessibleSlideSorterView::Implementation =============================
 636
 637 AccessibleSlideSorterView::Implementation::Implementation (
 638     AccessibleSlideSorterView& rAccessibleSlideSorter,
 639     ::sd::slidesorter::SlideSorter& rSlideSorter,
 640     vcl::Window* pWindow)
 641     : mrAccessibleSlideSorter(rAccessibleSlideSorter),
 642       mrSlideSorter(rSlideSorter),
 643       mnFirstVisibleChild(0),
 644       mnLastVisibleChild(-1),
 645       mbListeningToDocument(false),
 646       mpWindow(pWindow),
 647       mnFocusedIndex(-1),
 648       mbModelChangeLocked(false),
 649       mnUpdateChildrenUserEventId(nullptr),
 650       mnSelectionChangeUserEventId(nullptr)
 651 {
 652     ConnectListeners();
 653     UpdateChildren();
 654 }
 655
 656 AccessibleSlideSorterView::Implementation::~Implementation()
 657 {
 658     if (mnUpdateChildrenUserEventId != nullptr)
 659         Application::RemoveUserEvent(mnUpdateChildrenUserEventId);
 660     if (mnSelectionChangeUserEventId != nullptr)
 661         Application::RemoveUserEvent(mnSelectionChangeUserEventId);
 662     ReleaseListeners();
 663     Clear();
 664 }
 665
 666 void AccessibleSlideSorterView::Implementation::RequestUpdateChildren()
 667 {
 668     if (mnUpdateChildrenUserEventId == nullptr)
 669         mnUpdateChildrenUserEventId = Application::PostUserEvent(
 670             LINK(this, AccessibleSlideSorterView::Implementation,
 671                  UpdateChildrenCallback));
 672 }
 673
 674 void AccessibleSlideSorterView::Implementation::UpdateChildren()
 675 {
 676       //By default, all children should be accessible. So here workaround is to make all children visible.
 677       // MT: This was in UpdateVisibility, which has some similarity, and hg merge automatically has put it here. Correct?!
 678       // In the IA2 CWS, also setting mnFirst/LastVisibleChild was commented out!
 679     mnLastVisibleChild = maPageObjects.size();
 680
 681     if (mbModelChangeLocked)
 682     {
 683         // Do nothing right now.  When the flag is reset, this method is
 684         // called again.
 685         return;
 686     }
 687
 688     const Range aRange (mrSlideSorter.GetView().GetVisiblePageRange());
 689     mnFirstVisibleChild = aRange.Min();
 690     mnLastVisibleChild = aRange.Max();
 691
 692     // Release all children.
 693     Clear();
 694
 695     // Create new children for the modified visible range.
 696     maPageObjects.resize(mrSlideSorter.GetModel().GetPageCount());
 697
 698     // No Visible children
 699     if (mnFirstVisibleChild == -1 && mnLastVisibleChild == -1)
 700         return;
 701
 702     for (sal_Int32 nIndex(mnFirstVisibleChild); nIndex<=mnLastVisibleChild; ++nIndex)
 703         GetAccessibleChild(nIndex);
 704 }
 705
 706 void AccessibleSlideSorterView::Implementation::Clear()
 707 {
 708     for (auto& rxPageObject : maPageObjects)
 709         if (rxPageObject != nullptr)
 710         {
 711             mrAccessibleSlideSorter.FireAccessibleEvent(
 712                 AccessibleEventId::CHILD,
 713                 Any(Reference<XAccessible>(rxPageObject)),
 714                 Any());
 715
 716             Reference<XComponent> xComponent (Reference<XWeak>(rxPageObject), UNO_QUERY);
 717             if (xComponent.is())
 718                 xComponent->dispose();
 719             rxPageObject = nullptr;
 720         }
 721     maPageObjects.clear();
 722 }
 723
 724 sal_Int32 AccessibleSlideSorterView::Implementation::GetVisibleChildCount() const
 725 {
 726     if (mnFirstVisibleChild<=mnLastVisibleChild && mnFirstVisibleChild>=0)
 727         return mnLastVisibleChild - mnFirstVisibleChild + 1;
 728     else
 729         return 0;
 730 }
 731
 732 AccessibleSlideSorterObject* AccessibleSlideSorterView::Implementation::GetVisibleChild (
 733     sal_Int32 nIndex)
 734 {
 735     assert(nIndex>=0 && nIndex<GetVisibleChildCount());
 736
 737     return GetAccessibleChild(nIndex+mnFirstVisibleChild);
 738 }
 739
 740 AccessibleSlideSorterObject* AccessibleSlideSorterView::Implementation::GetAccessibleChild (
 741     sal_Int32 nIndex)
 742 {
 743     AccessibleSlideSorterObject* pChild = nullptr;
 744
 745     if (nIndex>=0 && o3tl::make_unsigned(nIndex)<maPageObjects.size())
 746     {
 747         if (maPageObjects[nIndex] == nullptr)
 748         {
 749             ::sd::slidesorter::model::SharedPageDescriptor pDescriptor(
 750                 mrSlideSorter.GetModel().GetPageDescriptor(nIndex));
 751             if (pDescriptor)
 752             {
 753                 maPageObjects[nIndex] = new AccessibleSlideSorterObject(
 754                     &mrAccessibleSlideSorter,
 755                     mrSlideSorter,
 756                     (pDescriptor->GetPage()->GetPageNum()-1)/2);
 757
 758                 mrAccessibleSlideSorter.FireAccessibleEvent(
 759                     AccessibleEventId::CHILD,
 760                     Any(),
 761                     Any(Reference<XAccessible>(maPageObjects[nIndex])));
 762             }
 763
 764         }
 765
 766         pChild = maPageObjects[nIndex].get();
 767     }
 768     else
 769     {
 770         OSL_ASSERT(nIndex>=0 && o3tl::make_unsigned(nIndex)<maPageObjects.size());
 771     }
 772
 773     return pChild;
 774 }
 775
 776 void AccessibleSlideSorterView::Implementation::ConnectListeners()
 777 {
 778     StartListening (*mrSlideSorter.GetModel().GetDocument());
 779     if (mrSlideSorter.GetViewShell() != nullptr)
 780         StartListening (*mrSlideSorter.GetViewShell());
 781     mbListeningToDocument = true;
 782
 783     if (mpWindow != nullptr)
 784         mpWindow->AddEventListener(
 785             LINK(this,AccessibleSlideSorterView::Implementation,WindowEventListener));
 786
 787     mrSlideSorter.GetController().GetSelectionManager()->AddSelectionChangeListener(
 788         LINK(this,AccessibleSlideSorterView::Implementation,SelectionChangeListener));
 789     mrSlideSorter.GetController().GetFocusManager().AddFocusChangeListener(
 790         LINK(this,AccessibleSlideSorterView::Implementation,FocusChangeListener));
 791     mrSlideSorter.GetView().AddVisibilityChangeListener(
 792         LINK(this,AccessibleSlideSorterView::Implementation,VisibilityChangeListener));
 793 }
 794
 795 void AccessibleSlideSorterView::Implementation::ReleaseListeners()
 796 {
 797     mrSlideSorter.GetController().GetFocusManager().RemoveFocusChangeListener(
 798         LINK(this,AccessibleSlideSorterView::Implementation,FocusChangeListener));
 799     mrSlideSorter.GetController().GetSelectionManager()->RemoveSelectionChangeListener(
 800         LINK(this,AccessibleSlideSorterView::Implementation,SelectionChangeListener));
 801     mrSlideSorter.GetView().RemoveVisibilityChangeListener(
 802         LINK(this,AccessibleSlideSorterView::Implementation,VisibilityChangeListener));
 803
 804     if (mpWindow != nullptr)
 805         mpWindow->RemoveEventListener(
 806             LINK(this,AccessibleSlideSorterView::Implementation,WindowEventListener));
 807
 808     if (mbListeningToDocument)
 809     {
 810         if (mrSlideSorter.GetViewShell() != nullptr && !IsListening(*mrSlideSorter.GetViewShell()))
 811         {   // ??? is it even possible that ConnectListeners is called with no
 812             // view shell and this one with a view shell?
 813             StartListening(*mrSlideSorter.GetViewShell());
 814         }
 815         EndListening (*mrSlideSorter.GetModel().GetDocument());
 816         mbListeningToDocument = false;
 817     }
 818 }
 819
 820 void AccessibleSlideSorterView::Implementation::Notify (
 821     SfxBroadcaster&,
 822     const SfxHint& rHint)
 823 {
 824     if (rHint.GetId() == SfxHintId::ThisIsAnSdrHint)
 825     {
 826         const SdrHint* pSdrHint = static_cast<const SdrHint*>(&rHint);
 827         switch (pSdrHint->GetKind())
 828         {
 829             case SdrHintKind::PageOrderChange:
 830                 RequestUpdateChildren();
 831                 break;
 832             default:
 833                 break;
 834         }
 835     }
 836     else if (rHint.GetId() == SfxHintId::SdViewShell)
 837     {
 838         auto pViewShellHint = static_cast<const sd::ViewShellHint*>(&rHint);
 839         switch (pViewShellHint->GetHintId())
 840         {
 841             case sd::ViewShellHint::HINT_COMPLEX_MODEL_CHANGE_START:
 842                 mbModelChangeLocked = true;
 843                 break;
 844
 845             case sd::ViewShellHint::HINT_COMPLEX_MODEL_CHANGE_END:
 846                 mbModelChangeLocked = false;
 847                 RequestUpdateChildren();
 848                 break;
 849             default:
 850                 break;
 851         }
 852     }
 853 }
 854
 855 void AccessibleSlideSorterView::SwitchViewActivated()
 856 {
 857     // Firstly, set focus to view
 858     FireAccessibleEvent(AccessibleEventId::STATE_CHANGED,
 859                     Any(),
 860                     Any(AccessibleStateType::FOCUSED));
 861
 862     mpImpl->Activated();
 863 }
 864
 865 void AccessibleSlideSorterView::Implementation::Activated()
 866 {
 867     mrSlideSorter.GetController().GetFocusManager().ShowFocus();
 868
 869 }
 870
 871 IMPL_LINK(AccessibleSlideSorterView::Implementation, WindowEventListener, VclWindowEvent&, rEvent, void)
 872 {
 873     switch (rEvent.GetId())
 874     {
 875         case VclEventId::WindowMove:
 876         case VclEventId::WindowResize:
 877             RequestUpdateChildren();
 878             break;
 879
 880         case VclEventId::WindowGetFocus:
 881         case VclEventId::WindowLoseFocus:
 882             mrAccessibleSlideSorter.FireAccessibleEvent(
 883                 AccessibleEventId::SELECTION_CHANGED,
 884                 Any(),
 885                 Any());
 886             break;
 887         default:
 888             break;
 889     }
 890 }
 891
 892 IMPL_LINK_NOARG(AccessibleSlideSorterView::Implementation, SelectionChangeListener, LinkParamNone*, void)
 893 {
 894     if (mnSelectionChangeUserEventId == nullptr)
 895         mnSelectionChangeUserEventId = Application::PostUserEvent(
 896             LINK(this, AccessibleSlideSorterView::Implementation, BroadcastSelectionChange));
 897 }
 898
 899 IMPL_LINK_NOARG(AccessibleSlideSorterView::Implementation, BroadcastSelectionChange, void*, void)
 900 {
 901     mnSelectionChangeUserEventId = nullptr;
 902     mrAccessibleSlideSorter.FireAccessibleEvent(
 903         AccessibleEventId::SELECTION_CHANGED,
 904         Any(),
 905         Any());
 906 }
 907
 908 IMPL_LINK_NOARG(AccessibleSlideSorterView::Implementation, FocusChangeListener, LinkParamNone*, void)
 909 {
 910     sal_Int32 nNewFocusedIndex (
 911         mrSlideSorter.GetController().GetFocusManager().GetFocusedPageIndex());
 912
 913     bool bHasFocus = mrSlideSorter.GetController().GetFocusManager().IsFocusShowing();
 914     if (!bHasFocus)
 915         nNewFocusedIndex = -1;
 916
 917     // add a checker whether the focus event is sent out. Only after sent, the mnFocusedIndex should be updated.
 918     bool bSentFocus = false;
 919     if (nNewFocusedIndex == mnFocusedIndex)
 920         return;
 921
 922     if (mnFocusedIndex >= 0)
 923     {
 924         AccessibleSlideSorterObject* pObject = GetAccessibleChild(mnFocusedIndex);
 925         if (pObject != nullptr)
 926         {
 927             pObject->FireAccessibleEvent(
 928                 AccessibleEventId::STATE_CHANGED,
 929                 Any(AccessibleStateType::FOCUSED),
 930                 Any());
 931             bSentFocus = true;
 932         }
 933     }
 934     if (nNewFocusedIndex >= 0)
 935     {
 936         AccessibleSlideSorterObject* pObject = GetAccessibleChild(nNewFocusedIndex);
 937         if (pObject != nullptr)
 938         {
 939             pObject->FireAccessibleEvent(
 940                 AccessibleEventId::STATE_CHANGED,
 941                 Any(),
 942                 Any(AccessibleStateType::FOCUSED));
 943             bSentFocus = true;
 944         }
 945     }
 946     if (bSentFocus)
 947         mnFocusedIndex = nNewFocusedIndex;
 948 }
 949
 950 IMPL_LINK_NOARG(AccessibleSlideSorterView::Implementation, UpdateChildrenCallback, void*, void)
 951 {
 952     mnUpdateChildrenUserEventId = nullptr;
 953     UpdateChildren();
 954 }
 955
 956 IMPL_LINK_NOARG(AccessibleSlideSorterView::Implementation, VisibilityChangeListener, LinkParamNone*, void)
 957 {
 958     UpdateChildren();
 959 }
 960
 961 } // end of namespace ::accessibility
 962
 963 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */