basctl/source/accessibility/accessibledialogcontrolshape.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 <accessibledialogcontrolshape.hxx>
  21 #include <baside3.hxx>
  22 #include <dlgeddef.hxx>
  23 #include <dlgedview.hxx>
  24 #include <dlgedobj.hxx>
  25 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  26 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  27 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  28 #include <cppuhelper/supportsservice.hxx>
  29 #include <unotools/accessiblestatesethelper.hxx>
  30 #include <unotools/accessiblerelationsethelper.hxx>
  31 #include <toolkit/awt/vclxfont.hxx>
  32 #include <toolkit/helper/externallock.hxx>
  33 #include <toolkit/helper/convert.hxx>
  34 #include <toolkit/helper/vclunohelper.hxx>
  35 #include <vcl/svapp.hxx>
  36 #include <vcl/settings.hxx>
  37
  38 namespace basctl
  39 {
  40
  41 using namespace ::com::sun::star;
  42 using namespace ::com::sun::star::uno;
  43 using namespace ::com::sun::star::lang;
  44 using namespace ::com::sun::star::beans;
  45 using namespace ::com::sun::star::accessibility;
  46 using namespace ::comphelper;
  47
  48
  49 // class AccessibleDialogControlShape
  50
  51
  52 AccessibleDialogControlShape::AccessibleDialogControlShape (DialogWindow* pDialogWindow, DlgEdObj* pDlgEdObj)
  53     :OAccessibleExtendedComponentHelper( new VCLExternalSolarLock() )
  54     ,m_pDialogWindow( pDialogWindow )
  55     ,m_pDlgEdObj( pDlgEdObj )
  56 {
  57     m_pExternalLock = static_cast< VCLExternalSolarLock* >( getExternalLock() );
  58
  59     if ( m_pDlgEdObj )
  60         m_xControlModel.set( m_pDlgEdObj->GetUnoControlModel(), UNO_QUERY );
  61
  62     if ( m_xControlModel.is() )
  63         m_xControlModel->addPropertyChangeListener( OUString(), static_cast< beans::XPropertyChangeListener* >( this ) );
  64
  65     m_bFocused = IsFocused();
  66     m_bSelected = IsSelected();
  67     m_aBounds = GetBounds();
  68 }
  69
  70
  71 AccessibleDialogControlShape::~AccessibleDialogControlShape()
  72 {
  73     if ( m_xControlModel.is() )
  74         m_xControlModel->removePropertyChangeListener( OUString(), static_cast< beans::XPropertyChangeListener* >( this ) );
  75
  76     delete m_pExternalLock;
  77     m_pExternalLock = nullptr;
  78 }
  79
  80
  81 bool AccessibleDialogControlShape::IsFocused()
  82 {
  83     bool bFocused = false;
  84     if ( m_pDialogWindow )
  85     {
  86         SdrView& rView = m_pDialogWindow->GetView();
  87         if (rView.IsObjMarked(m_pDlgEdObj) && rView.GetMarkedObjectList().GetMarkCount() == 1)
  88             bFocused = true;
  89     }
  90
  91     return bFocused;
  92 }
  93
  94
  95 bool AccessibleDialogControlShape::IsSelected()
  96 {
  97     if ( m_pDialogWindow )
  98         return m_pDialogWindow->GetView().IsObjMarked(m_pDlgEdObj);
  99     return false;
 100 }
 101
 102
 103 void AccessibleDialogControlShape::SetFocused( bool bFocused )
 104 {
 105     if ( m_bFocused != bFocused )
 106     {
 107         Any aOldValue, aNewValue;
 108         if ( m_bFocused )
 109             aOldValue <<= AccessibleStateType::FOCUSED;
 110         else
 111             aNewValue <<= AccessibleStateType::FOCUSED;
 112         m_bFocused = bFocused;
 113         NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 114     }
 115 }
 116
 117
 118 void AccessibleDialogControlShape::SetSelected( bool bSelected )
 119 {
 120     if ( m_bSelected != bSelected )
 121     {
 122         Any aOldValue, aNewValue;
 123         if ( m_bSelected )
 124             aOldValue <<= AccessibleStateType::SELECTED;
 125         else
 126             aNewValue <<= AccessibleStateType::SELECTED;
 127         m_bSelected = bSelected;
 128         NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 129     }
 130 }
 131
 132
 133 awt::Rectangle AccessibleDialogControlShape::GetBounds()
 134 {
 135     awt::Rectangle aBounds( 0, 0, 0, 0 );
 136     if ( m_pDlgEdObj )
 137     {
 138         // get the bounding box of the shape in logic units
 139         Rectangle aRect = m_pDlgEdObj->GetSnapRect();
 140
 141         if ( m_pDialogWindow )
 142         {
 143             // transform coordinates relative to the parent
 144             MapMode aMap = m_pDialogWindow->GetMapMode();
 145             Point aOrg = aMap.GetOrigin();
 146             aRect.Move( aOrg.X(), aOrg.Y() );
 147
 148             // convert logic units to pixel
 149             aRect = m_pDialogWindow->LogicToPixel( aRect, MapMode(MapUnit::Map100thMM) );
 150
 151             // clip the shape's bounding box with the bounding box of its parent
 152             Rectangle aParentRect( Point( 0, 0 ), m_pDialogWindow->GetSizePixel() );
 153             aRect = aRect.GetIntersection( aParentRect );
 154             aBounds = AWTRectangle( aRect );
 155         }
 156     }
 157
 158     return aBounds;
 159 }
 160
 161
 162 void AccessibleDialogControlShape::SetBounds( const awt::Rectangle& aBounds )
 163 {
 164     if ( m_aBounds.X != aBounds.X || m_aBounds.Y != aBounds.Y || m_aBounds.Width != aBounds.Width || m_aBounds.Height != aBounds.Height )
 165     {
 166         m_aBounds = aBounds;
 167         NotifyAccessibleEvent( AccessibleEventId::BOUNDRECT_CHANGED, Any(), Any() );
 168     }
 169 }
 170
 171
 172 vcl::Window* AccessibleDialogControlShape::GetWindow() const
 173 {
 174     vcl::Window* pWindow = nullptr;
 175     if ( m_pDlgEdObj )
 176     {
 177         Reference< awt::XControl > xControl( m_pDlgEdObj->GetControl(), UNO_QUERY );
 178         if ( xControl.is() )
 179             pWindow = VCLUnoHelper::GetWindow( xControl->getPeer() ).get();
 180     }
 181
 182     return pWindow;
 183 }
 184
 185
 186 OUString AccessibleDialogControlShape::GetModelStringProperty( const sal_Char* pPropertyName )
 187 {
 188     OUString sReturn;
 189
 190     try
 191     {
 192         if ( m_xControlModel.is() )
 193         {
 194             OUString sPropertyName( OUString::createFromAscii( pPropertyName ) );
 195             Reference< XPropertySetInfo > xInfo = m_xControlModel->getPropertySetInfo();
 196             if ( xInfo.is() && xInfo->hasPropertyByName( sPropertyName ) )
 197                 m_xControlModel->getPropertyValue( sPropertyName ) >>= sReturn;
 198         }
 199     }
 200     catch ( const Exception& )
 201     {
 202         OSL_FAIL( "AccessibleDialogControlShape::GetModelStringProperty: caught an exception!" );
 203     }
 204
 205     return sReturn;
 206 }
 207
 208
 209 void AccessibleDialogControlShape::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 210 {
 211     rStateSet.AddState( AccessibleStateType::ENABLED );
 212
 213     rStateSet.AddState( AccessibleStateType::VISIBLE );
 214
 215     rStateSet.AddState( AccessibleStateType::SHOWING );
 216
 217     rStateSet.AddState( AccessibleStateType::FOCUSABLE );
 218
 219     if ( IsFocused() )
 220         rStateSet.AddState( AccessibleStateType::FOCUSED );
 221
 222     rStateSet.AddState( AccessibleStateType::SELECTABLE );
 223
 224     if ( IsSelected() )
 225         rStateSet.AddState( AccessibleStateType::SELECTED );
 226
 227     rStateSet.AddState( AccessibleStateType::RESIZABLE );
 228 }
 229
 230 // OCommonAccessibleComponent
 231 awt::Rectangle AccessibleDialogControlShape::implGetBounds() throw (RuntimeException, std::exception)
 232 {
 233     return GetBounds();
 234 }
 235
 236 // XInterface
 237 IMPLEMENT_FORWARD_XINTERFACE2( AccessibleDialogControlShape, OAccessibleExtendedComponentHelper, AccessibleDialogControlShape_BASE )
 238
 239 // XTypeProvider
 240 IMPLEMENT_FORWARD_XTYPEPROVIDER2( AccessibleDialogControlShape, OAccessibleExtendedComponentHelper, AccessibleDialogControlShape_BASE )
 241
 242 // XComponent
 243 void AccessibleDialogControlShape::disposing()
 244 {
 245     OAccessibleExtendedComponentHelper::disposing();
 246
 247     m_pDialogWindow = nullptr;
 248     m_pDlgEdObj = nullptr;
 249
 250     if ( m_xControlModel.is() )
 251         m_xControlModel->removePropertyChangeListener( OUString(), static_cast< beans::XPropertyChangeListener* >( this ) );
 252     m_xControlModel.clear();
 253 }
 254
 255
 256 // XEventListener
 257
 258
 259 void AccessibleDialogControlShape::disposing( const lang::EventObject& ) throw (RuntimeException, std::exception)
 260 {
 261     if ( m_xControlModel.is() )
 262         m_xControlModel->removePropertyChangeListener( OUString(), static_cast< beans::XPropertyChangeListener* >( this ) );
 263     m_xControlModel.clear();
 264 }
 265
 266
 267 // XPropertyChangeListener
 268
 269
 270 void AccessibleDialogControlShape::propertyChange( const beans::PropertyChangeEvent& rEvent ) throw (RuntimeException, std::exception)
 271 {
 272     if ( rEvent.PropertyName == DLGED_PROP_NAME )
 273     {
 274         NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, rEvent.OldValue, rEvent.NewValue );
 275     }
 276     else if ( rEvent.PropertyName == DLGED_PROP_POSITIONX ||
 277               rEvent.PropertyName == DLGED_PROP_POSITIONY ||
 278               rEvent.PropertyName == DLGED_PROP_WIDTH ||
 279               rEvent.PropertyName == DLGED_PROP_HEIGHT )
 280     {
 281         SetBounds( GetBounds() );
 282     }
 283     else if ( rEvent.PropertyName == DLGED_PROP_BACKGROUNDCOLOR ||
 284               rEvent.PropertyName == DLGED_PROP_TEXTCOLOR ||
 285               rEvent.PropertyName == DLGED_PROP_TEXTLINECOLOR )
 286     {
 287         NotifyAccessibleEvent( AccessibleEventId::VISIBLE_DATA_CHANGED, Any(), Any() );
 288     }
 289 }
 290
 291 // XServiceInfo
 292 OUString AccessibleDialogControlShape::getImplementationName() throw (RuntimeException, std::exception)
 293 {
 294     return OUString( "com.sun.star.comp.basctl.AccessibleShape" );
 295 }
 296
 297 sal_Bool AccessibleDialogControlShape::supportsService( const OUString& rServiceName ) throw (RuntimeException, std::exception)
 298 {
 299     return cppu::supportsService(this, rServiceName);
 300 }
 301
 302 Sequence< OUString > AccessibleDialogControlShape::getSupportedServiceNames() throw (RuntimeException, std::exception)
 303 {
 304     return { "com.sun.star.drawing.AccessibleShape" };
 305 }
 306
 307 // XAccessible
 308 Reference< XAccessibleContext > AccessibleDialogControlShape::getAccessibleContext(  ) throw (RuntimeException, std::exception)
 309 {
 310     OExternalLockGuard aGuard( this );
 311
 312     return this;
 313 }
 314
 315 // XAccessibleContext
 316 sal_Int32 AccessibleDialogControlShape::getAccessibleChildCount() throw (RuntimeException, std::exception)
 317 {
 318     OExternalLockGuard aGuard( this );
 319
 320     return 0;
 321 }
 322
 323
 324 Reference< XAccessible > AccessibleDialogControlShape::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 325 {
 326     OExternalLockGuard aGuard( this );
 327
 328     if ( i < 0 || i >= getAccessibleChildCount() )
 329         throw IndexOutOfBoundsException();
 330
 331     return Reference< XAccessible >();
 332 }
 333
 334
 335 Reference< XAccessible > AccessibleDialogControlShape::getAccessibleParent(  ) throw (RuntimeException, std::exception)
 336 {
 337     OExternalLockGuard aGuard( this );
 338
 339     Reference< XAccessible > xParent;
 340     if ( m_pDialogWindow )
 341         xParent = m_pDialogWindow->GetAccessible();
 342
 343     return xParent;
 344 }
 345
 346
 347 sal_Int32 AccessibleDialogControlShape::getAccessibleIndexInParent(  ) throw (RuntimeException, std::exception)
 348 {
 349     OExternalLockGuard aGuard( this );
 350
 351     sal_Int32 nIndexInParent = -1;
 352     Reference< XAccessible > xParent( getAccessibleParent() );
 353     if ( xParent.is() )
 354     {
 355         Reference< XAccessibleContext > xParentContext( xParent->getAccessibleContext() );
 356         if ( xParentContext.is() )
 357         {
 358             for ( sal_Int32 i = 0, nCount = xParentContext->getAccessibleChildCount(); i < nCount; ++i )
 359             {
 360                 Reference< XAccessible > xChild( xParentContext->getAccessibleChild( i ) );
 361                 if ( xChild.is() )
 362                 {
 363                     Reference< XAccessibleContext > xChildContext = xChild->getAccessibleContext();
 364                     if ( xChildContext == static_cast<XAccessibleContext*>(this) )
 365                     {
 366                         nIndexInParent = i;
 367                         break;
 368                     }
 369                 }
 370             }
 371         }
 372     }
 373
 374     return nIndexInParent;
 375 }
 376
 377
 378 sal_Int16 AccessibleDialogControlShape::getAccessibleRole(  ) throw (RuntimeException, std::exception)
 379 {
 380     OExternalLockGuard aGuard( this );
 381
 382     return AccessibleRole::SHAPE;
 383 }
 384
 385
 386 OUString AccessibleDialogControlShape::getAccessibleDescription(  ) throw (RuntimeException, std::exception)
 387 {
 388     OExternalLockGuard aGuard( this );
 389
 390     return GetModelStringProperty( "HelpText" );
 391 }
 392
 393
 394 OUString AccessibleDialogControlShape::getAccessibleName(  ) throw (RuntimeException, std::exception)
 395 {
 396     OExternalLockGuard aGuard( this );
 397
 398     return GetModelStringProperty( "Name" );
 399 }
 400
 401
 402 Reference< XAccessibleRelationSet > AccessibleDialogControlShape::getAccessibleRelationSet(  ) throw (RuntimeException, std::exception)
 403 {
 404     OExternalLockGuard aGuard( this );
 405
 406     utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
 407     Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
 408     return xSet;
 409 }
 410
 411
 412 Reference< XAccessibleStateSet > AccessibleDialogControlShape::getAccessibleStateSet(  ) throw (RuntimeException, std::exception)
 413 {
 414     OExternalLockGuard aGuard( this );
 415
 416     utl::AccessibleStateSetHelper* pStateSetHelper = new utl::AccessibleStateSetHelper;
 417     Reference< XAccessibleStateSet > xSet = pStateSetHelper;
 418
 419     if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 420     {
 421         FillAccessibleStateSet( *pStateSetHelper );
 422     }
 423     else
 424     {
 425         pStateSetHelper->AddState( AccessibleStateType::DEFUNC );
 426     }
 427
 428     return xSet;
 429 }
 430
 431
 432 Locale AccessibleDialogControlShape::getLocale(  ) throw (IllegalAccessibleComponentStateException, RuntimeException, std::exception)
 433 {
 434     OExternalLockGuard aGuard( this );
 435
 436     return Application::GetSettings().GetLanguageTag().getLocale();
 437 }
 438
 439
 440 // XAccessibleComponent
 441
 442
 443 Reference< XAccessible > AccessibleDialogControlShape::getAccessibleAtPoint( const awt::Point& ) throw (RuntimeException, std::exception)
 444 {
 445     OExternalLockGuard aGuard( this );
 446
 447     return Reference< XAccessible >();
 448 }
 449
 450
 451 void AccessibleDialogControlShape::grabFocus(  ) throw (RuntimeException, std::exception)
 452 {
 453     // no focus for shapes
 454 }
 455
 456
 457 sal_Int32 AccessibleDialogControlShape::getForeground(  ) throw (RuntimeException, std::exception)
 458 {
 459     OExternalLockGuard aGuard( this );
 460
 461     sal_Int32 nColor = 0;
 462     vcl::Window* pWindow = GetWindow();
 463     if ( pWindow )
 464     {
 465         if ( pWindow->IsControlForeground() )
 466             nColor = pWindow->GetControlForeground().GetColor();
 467         else
 468         {
 469             vcl::Font aFont;
 470             if ( pWindow->IsControlFont() )
 471                 aFont = pWindow->GetControlFont();
 472             else
 473                 aFont = pWindow->GetFont();
 474             nColor = aFont.GetColor().GetColor();
 475         }
 476     }
 477
 478     return nColor;
 479 }
 480
 481
 482 sal_Int32 AccessibleDialogControlShape::getBackground(  ) throw (RuntimeException, std::exception)
 483 {
 484     OExternalLockGuard aGuard( this );
 485
 486     sal_Int32 nColor = 0;
 487     vcl::Window* pWindow = GetWindow();
 488     if ( pWindow )
 489     {
 490         if ( pWindow->IsControlBackground() )
 491             nColor = pWindow->GetControlBackground().GetColor();
 492         else
 493             nColor = pWindow->GetBackground().GetColor().GetColor();
 494     }
 495
 496     return nColor;
 497 }
 498
 499
 500 // XAccessibleExtendedComponent
 501
 502
 503 Reference< awt::XFont > AccessibleDialogControlShape::getFont(  ) throw (RuntimeException, std::exception)
 504 {
 505     OExternalLockGuard aGuard( this );
 506
 507     Reference< awt::XFont > xFont;
 508     vcl::Window* pWindow = GetWindow();
 509     if ( pWindow )
 510     {
 511         Reference< awt::XDevice > xDev( pWindow->GetComponentInterface(), UNO_QUERY );
 512         if ( xDev.is() )
 513         {
 514             vcl::Font aFont;
 515             if ( pWindow->IsControlFont() )
 516                 aFont = pWindow->GetControlFont();
 517             else
 518                 aFont = pWindow->GetFont();
 519             VCLXFont* pVCLXFont = new VCLXFont;
 520             pVCLXFont->Init( *xDev.get(), aFont );
 521             xFont = pVCLXFont;
 522         }
 523     }
 524
 525     return xFont;
 526 }
 527
 528
 529 OUString AccessibleDialogControlShape::getTitledBorderText(  ) throw (RuntimeException, std::exception)
 530 {
 531     OExternalLockGuard aGuard( this );
 532
 533     return OUString();
 534 }
 535
 536
 537 OUString AccessibleDialogControlShape::getToolTipText(  ) throw (RuntimeException, std::exception)
 538 {
 539     OExternalLockGuard aGuard( this );
 540
 541     OUString sText;
 542     vcl::Window* pWindow = GetWindow();
 543     if ( pWindow )
 544         sText = pWindow->GetQuickHelpText();
 545
 546     return sText;
 547 }
 548
 549
 550 } // namespace basctl
 551
 552 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */