accessibility/source/standard/vclxaccessibletextcomponent.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/vclxaccessibletextcomponent.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/datatransfer/clipboard/XClipboard.hpp>
  26 #include <com/sun/star/datatransfer/clipboard/XFlushableClipboard.hpp>
  27 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  28 #include <vcl/window.hxx>
  29 #include <vcl/svapp.hxx>
  30 #include <vcl/unohelp2.hxx>
  31 #include <vcl/ctrl.hxx>
  32 #include <vcl/settings.hxx>
  33 #include <i18nlangtag/languagetag.hxx>
  34
  35 using namespace ::com::sun::star;
  36 using namespace ::com::sun::star::uno;
  37 using namespace ::com::sun::star::lang;
  38 using namespace ::com::sun::star::beans;
  39 using namespace ::com::sun::star::accessibility;
  40 using namespace ::comphelper;
  41
  42
  43 //  class VCLXAccessibleTextComponent
  44
  45
  46 VCLXAccessibleTextComponent::VCLXAccessibleTextComponent( VCLXWindow* pVCLXWindow )
  47     :VCLXAccessibleComponent( pVCLXWindow )
  48 {
  49     VclPtr<vcl::Window> pWindow = GetWindow();
  50     if ( pWindow )
  51         m_sText = OutputDevice::GetNonMnemonicString( pWindow->GetText() );
  52 }
  53
  54
  55 void VCLXAccessibleTextComponent::SetText( const OUString& sText )
  56 {
  57     Any aOldValue, aNewValue;
  58     if ( implInitTextChangedEvent( m_sText, sText, aOldValue, aNewValue ) )
  59     {
  60         m_sText = sText;
  61         NotifyAccessibleEvent( AccessibleEventId::TEXT_CHANGED, aOldValue, aNewValue );
  62     }
  63 }
  64
  65
  66 void VCLXAccessibleTextComponent::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  67 {
  68     switch ( rVclWindowEvent.GetId() )
  69     {
  70         case VclEventId::WindowFrameTitleChanged:
  71         {
  72             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
  73             SetText( implGetText() );
  74         }
  75         break;
  76         default:
  77             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
  78    }
  79 }
  80
  81
  82 // OCommonAccessibleText
  83
  84
  85 OUString VCLXAccessibleTextComponent::implGetText()
  86 {
  87     OUString aText;
  88     VclPtr<vcl::Window> pWindow = GetWindow();
  89     if ( pWindow )
  90         aText = OutputDevice::GetNonMnemonicString( pWindow->GetText() );
  91
  92     return aText;
  93 }
  94
  95
  96 lang::Locale VCLXAccessibleTextComponent::implGetLocale()
  97 {
  98     return Application::GetSettings().GetLanguageTag().getLocale();
  99 }
 100
 101
 102 void VCLXAccessibleTextComponent::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
 103 {
 104     nStartIndex = 0;
 105     nEndIndex = 0;
 106 }
 107
 108
 109 // XComponent
 110
 111
 112 void VCLXAccessibleTextComponent::disposing()
 113 {
 114     VCLXAccessibleComponent::disposing();
 115
 116     m_sText.clear();
 117 }
 118
 119
 120 // XInterface
 121
 122
 123 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleTextComponent, VCLXAccessibleComponent, VCLXAccessibleTextComponent_BASE )
 124
 125
 126 // XTypeProvider
 127
 128
 129 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleTextComponent, VCLXAccessibleComponent, VCLXAccessibleTextComponent_BASE )
 130
 131
 132 // XAccessibleText
 133
 134
 135 sal_Int32 VCLXAccessibleTextComponent::getCaretPosition()
 136 {
 137     return -1;
 138 }
 139
 140
 141 sal_Bool VCLXAccessibleTextComponent::setCaretPosition( sal_Int32 nIndex )
 142 {
 143     return setSelection( nIndex, nIndex );
 144 }
 145
 146
 147 sal_Unicode VCLXAccessibleTextComponent::getCharacter( sal_Int32 nIndex )
 148 {
 149     OExternalLockGuard aGuard( this );
 150
 151     return OCommonAccessibleText::implGetCharacter( implGetText(), nIndex );
 152 }
 153
 154
 155 Sequence< PropertyValue > VCLXAccessibleTextComponent::getCharacterAttributes( sal_Int32 nIndex, const Sequence< OUString >& aRequestedAttributes )
 156 {
 157     OExternalLockGuard aGuard( this );
 158
 159     Sequence< PropertyValue > aValues;
 160     OUString sText( implGetText() );
 161
 162     if ( !implIsValidIndex( nIndex, sText.getLength() ) )
 163         throw IndexOutOfBoundsException();
 164
 165     VclPtr<vcl::Window> pWindow = GetWindow();
 166     if ( pWindow )
 167     {
 168         vcl::Font aFont = pWindow->GetControlFont();
 169
 170         Color nBackColor = pWindow->GetControlBackground();
 171         Color nColor = pWindow->GetControlForeground();
 172
 173         // MT: Code with default font was introduced with the IA2 CWS, but I am not convinced that this is the correct font...
 174         // Decide what to do when we have a concrete issue.
 175         /*
 176         Font aDefaultVCLFont;
 177         OutputDevice* pDev = Application::GetDefaultDevice();
 178         if ( pDev )
 179         {
 180             aDefaultVCLFont = pDev->GetSettings().GetStyleSettings().GetAppFont();
 181             if ( !aFont.GetName().Len() )
 182             {
 183                 String aDefaultName = aDefaultVCLFont.GetName();
 184                 aFont.SetName( aDefaultName );
 185             }
 186             if ( !aFont.GetHeight() )
 187             {
 188                 aFont.SetHeight( aDefaultVCLFont.GetHeight() );
 189             }
 190             if ( aFont.GetWeight() == WEIGHT_DONTKNOW )
 191             {
 192                 aFont.SetWeight( aDefaultVCLFont.GetWeight() );
 193             }
 194
 195             //if nColor is -1, it may indicate that the default color black is using.
 196             if ( nColor == -1)
 197             {
 198                 nColor = aDefaultVCLFont.GetColor().GetColor();
 199             }
 200         }
 201         */
 202
 203         // MT: Adjustment stuff was introduced with the IA2 CWS, but adjustment is not a character attribute...
 204         // In case we reintroduce it, use adjustment as extra parameter for the CharacterAttributesHelper...
 205         /*
 206         WinBits aBits = GetWindow()->GetStyle();
 207         sal_Int16 nAdjust = -1;
 208         if ( aBits & WB_LEFT )
 209         {
 210             nAdjust = style::ParagraphAdjust_LEFT;
 211         }
 212         else if ( aBits & WB_RIGHT )
 213         {
 214             nAdjust = style::ParagraphAdjust_RIGHT;
 215         }
 216         else if ( aBits & WB_CENTER )
 217         {
 218             nAdjust = style::ParagraphAdjust_CENTER;
 219         }
 220         */
 221
 222         aValues = CharacterAttributesHelper( aFont, sal_Int32(nBackColor), sal_Int32(nColor) )
 223             .GetCharacterAttributes( aRequestedAttributes );
 224     }
 225
 226     return aValues;
 227 }
 228
 229
 230 awt::Rectangle VCLXAccessibleTextComponent::getCharacterBounds( sal_Int32 nIndex )
 231 {
 232     OExternalLockGuard aGuard( this );
 233
 234     if ( !implIsValidIndex( nIndex, implGetText().getLength() ) )
 235         throw IndexOutOfBoundsException();
 236
 237     awt::Rectangle aRect;
 238     VclPtr< Control > pControl = GetAs< Control >();
 239     if ( pControl )
 240         aRect = AWTRectangle( pControl->GetCharacterBounds( nIndex ) );
 241
 242     return aRect;
 243 }
 244
 245
 246 sal_Int32 VCLXAccessibleTextComponent::getCharacterCount()
 247 {
 248     OExternalLockGuard aGuard( this );
 249
 250     return implGetText().getLength();
 251 }
 252
 253
 254 sal_Int32 VCLXAccessibleTextComponent::getIndexAtPoint( const awt::Point& aPoint )
 255 {
 256     OExternalLockGuard aGuard( this );
 257
 258     sal_Int32 nIndex = -1;
 259     VclPtr< Control > pControl = GetAs< Control >();
 260     if ( pControl )
 261         nIndex = pControl->GetIndexForPoint( VCLPoint( aPoint ) );
 262
 263     return nIndex;
 264 }
 265
 266
 267 OUString VCLXAccessibleTextComponent::getSelectedText()
 268 {
 269     OExternalLockGuard aGuard( this );
 270
 271     return OCommonAccessibleText::getSelectedText();
 272 }
 273
 274
 275 sal_Int32 VCLXAccessibleTextComponent::getSelectionStart()
 276 {
 277     OExternalLockGuard aGuard( this );
 278
 279     return OCommonAccessibleText::getSelectionStart();
 280 }
 281
 282
 283 sal_Int32 VCLXAccessibleTextComponent::getSelectionEnd()
 284 {
 285     OExternalLockGuard aGuard( this );
 286
 287     return OCommonAccessibleText::getSelectionEnd();
 288 }
 289
 290
 291 sal_Bool VCLXAccessibleTextComponent::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 292 {
 293     OExternalLockGuard aGuard( this );
 294
 295     if ( !implIsValidRange( nStartIndex, nEndIndex, implGetText().getLength() ) )
 296         throw IndexOutOfBoundsException();
 297
 298     return false;
 299 }
 300
 301
 302 OUString VCLXAccessibleTextComponent::getText()
 303 {
 304     OExternalLockGuard aGuard( this );
 305
 306     return implGetText();
 307 }
 308
 309
 310 OUString VCLXAccessibleTextComponent::getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 311 {
 312     OExternalLockGuard aGuard( this );
 313
 314     return OCommonAccessibleText::implGetTextRange( implGetText(), nStartIndex, nEndIndex );
 315 }
 316
 317
 318 css::accessibility::TextSegment VCLXAccessibleTextComponent::getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 319 {
 320     OExternalLockGuard aGuard( this );
 321
 322     return OCommonAccessibleText::getTextAtIndex( nIndex, aTextType );
 323 }
 324
 325
 326 css::accessibility::TextSegment VCLXAccessibleTextComponent::getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 327 {
 328     OExternalLockGuard aGuard( this );
 329
 330     return OCommonAccessibleText::getTextBeforeIndex( nIndex, aTextType );
 331 }
 332
 333
 334 css::accessibility::TextSegment VCLXAccessibleTextComponent::getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 335 {
 336     OExternalLockGuard aGuard( this );
 337
 338     return OCommonAccessibleText::getTextBehindIndex( nIndex, aTextType );
 339 }
 340
 341
 342 sal_Bool VCLXAccessibleTextComponent::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 343 {
 344     OExternalLockGuard aGuard( this );
 345
 346     bool bReturn = false;
 347
 348     VclPtr<vcl::Window> pWindow = GetWindow();
 349     if ( pWindow )
 350     {
 351         Reference< datatransfer::clipboard::XClipboard > xClipboard = pWindow->GetClipboard();
 352         if ( xClipboard.is() )
 353         {
 354             OUString sText( OCommonAccessibleText::implGetTextRange( implGetText(), nStartIndex, nEndIndex ) );
 355
 356             vcl::unohelper::TextDataObject* pDataObj = new vcl::unohelper::TextDataObject( sText );
 357
 358             SolarMutexReleaser aReleaser;
 359             xClipboard->setContents( pDataObj, nullptr );
 360
 361             Reference< datatransfer::clipboard::XFlushableClipboard > xFlushableClipboard( xClipboard, uno::UNO_QUERY );
 362             if( xFlushableClipboard.is() )
 363                 xFlushableClipboard->flushClipboard();
 364
 365             bReturn = true;
 366         }
 367     }
 368
 369     return bReturn;
 370 }
 371
 372
 373 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */