basctl/source/accessibility/accessibledialogcontrolshape.cxx

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