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