accessibility/source/standard/vclxaccessiblebutton.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 <accessibility/standard/vclxaccessiblebutton.hxx>
  21 #include <accessibility/helper/accresmgr.hxx>
  22 #include <accessibility/helper/accessiblestrings.hrc>
  23
  24 #include <unotools/accessiblestatesethelper.hxx>
  25 #include <comphelper/accessiblekeybindinghelper.hxx>
  26 #include <com/sun/star/awt/KeyModifier.hpp>
  27 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  28 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  29 #include <cppuhelper/typeprovider.hxx>
  30 #include <comphelper/sequence.hxx>
  31
  32 #include <vcl/button.hxx>
  33
  34 using namespace ::com::sun::star;
  35 using namespace ::com::sun::star::uno;
  36 using namespace ::com::sun::star::lang;
  37 using namespace ::com::sun::star::beans;
  38 using namespace ::com::sun::star::accessibility;
  39 using namespace ::comphelper;
  40
  41
  42
  43 // VCLXAccessibleButton
  44
  45
  46 VCLXAccessibleButton::VCLXAccessibleButton( VCLXWindow* pVCLWindow )
  47     :VCLXAccessibleTextComponent( pVCLWindow )
  48 {
  49 }
  50
  51
  52
  53 VCLXAccessibleButton::~VCLXAccessibleButton()
  54 {
  55 }
  56
  57
  58
  59 void VCLXAccessibleButton::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  60 {
  61     switch ( rVclWindowEvent.GetId() )
  62     {
  63         case VCLEVENT_PUSHBUTTON_TOGGLE:
  64         {
  65             Any aOldValue;
  66             Any aNewValue;
  67
  68             VclPtr< PushButton > pButton = GetAs< PushButton >();
  69             if ( pButton && pButton->GetState() == TRISTATE_TRUE )
  70                 aNewValue <<= AccessibleStateType::CHECKED;
  71             else
  72                 aOldValue <<= AccessibleStateType::CHECKED;
  73
  74             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  75         }
  76         break;
  77         default:
  78             VCLXAccessibleTextComponent::ProcessWindowEvent( rVclWindowEvent );
  79    }
  80 }
  81
  82
  83
  84 void VCLXAccessibleButton::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
  85 {
  86     VCLXAccessibleTextComponent::FillAccessibleStateSet( rStateSet );
  87
  88     VclPtr< PushButton > pButton = GetAs< PushButton >();
  89     if ( pButton )
  90     {
  91         rStateSet.AddState( AccessibleStateType::FOCUSABLE );
  92
  93         if ( pButton->GetState() == TRISTATE_TRUE )
  94             rStateSet.AddState( AccessibleStateType::CHECKED );
  95
  96         if ( pButton->IsPressed() )
  97             rStateSet.AddState( AccessibleStateType::PRESSED );
  98
  99         // IA2 CWS: If the button has a poppup menu,it should has the state EXPANDABLE
 100         if( pButton->GetType() == WINDOW_MENUBUTTON )
 101         {
 102             rStateSet.AddState( AccessibleStateType::EXPANDABLE );
 103         }
 104         if( pButton->GetStyle() & WB_DEFBUTTON )
 105         {
 106             rStateSet.AddState( AccessibleStateType::DEFAULT );
 107         }
 108     }
 109 }
 110
 111
 112 // XInterface
 113
 114
 115 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleButton, VCLXAccessibleTextComponent, VCLXAccessibleButton_BASE )
 116
 117
 118 // XTypeProvider
 119
 120
 121 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleButton, VCLXAccessibleTextComponent, VCLXAccessibleButton_BASE )
 122
 123
 124 // XServiceInfo
 125
 126
 127 OUString VCLXAccessibleButton::getImplementationName() throw (RuntimeException, std::exception)
 128 {
 129     return OUString( "com.sun.star.comp.toolkit.AccessibleButton" );
 130 }
 131
 132
 133
 134 Sequence< OUString > VCLXAccessibleButton::getSupportedServiceNames() throw (RuntimeException, std::exception)
 135 {
 136     Sequence< OUString > aNames(1);
 137     aNames[0] = "com.sun.star.awt.AccessibleButton";
 138     return aNames;
 139 }
 140
 141
 142 // XAccessibleContext
 143
 144
 145 OUString VCLXAccessibleButton::getAccessibleName(  ) throw (RuntimeException, std::exception)
 146 {
 147     OExternalLockGuard aGuard( this );
 148
 149     OUString aName( VCLXAccessibleTextComponent::getAccessibleName() );
 150     sal_Int32 nLength = aName.getLength();
 151
 152     if ( nLength >= 3 && aName.match( "...", nLength - 3 ) )
 153     {
 154         if ( nLength == 3 )
 155         {
 156             // it's a browse button
 157             aName = OUString( TK_RES_STRING( RID_STR_ACC_NAME_BROWSEBUTTON ) );
 158         }
 159         else
 160         {
 161             // remove the three trailing dots
 162             aName = aName.copy( 0, nLength - 3 );
 163         }
 164     }
 165     else if ( nLength >= 3 && aName.match( "<< ", 0 ) )
 166     {
 167         // remove the leading symbols
 168         aName = aName.copy( 3, nLength - 3 );
 169     }
 170     else if ( nLength >= 3 && aName.match( " >>", nLength - 3 ) )
 171     {
 172         // remove the trailing symbols
 173         aName = aName.copy( 0, nLength - 3 );
 174     }
 175
 176     return aName;
 177 }
 178
 179
 180 // XAccessibleAction
 181
 182
 183 sal_Int32 VCLXAccessibleButton::getAccessibleActionCount( ) throw (RuntimeException, std::exception)
 184 {
 185     OExternalLockGuard aGuard( this );
 186
 187     return 1;
 188 }
 189
 190
 191
 192 sal_Bool VCLXAccessibleButton::doAccessibleAction ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 193 {
 194     OExternalLockGuard aGuard( this );
 195
 196     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 197         throw IndexOutOfBoundsException();
 198
 199     VclPtr< PushButton > pButton = GetAs< PushButton >();
 200     if ( pButton )
 201         pButton->Click();
 202
 203     return true;
 204 }
 205
 206
 207
 208 OUString VCLXAccessibleButton::getAccessibleActionDescription ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 209 {
 210     OExternalLockGuard aGuard( this );
 211
 212     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 213         throw IndexOutOfBoundsException();
 214
 215     return OUString( TK_RES_STRING( RID_STR_ACC_ACTION_CLICK ) );
 216 }
 217
 218
 219
 220 Reference< XAccessibleKeyBinding > VCLXAccessibleButton::getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 221 {
 222     OExternalLockGuard aGuard( this );
 223
 224     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 225         throw IndexOutOfBoundsException();
 226
 227     OAccessibleKeyBindingHelper* pKeyBindingHelper = new OAccessibleKeyBindingHelper();
 228     Reference< XAccessibleKeyBinding > xKeyBinding = pKeyBindingHelper;
 229
 230     vcl::Window* pWindow = GetWindow();
 231     if ( pWindow )
 232     {
 233         KeyEvent aKeyEvent = pWindow->GetActivationKey();
 234         vcl::KeyCode aKeyCode = aKeyEvent.GetKeyCode();
 235         if ( aKeyCode.GetCode() != 0 )
 236         {
 237             awt::KeyStroke aKeyStroke;
 238             aKeyStroke.Modifiers = 0;
 239             if ( aKeyCode.IsShift() )
 240                 aKeyStroke.Modifiers |= awt::KeyModifier::SHIFT;
 241             if ( aKeyCode.IsMod1() )
 242                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD1;
 243             if ( aKeyCode.IsMod2() )
 244                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD2;
 245             if ( aKeyCode.IsMod3() )
 246                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD3;
 247             aKeyStroke.KeyCode = aKeyCode.GetCode();
 248             aKeyStroke.KeyChar = aKeyEvent.GetCharCode();
 249             aKeyStroke.KeyFunc = static_cast< sal_Int16 >( aKeyCode.GetFunction() );
 250             pKeyBindingHelper->AddKeyBinding( aKeyStroke );
 251         }
 252     }
 253
 254     return xKeyBinding;
 255 }
 256
 257
 258 // XAccessibleValue
 259
 260
 261 Any VCLXAccessibleButton::getCurrentValue(  ) throw (RuntimeException, std::exception)
 262 {
 263     OExternalLockGuard aGuard( this );
 264
 265     Any aValue;
 266
 267     VclPtr< PushButton > pButton = GetAs< PushButton >();
 268     if ( pButton )
 269         aValue <<= (sal_Int32) pButton->IsPressed();
 270
 271     return aValue;
 272 }
 273
 274
 275
 276 sal_Bool VCLXAccessibleButton::setCurrentValue( const Any& aNumber ) throw (RuntimeException, std::exception)
 277 {
 278     OExternalLockGuard aGuard( this );
 279
 280     bool bReturn = false;
 281
 282     VclPtr< PushButton > pButton = GetAs< PushButton >();
 283     if ( pButton )
 284     {
 285         sal_Int32 nValue = 0;
 286         OSL_VERIFY( aNumber >>= nValue );
 287
 288         if ( nValue < 0 )
 289             nValue = 0;
 290         else if ( nValue > 1 )
 291             nValue = 1;
 292
 293         pButton->SetPressed( nValue == 1 );
 294         bReturn = true;
 295     }
 296
 297     return bReturn;
 298 }
 299
 300
 301
 302 Any VCLXAccessibleButton::getMaximumValue(  ) throw (RuntimeException, std::exception)
 303 {
 304     OExternalLockGuard aGuard( this );
 305
 306     Any aValue;
 307     aValue <<= (sal_Int32) 1;
 308
 309     return aValue;
 310 }
 311
 312
 313
 314 Any VCLXAccessibleButton::getMinimumValue(  ) throw (RuntimeException, std::exception)
 315 {
 316     OExternalLockGuard aGuard( this );
 317
 318     Any aValue;
 319     aValue <<= (sal_Int32) 0;
 320
 321     return aValue;
 322 }
 323
 324
 325
 326 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */