accessibility/source/standard/vclxaccessiblestatusbaritem.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 <standard/vclxaccessiblestatusbaritem.hxx>
  21 #include <toolkit/helper/convert.hxx>
  22 #include <helper/characterattributeshelper.hxx>
  23
  24 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  25 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  26 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  27 #include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
  28 #include <com/sun/star/datatransfer/clipboard/XFlushableClipboard.hpp>
  29 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  30 #include <comphelper/accessiblecontexthelper.hxx>
  31 #include <cppuhelper/supportsservice.hxx>
  32 #include <unotools/accessiblerelationsethelper.hxx>
  33 #include <vcl/ctrl.hxx>
  34 #include <vcl/svapp.hxx>
  35 #include <vcl/unohelp2.hxx>
  36 #include <vcl/status.hxx>
  37 #include <vcl/settings.hxx>
  38 #include <i18nlangtag/languagetag.hxx>
  39
  40 using namespace ::com::sun::star::accessibility;
  41 using namespace ::com::sun::star::uno;
  42 using namespace ::com::sun::star::lang;
  43 using namespace ::com::sun::star::beans;
  44 using namespace ::com::sun::star;
  45 using namespace ::comphelper;
  46
  47
  48
  49
  50 VCLXAccessibleStatusBarItem::VCLXAccessibleStatusBarItem( StatusBar* pStatusBar, sal_uInt16 nItemId )
  51     :m_pStatusBar( pStatusBar )
  52     ,m_nItemId( nItemId )
  53 {
  54
  55     m_sItemName = GetItemName();
  56     m_sItemText = GetItemText();
  57     m_bShowing  = IsShowing();
  58 }
  59
  60
  61 bool VCLXAccessibleStatusBarItem::IsShowing()
  62 {
  63     bool bShowing = false;
  64
  65     if ( m_pStatusBar )
  66         bShowing = m_pStatusBar->IsItemVisible( m_nItemId );
  67
  68     return bShowing;
  69 }
  70
  71
  72 void VCLXAccessibleStatusBarItem::SetShowing( bool bShowing )
  73 {
  74     if ( m_bShowing != bShowing )
  75     {
  76         Any aOldValue, aNewValue;
  77         if ( m_bShowing )
  78             aOldValue <<= AccessibleStateType::SHOWING;
  79         else
  80             aNewValue <<= AccessibleStateType::SHOWING;
  81         m_bShowing = bShowing;
  82         NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  83     }
  84 }
  85
  86
  87 void VCLXAccessibleStatusBarItem::SetItemName( const OUString& sItemName )
  88 {
  89     if ( m_sItemName != sItemName )
  90     {
  91         Any aOldValue, aNewValue;
  92         aOldValue <<= m_sItemName;
  93         aNewValue <<= sItemName;
  94         m_sItemName = sItemName;
  95         NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
  96     }
  97 }
  98
  99
 100 OUString VCLXAccessibleStatusBarItem::GetItemName()
 101 {
 102     OUString sName;
 103     if ( m_pStatusBar )
 104         sName = m_pStatusBar->GetAccessibleName( m_nItemId );
 105
 106     return sName;
 107 }
 108
 109
 110 void VCLXAccessibleStatusBarItem::SetItemText( const OUString& sItemText )
 111 {
 112     Any aOldValue, aNewValue;
 113     if ( implInitTextChangedEvent( m_sItemText, sItemText, aOldValue, aNewValue ) )
 114     {
 115         m_sItemText = sItemText;
 116         NotifyAccessibleEvent( AccessibleEventId::TEXT_CHANGED, aOldValue, aNewValue );
 117     }
 118 }
 119
 120
 121 OUString VCLXAccessibleStatusBarItem::GetItemText()
 122 {
 123     OUString sText;
 124     if ( m_pStatusBar )
 125         sText = m_pStatusBar->GetItemText( m_nItemId );
 126
 127     return sText;
 128 }
 129
 130
 131 void VCLXAccessibleStatusBarItem::FillAccessibleStateSet( sal_Int64& rStateSet )
 132 {
 133     rStateSet |= AccessibleStateType::ENABLED;
 134     rStateSet |= AccessibleStateType::SENSITIVE;
 135
 136     rStateSet |= AccessibleStateType::VISIBLE;
 137
 138     if ( IsShowing() )
 139         rStateSet |= AccessibleStateType::SHOWING;
 140 }
 141
 142
 143 // OCommonAccessibleComponent
 144
 145
 146 awt::Rectangle VCLXAccessibleStatusBarItem::implGetBounds()
 147 {
 148     awt::Rectangle aBounds( 0, 0, 0, 0 );
 149
 150     if ( m_pStatusBar )
 151         aBounds = AWTRectangle( m_pStatusBar->GetItemRect( m_nItemId ) );
 152
 153     return aBounds;
 154 }
 155
 156
 157 // OCommonAccessibleText
 158
 159
 160 OUString VCLXAccessibleStatusBarItem::implGetText()
 161 {
 162     return GetItemText();
 163 }
 164
 165
 166 lang::Locale VCLXAccessibleStatusBarItem::implGetLocale()
 167 {
 168     return Application::GetSettings().GetLanguageTag().getLocale();
 169 }
 170
 171
 172 void VCLXAccessibleStatusBarItem::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
 173 {
 174     nStartIndex = 0;
 175     nEndIndex = 0;
 176 }
 177
 178
 179 // XComponent
 180
 181
 182 void VCLXAccessibleStatusBarItem::disposing()
 183 {
 184     AccessibleTextHelper_BASE::disposing();
 185
 186     m_pStatusBar = nullptr;
 187     m_sItemName.clear();
 188     m_sItemText.clear();
 189 }
 190
 191
 192 // XServiceInfo
 193
 194
 195 OUString VCLXAccessibleStatusBarItem::getImplementationName()
 196 {
 197     return "com.sun.star.comp.toolkit.AccessibleStatusBarItem";
 198 }
 199
 200
 201 sal_Bool VCLXAccessibleStatusBarItem::supportsService( const OUString& rServiceName )
 202 {
 203     return cppu::supportsService(this, rServiceName);
 204 }
 205
 206
 207 Sequence< OUString > VCLXAccessibleStatusBarItem::getSupportedServiceNames()
 208 {
 209     return { "com.sun.star.awt.AccessibleStatusBarItem" };
 210 }
 211
 212
 213 // XAccessible
 214
 215
 216 Reference< XAccessibleContext > VCLXAccessibleStatusBarItem::getAccessibleContext(  )
 217 {
 218     OExternalLockGuard aGuard( this );
 219
 220     return this;
 221 }
 222
 223
 224 // XAccessibleContext
 225
 226
 227 sal_Int64 VCLXAccessibleStatusBarItem::getAccessibleChildCount()
 228 {
 229     OExternalLockGuard aGuard( this );
 230
 231     return 0;
 232 }
 233
 234
 235 Reference< XAccessible > VCLXAccessibleStatusBarItem::getAccessibleChild( sal_Int64 )
 236 {
 237     throw IndexOutOfBoundsException();
 238 }
 239
 240
 241 Reference< XAccessible > VCLXAccessibleStatusBarItem::getAccessibleParent(  )
 242 {
 243     OExternalLockGuard aGuard( this );
 244
 245     Reference< XAccessible > xParent;
 246     if ( m_pStatusBar )
 247         xParent = m_pStatusBar->GetAccessible();
 248
 249     return xParent;
 250 }
 251
 252
 253 sal_Int64 VCLXAccessibleStatusBarItem::getAccessibleIndexInParent(  )
 254 {
 255     OExternalLockGuard aGuard( this );
 256
 257     sal_Int64 nIndexInParent = -1;
 258     if ( m_pStatusBar )
 259         nIndexInParent = m_pStatusBar->GetItemPos( m_nItemId );
 260
 261     return nIndexInParent;
 262 }
 263
 264
 265 sal_Int16 VCLXAccessibleStatusBarItem::getAccessibleRole(  )
 266 {
 267     OExternalLockGuard aGuard( this );
 268
 269     return AccessibleRole::LABEL;
 270 }
 271
 272
 273 OUString VCLXAccessibleStatusBarItem::getAccessibleDescription(  )
 274 {
 275     OExternalLockGuard aGuard( this );
 276
 277     OUString sDescription;
 278     if ( m_pStatusBar )
 279         sDescription = m_pStatusBar->GetHelpText( m_nItemId );
 280
 281     return sDescription;
 282 }
 283
 284
 285 OUString VCLXAccessibleStatusBarItem::getAccessibleName(  )
 286 {
 287     OExternalLockGuard aGuard( this );
 288
 289     return GetItemName();
 290 }
 291
 292
 293 Reference< XAccessibleRelationSet > VCLXAccessibleStatusBarItem::getAccessibleRelationSet(  )
 294 {
 295     OExternalLockGuard aGuard( this );
 296
 297     return new utl::AccessibleRelationSetHelper;
 298 }
 299
 300
 301 sal_Int64 VCLXAccessibleStatusBarItem::getAccessibleStateSet(  )
 302 {
 303     OExternalLockGuard aGuard( this );
 304
 305     sal_Int64 nStateSet = 0;
 306
 307     if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 308     {
 309         FillAccessibleStateSet( nStateSet );
 310     }
 311     else
 312     {
 313         nStateSet |= AccessibleStateType::DEFUNC;
 314     }
 315
 316     return nStateSet;
 317 }
 318
 319
 320 Locale VCLXAccessibleStatusBarItem::getLocale(  )
 321 {
 322     OExternalLockGuard aGuard( this );
 323
 324     return Application::GetSettings().GetLanguageTag().getLocale();
 325 }
 326
 327
 328 // XAccessibleComponent
 329
 330
 331 Reference< XAccessible > VCLXAccessibleStatusBarItem::getAccessibleAtPoint( const awt::Point& )
 332 {
 333     OExternalLockGuard aGuard( this );
 334
 335     return Reference< XAccessible >();
 336 }
 337
 338
 339 void VCLXAccessibleStatusBarItem::grabFocus(  )
 340 {
 341     // no focus for status bar items
 342 }
 343
 344
 345 sal_Int32 VCLXAccessibleStatusBarItem::getForeground(   )
 346 {
 347     OExternalLockGuard aGuard( this );
 348
 349     sal_Int32 nColor = 0;
 350     Reference< XAccessible > xParent = getAccessibleParent();
 351     if ( xParent.is() )
 352     {
 353         Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 354         if ( xParentComp.is() )
 355             nColor = xParentComp->getForeground();
 356     }
 357
 358     return nColor;
 359 }
 360
 361
 362 sal_Int32 VCLXAccessibleStatusBarItem::getBackground(  )
 363 {
 364     OExternalLockGuard aGuard( this );
 365
 366     sal_Int32 nColor = 0;
 367     Reference< XAccessible > xParent = getAccessibleParent();
 368     if ( xParent.is() )
 369     {
 370         Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 371         if ( xParentComp.is() )
 372             nColor = xParentComp->getBackground();
 373     }
 374
 375     return nColor;
 376 }
 377
 378
 379 // XAccessibleExtendedComponent
 380
 381
 382 Reference< awt::XFont > VCLXAccessibleStatusBarItem::getFont(  )
 383 {
 384     OExternalLockGuard aGuard( this );
 385
 386     Reference< awt::XFont > xFont;
 387     Reference< XAccessible > xParent = getAccessibleParent();
 388     if ( xParent.is() )
 389     {
 390         Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 391         if ( xParentComp.is() )
 392             xFont = xParentComp->getFont();
 393     }
 394
 395     return xFont;
 396 }
 397
 398
 399 OUString VCLXAccessibleStatusBarItem::getTitledBorderText(  )
 400 {
 401     OExternalLockGuard aGuard( this );
 402
 403     return GetItemText();
 404 }
 405
 406
 407 OUString VCLXAccessibleStatusBarItem::getToolTipText(  )
 408 {
 409     OExternalLockGuard aGuard( this );
 410
 411     return OUString();
 412 }
 413
 414
 415 // XAccessibleText
 416
 417 OUString VCLXAccessibleStatusBarItem::getText()
 418 {
 419     OExternalLockGuard aGuard( this );
 420
 421     return GetItemText();
 422 }
 423
 424 OUString VCLXAccessibleStatusBarItem::getTextRange(sal_Int32 nStartIndex, sal_Int32 nEndIndex)
 425 {
 426     OExternalLockGuard aGuard( this );
 427
 428     return OCommonAccessibleText::implGetTextRange(GetItemText(), nStartIndex, nEndIndex);
 429 }
 430
 431
 432 sal_Int32 VCLXAccessibleStatusBarItem::getCharacterCount()
 433 {
 434     OExternalLockGuard aGuard( this );
 435
 436     return GetItemText().getLength();
 437 }
 438
 439 sal_Unicode VCLXAccessibleStatusBarItem::getCharacter( sal_Int32 nIndex )
 440 {
 441      OExternalLockGuard aGuard( this );
 442
 443      return OCommonAccessibleText::implGetCharacter( GetItemText(), nIndex );
 444 }
 445
 446 sal_Int32 VCLXAccessibleStatusBarItem::getCaretPosition()
 447 {
 448     OExternalLockGuard aGuard( this );
 449
 450     return -1;
 451 }
 452
 453
 454 sal_Bool VCLXAccessibleStatusBarItem::setCaretPosition( sal_Int32 nIndex )
 455 {
 456     OExternalLockGuard aGuard( this );
 457
 458     if ( !implIsValidRange( nIndex, nIndex, GetItemText().getLength() ) )
 459         throw IndexOutOfBoundsException();
 460
 461     return false;
 462 }
 463
 464
 465 Sequence< PropertyValue > VCLXAccessibleStatusBarItem::getCharacterAttributes( sal_Int32 nIndex, const Sequence< OUString >& aRequestedAttributes )
 466 {
 467     OExternalLockGuard aGuard( this );
 468
 469     Sequence< PropertyValue > aValues;
 470     OUString sText( implGetText() );
 471
 472     if ( !implIsValidIndex( nIndex, sText.getLength() ) )
 473         throw IndexOutOfBoundsException();
 474
 475     if ( m_pStatusBar )
 476     {
 477         vcl::Font aFont = m_pStatusBar->GetFont();
 478         sal_Int32 nBackColor = getBackground();
 479         sal_Int32 nColor = getForeground();
 480         aValues = CharacterAttributesHelper( aFont, nBackColor, nColor )
 481             .GetCharacterAttributes( aRequestedAttributes );
 482     }
 483
 484     return aValues;
 485 }
 486
 487
 488 awt::Rectangle VCLXAccessibleStatusBarItem::getCharacterBounds( sal_Int32 nIndex )
 489 {
 490     OExternalLockGuard aGuard( this );
 491
 492     if ( !implIsValidIndex( nIndex, implGetText().getLength() ) )
 493         throw IndexOutOfBoundsException();
 494
 495     awt::Rectangle aBounds( 0, 0, 0, 0 );
 496     if ( m_pStatusBar )
 497     {
 498         vcl::ControlLayoutData aLayoutData;
 499         tools::Rectangle aItemRect = m_pStatusBar->GetItemRect( m_nItemId );
 500         m_pStatusBar->RecordLayoutData( &aLayoutData, aItemRect );
 501         tools::Rectangle aCharRect = aLayoutData.GetCharacterBounds( nIndex );
 502         aCharRect.Move( -aItemRect.Left(), -aItemRect.Top() );
 503         aBounds = AWTRectangle( aCharRect );
 504     }
 505
 506     return aBounds;
 507 }
 508
 509
 510 sal_Int32 VCLXAccessibleStatusBarItem::getIndexAtPoint( const awt::Point& aPoint )
 511 {
 512     OExternalLockGuard aGuard( this );
 513
 514     sal_Int32 nIndex = -1;
 515     if ( m_pStatusBar )
 516     {
 517         vcl::ControlLayoutData aLayoutData;
 518         tools::Rectangle aItemRect = m_pStatusBar->GetItemRect( m_nItemId );
 519         m_pStatusBar->RecordLayoutData( &aLayoutData, aItemRect );
 520         Point aPnt( VCLPoint( aPoint ) );
 521         aPnt += aItemRect.TopLeft();
 522         nIndex = aLayoutData.GetIndexForPoint( aPnt );
 523     }
 524
 525     return nIndex;
 526 }
 527
 528
 529 sal_Bool VCLXAccessibleStatusBarItem::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 530 {
 531     OExternalLockGuard aGuard( this );
 532
 533     if ( !implIsValidRange( nStartIndex, nEndIndex, implGetText().getLength() ) )
 534         throw IndexOutOfBoundsException();
 535
 536     return false;
 537 }
 538
 539
 540 sal_Bool VCLXAccessibleStatusBarItem::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 541 {
 542     OExternalLockGuard aGuard( this );
 543
 544     bool bReturn = false;
 545
 546     if ( m_pStatusBar )
 547     {
 548         Reference< datatransfer::clipboard::XClipboard > xClipboard = m_pStatusBar->GetClipboard();
 549         if ( xClipboard.is() )
 550         {
 551             OUString sText( implGetTextRange( GetItemText(), nStartIndex, nEndIndex ) );
 552
 553             rtl::Reference<vcl::unohelper::TextDataObject> pDataObj = new vcl::unohelper::TextDataObject( sText );
 554
 555             SolarMutexReleaser aReleaser;
 556             xClipboard->setContents( pDataObj, nullptr );
 557
 558             Reference< datatransfer::clipboard::XFlushableClipboard > xFlushableClipboard( xClipboard, uno::UNO_QUERY );
 559             if( xFlushableClipboard.is() )
 560                 xFlushableClipboard->flushClipboard();
 561
 562             bReturn = true;
 563         }
 564     }
 565
 566     return bReturn;
 567 }
 568
 569
 570 sal_Bool VCLXAccessibleStatusBarItem::scrollSubstringTo( sal_Int32, sal_Int32, AccessibleScrollType )
 571 {
 572     return false;
 573 }
 574
 575 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */