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