sd/source/ui/accessibility/AccessibleSlideSorterObject.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 <AccessibleSlideSorterObject.hxx>
  21
  22 #include <SlideSorter.hxx>
  23 #include <controller/SlideSorterController.hxx>
  24 #include <controller/SlsPageSelector.hxx>
  25 #include <controller/SlsFocusManager.hxx>
  26 #include <model/SlideSorterModel.hxx>
  27 #include <model/SlsPageDescriptor.hxx>
  28 #include <view/SlideSorterView.hxx>
  29 #include <view/SlsLayouter.hxx>
  30 #include <view/SlsPageObjectLayouter.hxx>
  31 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  32 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  33 #include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp>
  34 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  35 #include <comphelper/accessibleeventnotifier.hxx>
  36 #include <cppuhelper/supportsservice.hxx>
  37 #include <sal/log.hxx>
  38
  39 #include <sdpage.hxx>
  40 #include <sdresid.hxx>
  41 #include <vcl/svapp.hxx>
  42 #include <vcl/settings.hxx>
  43
  44 #include <strings.hrc>
  45
  46 using namespace ::com::sun::star;
  47 using namespace ::com::sun::star::uno;
  48 using namespace ::com::sun::star::accessibility;
  49
  50 namespace accessibility {
  51
  52 AccessibleSlideSorterObject::AccessibleSlideSorterObject(
  53     const Reference<XAccessible>& rxParent,
  54     ::sd::slidesorter::SlideSorter& rSlideSorter,
  55     sal_uInt16 nPageNumber)
  56     : mxParent(rxParent),
  57       mnPageNumber(nPageNumber),
  58       mrSlideSorter(rSlideSorter),
  59       mnClientId(0)
  60 {
  61 }
  62
  63 AccessibleSlideSorterObject::~AccessibleSlideSorterObject()
  64 {
  65     if ( ! IsDisposed())
  66         dispose();
  67 }
  68
  69 void AccessibleSlideSorterObject::FireAccessibleEvent (
  70     short nEventId,
  71     const uno::Any& rOldValue,
  72     const uno::Any& rNewValue)
  73 {
  74     if (mnClientId != 0)
  75     {
  76         AccessibleEventObject aEventObject;
  77
  78         aEventObject.Source = Reference<XWeak>(this);
  79         aEventObject.EventId = nEventId;
  80         aEventObject.NewValue = rNewValue;
  81         aEventObject.OldValue = rOldValue;
  82
  83         comphelper::AccessibleEventNotifier::addEvent(mnClientId, aEventObject);
  84     }
  85 }
  86
  87 void AccessibleSlideSorterObject::disposing(std::unique_lock<std::mutex>&)
  88 {
  89     // Send a disposing to all listeners.
  90     if (mnClientId != 0)
  91     {
  92         comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing(mnClientId, *this);
  93         mnClientId =  0;
  94     }
  95 }
  96
  97 //===== XAccessible ===========================================================
  98
  99 Reference<XAccessibleContext> SAL_CALL
 100     AccessibleSlideSorterObject::getAccessibleContext()
 101 {
 102     ThrowIfDisposed();
 103     return this;
 104 }
 105
 106 //===== XAccessibleContext ====================================================
 107
 108 sal_Int64 SAL_CALL AccessibleSlideSorterObject::getAccessibleChildCount()
 109 {
 110     ThrowIfDisposed();
 111     return 0;
 112 }
 113
 114 Reference<XAccessible> SAL_CALL AccessibleSlideSorterObject::getAccessibleChild (sal_Int64 )
 115 {
 116     ThrowIfDisposed();
 117     throw lang::IndexOutOfBoundsException();
 118 }
 119
 120 Reference<XAccessible> SAL_CALL AccessibleSlideSorterObject::getAccessibleParent()
 121 {
 122     ThrowIfDisposed();
 123     return mxParent;
 124 }
 125
 126 sal_Int64 SAL_CALL AccessibleSlideSorterObject::getAccessibleIndexInParent()
 127 {
 128     ThrowIfDisposed();
 129     const SolarMutexGuard aSolarGuard;
 130     sal_Int64 nIndexInParent(-1);
 131
 132     if (mxParent.is())
 133     {
 134         Reference<XAccessibleContext> xParentContext (mxParent->getAccessibleContext());
 135         if (xParentContext.is())
 136         {
 137             sal_Int64 nChildCount (xParentContext->getAccessibleChildCount());
 138             for (sal_Int64 i=0; i<nChildCount; ++i)
 139                 if (xParentContext->getAccessibleChild(i).get()
 140                     == static_cast<XAccessible*>(this))
 141                 {
 142                     nIndexInParent = i;
 143                     break;
 144                 }
 145         }
 146     }
 147
 148     return nIndexInParent;
 149 }
 150
 151 sal_Int16 SAL_CALL AccessibleSlideSorterObject::getAccessibleRole()
 152 {
 153     ThrowIfDisposed();
 154     return AccessibleRole::SHAPE;
 155 }
 156
 157 OUString SAL_CALL AccessibleSlideSorterObject::getAccessibleDescription()
 158 {
 159     ThrowIfDisposed();
 160     return SdResId(STR_PAGE);
 161 }
 162
 163 OUString SAL_CALL AccessibleSlideSorterObject::getAccessibleName()
 164 {
 165     ThrowIfDisposed();
 166     const SolarMutexGuard aSolarGuard;
 167
 168     SdPage* pPage = GetPage();
 169     if (pPage != nullptr)
 170         return pPage->GetName();
 171     else
 172         return OUString();
 173 }
 174
 175 Reference<XAccessibleRelationSet> SAL_CALL
 176     AccessibleSlideSorterObject::getAccessibleRelationSet()
 177 {
 178     ThrowIfDisposed();
 179     return Reference<XAccessibleRelationSet>();
 180 }
 181
 182 sal_Int64 SAL_CALL
 183     AccessibleSlideSorterObject::getAccessibleStateSet()
 184 {
 185     ThrowIfDisposed();
 186     const SolarMutexGuard aSolarGuard;
 187     sal_Int64 nStateSet = 0;
 188
 189     if (mxParent.is())
 190     {
 191         // Unconditional states.
 192         nStateSet |= AccessibleStateType::SELECTABLE;
 193         nStateSet |= AccessibleStateType::FOCUSABLE;
 194         nStateSet |= AccessibleStateType::ENABLED;
 195         nStateSet |= AccessibleStateType::VISIBLE;
 196         nStateSet |= AccessibleStateType::SHOWING;
 197         nStateSet |= AccessibleStateType::ACTIVE;
 198         nStateSet |= AccessibleStateType::SENSITIVE;
 199
 200         // Conditional states.
 201         if (mrSlideSorter.GetController().GetPageSelector().IsPageSelected(mnPageNumber))
 202             nStateSet |= AccessibleStateType::SELECTED;
 203         if (mrSlideSorter.GetController().GetFocusManager().GetFocusedPageIndex() == mnPageNumber)
 204             if (mrSlideSorter.GetController().GetFocusManager().IsFocusShowing())
 205                 nStateSet |= AccessibleStateType::FOCUSED;
 206     }
 207
 208     return nStateSet;
 209 }
 210
 211 lang::Locale SAL_CALL AccessibleSlideSorterObject::getLocale()
 212 {
 213     ThrowIfDisposed();
 214     // Delegate request to parent.
 215     if (mxParent.is())
 216     {
 217         Reference<XAccessibleContext> xParentContext (mxParent->getAccessibleContext());
 218         if (xParentContext.is())
 219             return xParentContext->getLocale ();
 220     }
 221
 222     //  No locale and no parent.  Therefore throw exception to indicate this
 223     //  cluelessness.
 224     throw IllegalAccessibleComponentStateException();
 225 }
 226
 227 //===== XAccessibleEventBroadcaster ===========================================
 228
 229 void SAL_CALL AccessibleSlideSorterObject::addAccessibleEventListener(
 230     const Reference<XAccessibleEventListener>& rxListener)
 231 {
 232     if (!rxListener.is())
 233         return;
 234
 235     const std::unique_lock aGuard(m_aMutex);
 236
 237     if (IsDisposed())
 238     {
 239         uno::Reference<uno::XInterface> x (static_cast<lang::XComponent *>(this), uno::UNO_QUERY);
 240         rxListener->disposing (lang::EventObject (x));
 241     }
 242     else
 243     {
 244         if (mnClientId == 0)
 245             mnClientId = comphelper::AccessibleEventNotifier::registerClient();
 246         comphelper::AccessibleEventNotifier::addEventListener(mnClientId, rxListener);
 247     }
 248 }
 249
 250 void SAL_CALL AccessibleSlideSorterObject::removeAccessibleEventListener(
 251     const Reference<XAccessibleEventListener>& rxListener)
 252 {
 253     ThrowIfDisposed();
 254     if (!rxListener.is())
 255         return;
 256
 257     const std::unique_lock aGuard(m_aMutex);
 258
 259     if (!mnClientId)
 260         return;
 261
 262     sal_Int32 nListenerCount = comphelper::AccessibleEventNotifier::removeEventListener( mnClientId, rxListener );
 263     if ( !nListenerCount )
 264     {
 265         // no listeners anymore
 266         // -> revoke ourself. This may lead to the notifier thread dying (if we were the last client),
 267         // and at least to us not firing any events anymore, in case somebody calls
 268         // NotifyAccessibleEvent, again
 269         comphelper::AccessibleEventNotifier::revokeClient( mnClientId );
 270         mnClientId = 0;
 271     }
 272 }
 273
 274 //===== XAccessibleComponent ==================================================
 275
 276 sal_Bool SAL_CALL AccessibleSlideSorterObject::containsPoint(const awt::Point& aPoint)
 277 {
 278     ThrowIfDisposed();
 279     const awt::Size aSize (getSize());
 280     return (aPoint.X >= 0)
 281         && (aPoint.X < aSize.Width)
 282         && (aPoint.Y >= 0)
 283         && (aPoint.Y < aSize.Height);
 284 }
 285
 286 Reference<XAccessible> SAL_CALL
 287     AccessibleSlideSorterObject::getAccessibleAtPoint(const awt::Point& )
 288 {
 289     return nullptr;
 290 }
 291
 292 awt::Rectangle SAL_CALL AccessibleSlideSorterObject::getBounds()
 293 {
 294     ThrowIfDisposed ();
 295
 296     const SolarMutexGuard aSolarGuard;
 297
 298     ::tools::Rectangle aBBox (
 299         mrSlideSorter.GetView().GetLayouter().GetPageObjectLayouter()->GetBoundingBox(
 300             mrSlideSorter.GetModel().GetPageDescriptor(mnPageNumber),
 301             ::sd::slidesorter::view::PageObjectLayouter::Part::PageObject,
 302             ::sd::slidesorter::view::PageObjectLayouter::WindowCoordinateSystem));
 303
 304     if (mxParent.is())
 305     {
 306         Reference<XAccessibleComponent> xParentComponent(mxParent->getAccessibleContext(), UNO_QUERY);
 307         if (xParentComponent.is())
 308         {
 309             awt::Rectangle aParentBBox (xParentComponent->getBounds());
 310             aBBox.Intersection(::tools::Rectangle(
 311                 aParentBBox.X,
 312                 aParentBBox.Y,
 313                 aParentBBox.Width,
 314                 aParentBBox.Height));
 315         }
 316     }
 317
 318     return awt::Rectangle(
 319         aBBox.Left(),
 320         aBBox.Top(),
 321         aBBox.GetWidth(),
 322         aBBox.GetHeight());
 323 }
 324
 325 awt::Point SAL_CALL AccessibleSlideSorterObject::getLocation ()
 326 {
 327     ThrowIfDisposed ();
 328     const awt::Rectangle aBBox (getBounds());
 329     return awt::Point(aBBox.X, aBBox.Y);
 330 }
 331
 332 awt::Point SAL_CALL AccessibleSlideSorterObject::getLocationOnScreen()
 333 {
 334     ThrowIfDisposed ();
 335
 336     const SolarMutexGuard aSolarGuard;
 337
 338     awt::Point aLocation (getLocation());
 339
 340     if (mxParent.is())
 341     {
 342         Reference<XAccessibleComponent> xParentComponent(mxParent->getAccessibleContext(),UNO_QUERY);
 343         if (xParentComponent.is())
 344         {
 345             const awt::Point aParentLocationOnScreen(xParentComponent->getLocationOnScreen());
 346             aLocation.X += aParentLocationOnScreen.X;
 347             aLocation.Y += aParentLocationOnScreen.Y;
 348         }
 349     }
 350
 351     return aLocation;
 352 }
 353
 354 awt::Size SAL_CALL AccessibleSlideSorterObject::getSize()
 355 {
 356     ThrowIfDisposed ();
 357     const awt::Rectangle aBBox (getBounds());
 358     return awt::Size(aBBox.Width,aBBox.Height);
 359 }
 360
 361 void SAL_CALL AccessibleSlideSorterObject::grabFocus()
 362 {
 363     // nothing to do
 364 }
 365
 366 sal_Int32 SAL_CALL AccessibleSlideSorterObject::getForeground()
 367 {
 368     ThrowIfDisposed ();
 369     svtools::ColorConfig aColorConfig;
 370     Color nColor = aColorConfig.GetColorValue( svtools::FONTCOLOR ).nColor;
 371     return static_cast<sal_Int32>(nColor);
 372 }
 373
 374 sal_Int32 SAL_CALL AccessibleSlideSorterObject::getBackground()
 375 {
 376     ThrowIfDisposed ();
 377     Color nColor = Application::GetSettings().GetStyleSettings().GetWindowColor();
 378     return sal_Int32(nColor);
 379 }
 380
 381 // XServiceInfo
 382 OUString SAL_CALL
 383        AccessibleSlideSorterObject::getImplementationName()
 384 {
 385     return u"AccessibleSlideSorterObject"_ustr;
 386 }
 387
 388 sal_Bool SAL_CALL AccessibleSlideSorterObject::supportsService (const OUString& sServiceName)
 389 {
 390     return cppu::supportsService(this, sServiceName);
 391 }
 392
 393 uno::Sequence< OUString> SAL_CALL
 394        AccessibleSlideSorterObject::getSupportedServiceNames()
 395 {
 396     ThrowIfDisposed ();
 397
 398     return uno::Sequence<OUString> {
 399         u"com.sun.star.accessibility.Accessible"_ustr,
 400         u"com.sun.star.accessibility.AccessibleContext"_ustr
 401     };
 402 }
 403
 404 void AccessibleSlideSorterObject::ThrowIfDisposed()
 405 {
 406     if (m_bDisposed)
 407     {
 408         SAL_WARN("sd", "Calling disposed object. Throwing exception:");
 409         throw lang::DisposedException (u"object has been already disposed"_ustr,
 410             static_cast<uno::XWeak*>(this));
 411     }
 412 }
 413
 414 bool AccessibleSlideSorterObject::IsDisposed() const
 415 {
 416     return m_bDisposed;
 417 }
 418
 419 SdPage* AccessibleSlideSorterObject::GetPage() const
 420 {
 421     ::sd::slidesorter::model::SharedPageDescriptor pDescriptor(
 422         mrSlideSorter.GetModel().GetPageDescriptor(mnPageNumber));
 423     if (pDescriptor)
 424         return pDescriptor->GetPage();
 425     else
 426         return nullptr;
 427 }
 428
 429 } // end of namespace ::accessibility
 430
 431 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */