svtools/source/control/accessibleruler.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 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  20 #include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp>
  21 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  22 #include <comphelper/accessibleeventnotifier.hxx>
  23 #include <cppuhelper/supportsservice.hxx>
  24 #include <toolkit/helper/vclunohelper.hxx>
  25 #include <utility>
  26 #include <vcl/svapp.hxx>
  27 #include <vcl/unohelp.hxx>
  28 #include <osl/mutex.hxx>
  29 #include <tools/gen.hxx>
  30
  31 #include <svtools/ruler.hxx>
  32 #include "accessibleruler.hxx"
  33
  34 using namespace ::cppu;
  35 using namespace ::osl;
  36 using namespace ::com::sun::star;
  37 using namespace ::com::sun::star::uno;
  38 using namespace ::com::sun::star::accessibility;
  39
  40
  41 //=====  internal  ============================================================
  42
  43 SvtRulerAccessible::SvtRulerAccessible(
  44     uno::Reference< XAccessible > xParent, Ruler& rRepr, OUString aName ) :
  45
  46     msName(std::move( aName )),
  47     mxParent(std::move( xParent )),
  48     mpRepr( &rRepr ),
  49     mnClientId( 0 )
  50 {
  51 }
  52
  53 SvtRulerAccessible::~SvtRulerAccessible()
  54 {
  55     if( !m_bDisposed )
  56     {
  57         osl_atomic_increment( &m_refCount );
  58         dispose();      // set mpRepr = NULL & release all children
  59     }
  60 }
  61
  62 //=====  XAccessible  =========================================================
  63
  64 uno::Reference< XAccessibleContext > SAL_CALL SvtRulerAccessible::getAccessibleContext()
  65 {
  66     return this;
  67 }
  68
  69 //=====  XAccessibleComponent  ================================================
  70
  71 sal_Bool SAL_CALL SvtRulerAccessible::containsPoint( const awt::Point& rPoint )
  72 {
  73     // no guard -> done in getBounds()
  74 //  return GetBoundingBox().IsInside( vcl::unohelper::ConvertToVCLPoint( rPoint ) );
  75     return tools::Rectangle(Point(0, 0), GetBoundingBox().GetSize())
  76         .Contains(vcl::unohelper::ConvertToVCLPoint(rPoint));
  77 }
  78
  79 uno::Reference< XAccessible > SAL_CALL SvtRulerAccessible::getAccessibleAtPoint( const awt::Point& )
  80 {
  81     std::unique_lock aGuard( m_aMutex );
  82     throwIfDisposed(aGuard);
  83
  84     return uno::Reference< XAccessible >();
  85 }
  86
  87 awt::Rectangle SAL_CALL SvtRulerAccessible::getBounds()
  88 {
  89     // no guard -> done in GetBoundingBox()
  90     return vcl::unohelper::ConvertToAWTRect(GetBoundingBox());
  91 }
  92
  93 awt::Point SAL_CALL SvtRulerAccessible::getLocation()
  94 {
  95     // no guard -> done in GetBoundingBox()
  96     return vcl::unohelper::ConvertToAWTPoint(GetBoundingBox().TopLeft());
  97 }
  98
  99 awt::Point SAL_CALL SvtRulerAccessible::getLocationOnScreen()
 100 {
 101     // no guard -> done in GetBoundingBoxOnScreen()
 102     return vcl::unohelper::ConvertToAWTPoint(GetBoundingBoxOnScreen().TopLeft());
 103 }
 104
 105 awt::Size SAL_CALL SvtRulerAccessible::getSize()
 106 {
 107     // no guard -> done in GetBoundingBox()
 108     return vcl::unohelper::ConvertToAWTSize(GetBoundingBox().GetSize());
 109 }
 110
 111 //=====  XAccessibleContext  ==================================================
 112 sal_Int64 SAL_CALL SvtRulerAccessible::getAccessibleChildCount()
 113 {
 114     std::unique_lock aGuard( m_aMutex );
 115     throwIfDisposed(aGuard);
 116
 117     return 0;
 118 }
 119
 120 uno::Reference< XAccessible > SAL_CALL SvtRulerAccessible::getAccessibleChild( sal_Int64 )
 121 {
 122     uno::Reference< XAccessible >   xChild ;
 123
 124     return xChild;
 125 }
 126
 127 uno::Reference< XAccessible > SAL_CALL SvtRulerAccessible::getAccessibleParent()
 128 {
 129     return mxParent;
 130 }
 131
 132 sal_Int64 SAL_CALL SvtRulerAccessible::getAccessibleIndexInParent()
 133 {
 134     std::unique_lock aGuard( m_aMutex );
 135
 136     //  Use a simple but slow solution for now.  Optimize later.
 137
 138     //  Iterate over all the parent's children and search for this object.
 139     if( mxParent.is() )
 140     {
 141         uno::Reference< XAccessibleContext >        xParentContext( mxParent->getAccessibleContext() );
 142         if( xParentContext.is() )
 143         {
 144             sal_Int64 nChildCount = xParentContext->getAccessibleChildCount();
 145             for( sal_Int64 i = 0 ; i < nChildCount ; ++i )
 146             {
 147                 uno::Reference< XAccessible >   xChild( xParentContext->getAccessibleChild( i ) );
 148                 if( xChild.get() == static_cast<XAccessible*>(this) )
 149                     return i;
 150             }
 151         }
 152     }
 153
 154     //   Return -1 to indicate that this object's parent does not know about the
 155     //   object.
 156     return -1;
 157 }
 158
 159 sal_Int16 SAL_CALL SvtRulerAccessible::getAccessibleRole()
 160 {
 161     return AccessibleRole::RULER;
 162 }
 163
 164 OUString SAL_CALL SvtRulerAccessible::getAccessibleDescription()
 165 {
 166     return OUString();
 167 }
 168
 169 OUString SAL_CALL SvtRulerAccessible::getAccessibleName()
 170 {
 171     return msName;
 172 }
 173
 174 /** Return empty uno::Reference to indicate that the relation set is not
 175     supported.
 176 */
 177 uno::Reference< XAccessibleRelationSet > SAL_CALL SvtRulerAccessible::getAccessibleRelationSet()
 178 {
 179     return uno::Reference< XAccessibleRelationSet >();
 180 }
 181
 182
 183 sal_Int64 SAL_CALL SvtRulerAccessible::getAccessibleStateSet()
 184 {
 185     std::unique_lock aGuard( m_aMutex );
 186
 187     sal_Int64 nStateSet = 0;
 188
 189     if( !m_bDisposed )
 190     {
 191         nStateSet |= AccessibleStateType::ENABLED;
 192
 193         nStateSet |= AccessibleStateType::SHOWING;
 194
 195         if( mpRepr->IsVisible() )
 196             nStateSet |= AccessibleStateType::VISIBLE;
 197
 198         if ( mpRepr->GetStyle() & WB_HORZ )
 199             nStateSet |= AccessibleStateType::HORIZONTAL;
 200         else
 201             nStateSet |= AccessibleStateType::VERTICAL;
 202     }
 203
 204     return nStateSet;
 205 }
 206
 207 lang::Locale SAL_CALL SvtRulerAccessible::getLocale()
 208 {
 209     std::unique_lock aGuard( m_aMutex );
 210
 211     if( mxParent.is() )
 212     {
 213         uno::Reference< XAccessibleContext >    xParentContext( mxParent->getAccessibleContext() );
 214         if( xParentContext.is() )
 215             return xParentContext->getLocale();
 216     }
 217
 218     //  No parent.  Therefore throw exception to indicate this cluelessness.
 219     throw IllegalAccessibleComponentStateException();
 220 }
 221
 222 void SAL_CALL SvtRulerAccessible::addAccessibleEventListener( const uno::Reference< XAccessibleEventListener >& xListener )
 223 {
 224     if (xListener.is())
 225     {
 226         std::unique_lock aGuard( m_aMutex );
 227         if (!mnClientId)
 228             mnClientId = comphelper::AccessibleEventNotifier::registerClient( );
 229         comphelper::AccessibleEventNotifier::addEventListener( mnClientId, xListener );
 230     }
 231 }
 232
 233 void SAL_CALL SvtRulerAccessible::removeAccessibleEventListener( const uno::Reference< XAccessibleEventListener >& xListener )
 234 {
 235     if (!xListener.is())
 236         return;
 237
 238     std::unique_lock aGuard( m_aMutex );
 239
 240     if (!mnClientId)
 241         return;
 242
 243     sal_Int32 nListenerCount = comphelper::AccessibleEventNotifier::removeEventListener( mnClientId, xListener );
 244     if ( !nListenerCount )
 245     {
 246         // no listeners anymore
 247         // -> revoke ourself. This may lead to the notifier thread dying (if we were the last client),
 248         // and at least to us not firing any events anymore, in case somebody calls
 249         // NotifyAccessibleEvent, again
 250         comphelper::AccessibleEventNotifier::revokeClient( mnClientId );
 251         mnClientId = 0;
 252     }
 253 }
 254
 255 void SAL_CALL SvtRulerAccessible::grabFocus()
 256 {
 257     VclPtr<Ruler> xRepr;
 258     {
 259         std::unique_lock aGuard( m_aMutex );
 260         xRepr = mpRepr;
 261     }
 262     if (!xRepr)
 263         throw css::lang::DisposedException(OUString(), static_cast<cppu::OWeakObject*>(this));
 264
 265     SolarMutexGuard     aSolarGuard;
 266     xRepr->GrabFocus();
 267 }
 268
 269 sal_Int32 SvtRulerAccessible::getForeground(  )
 270 {
 271     VclPtr<Ruler> xRepr;
 272     {
 273         std::unique_lock aGuard( m_aMutex );
 274         xRepr = mpRepr;
 275     }
 276     if (!xRepr)
 277         throw css::lang::DisposedException(OUString(), static_cast<cppu::OWeakObject*>(this));
 278
 279     SolarMutexGuard     aSolarGuard;
 280     return sal_Int32(xRepr->GetControlForeground());
 281 }
 282 sal_Int32 SvtRulerAccessible::getBackground(  )
 283 {
 284     VclPtr<Ruler> xRepr;
 285     {
 286         std::unique_lock aGuard( m_aMutex );
 287         xRepr = mpRepr;
 288     }
 289     if (!xRepr)
 290         throw css::lang::DisposedException(OUString(), static_cast<cppu::OWeakObject*>(this));
 291
 292     SolarMutexGuard     aSolarGuard;
 293     return sal_Int32(xRepr->GetControlBackground());
 294 }
 295
 296 // XServiceInfo
 297 OUString SAL_CALL SvtRulerAccessible::getImplementationName()
 298 {
 299     return u"com.sun.star.comp.ui.SvtRulerAccessible"_ustr;
 300 }
 301
 302 sal_Bool SAL_CALL SvtRulerAccessible::supportsService( const OUString& sServiceName )
 303 {
 304     return cppu::supportsService( this, sServiceName );
 305 }
 306
 307 Sequence< OUString > SAL_CALL SvtRulerAccessible::getSupportedServiceNames()
 308 {
 309     return { u"com.sun.star.accessibility.AccessibleContext"_ustr };
 310 }
 311
 312 //=====  XTypeProvider  =======================================================
 313 Sequence< sal_Int8 > SAL_CALL SvtRulerAccessible::getImplementationId()
 314 {
 315     return css::uno::Sequence<sal_Int8>();
 316 }
 317
 318 void SvtRulerAccessible::disposing(std::unique_lock<std::mutex>&)
 319 {
 320     mpRepr = nullptr;      // object dies with representation
 321
 322     // Send a disposing to all listeners.
 323     if ( mnClientId )
 324     {
 325         comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing( mnClientId, *this );
 326         mnClientId =  0;
 327     }
 328     mxParent.clear();
 329 }
 330
 331 tools::Rectangle SvtRulerAccessible::GetBoundingBoxOnScreen()
 332 {
 333     VclPtr<Ruler> xRepr;
 334     {
 335         std::unique_lock aGuard( m_aMutex );
 336         xRepr = mpRepr;
 337     }
 338     if (!xRepr)
 339         throw css::lang::DisposedException(OUString(), static_cast<cppu::OWeakObject*>(this));
 340
 341     SolarMutexGuard     aSolarGuard;
 342     return tools::Rectangle( xRepr->GetParent()->OutputToAbsoluteScreenPixel( xRepr->GetPosPixel() ), xRepr->GetSizePixel() );
 343 }
 344
 345 tools::Rectangle SvtRulerAccessible::GetBoundingBox()
 346 {
 347     VclPtr<Ruler> xRepr;
 348     {
 349         std::unique_lock aGuard( m_aMutex );
 350         xRepr = mpRepr;
 351     }
 352     if (!xRepr)
 353         throw css::lang::DisposedException(OUString(), static_cast<cppu::OWeakObject*>(this));
 354
 355     SolarMutexGuard     aSolarGuard;
 356     return tools::Rectangle( xRepr->GetPosPixel(), xRepr->GetSizePixel() );
 357 }
 358
 359 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */