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