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