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