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             PushButton* pButton = (PushButton*) GetWindow();
  69             if ( pButton && pButton->GetState() == STATE_CHECK )
  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     PushButton* pButton = (PushButton*) GetWindow();
  89     if ( pButton )
  90     {
  91         rStateSet.AddState( AccessibleStateType::FOCUSABLE );
  92
  93         if ( pButton->GetState() == STATE_CHECK )
  94             rStateSet.AddState( AccessibleStateType::CHECKED );
  95
  96         if ( pButton->IsPressed() )
  97             rStateSet.AddState( AccessibleStateType::PRESSED );
  98     }
  99 }
 100
 101 // -----------------------------------------------------------------------------
 102 // XInterface
 103 // -----------------------------------------------------------------------------
 104
 105 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleButton, VCLXAccessibleTextComponent, VCLXAccessibleButton_BASE )
 106
 107 // -----------------------------------------------------------------------------
 108 // XTypeProvider
 109 // -----------------------------------------------------------------------------
 110
 111 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleButton, VCLXAccessibleTextComponent, VCLXAccessibleButton_BASE )
 112
 113 // -----------------------------------------------------------------------------
 114 // XServiceInfo
 115 // -----------------------------------------------------------------------------
 116
 117 OUString VCLXAccessibleButton::getImplementationName() throw (RuntimeException)
 118 {
 119     return OUString( "com.sun.star.comp.toolkit.AccessibleButton" );
 120 }
 121
 122 // -----------------------------------------------------------------------------
 123
 124 Sequence< OUString > VCLXAccessibleButton::getSupportedServiceNames() throw (RuntimeException)
 125 {
 126     Sequence< OUString > aNames(1);
 127     aNames[0] = "com.sun.star.awt.AccessibleButton";
 128     return aNames;
 129 }
 130
 131 // -----------------------------------------------------------------------------
 132 // XAccessibleContext
 133 // -----------------------------------------------------------------------------
 134
 135 OUString VCLXAccessibleButton::getAccessibleName(  ) throw (RuntimeException)
 136 {
 137     OExternalLockGuard aGuard( this );
 138
 139     OUString aName( VCLXAccessibleTextComponent::getAccessibleName() );
 140     sal_Int32 nLength = aName.getLength();
 141
 142     if ( nLength >= 3 && aName.matchAsciiL( RTL_CONSTASCII_STRINGPARAM("..."), nLength - 3 ) )
 143     {
 144         if ( nLength == 3 )
 145         {
 146             // it's a browse button
 147             aName = OUString( TK_RES_STRING( RID_STR_ACC_NAME_BROWSEBUTTON ) );
 148         }
 149         else
 150         {
 151             // remove the three trailing dots
 152             aName = aName.copy( 0, nLength - 3 );
 153         }
 154     }
 155     else if ( nLength >= 3 && aName.matchAsciiL( RTL_CONSTASCII_STRINGPARAM("<< "), 0 ) )
 156     {
 157         // remove the leading symbols
 158         aName = aName.copy( 3, nLength - 3 );
 159     }
 160     else if ( nLength >= 3 && aName.matchAsciiL( RTL_CONSTASCII_STRINGPARAM(" >>"), nLength - 3 ) )
 161     {
 162         // remove the trailing symbols
 163         aName = aName.copy( 0, nLength - 3 );
 164     }
 165
 166     return aName;
 167 }
 168
 169 // -----------------------------------------------------------------------------
 170 // XAccessibleAction
 171 // -----------------------------------------------------------------------------
 172
 173 sal_Int32 VCLXAccessibleButton::getAccessibleActionCount( ) throw (RuntimeException)
 174 {
 175     OExternalLockGuard aGuard( this );
 176
 177     return 1;
 178 }
 179
 180 // -----------------------------------------------------------------------------
 181
 182 sal_Bool VCLXAccessibleButton::doAccessibleAction ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 183 {
 184     OExternalLockGuard aGuard( this );
 185
 186     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 187         throw IndexOutOfBoundsException();
 188
 189     PushButton* pButton = (PushButton*) GetWindow();
 190     if ( pButton )
 191         pButton->Click();
 192
 193     return sal_True;
 194 }
 195
 196 // -----------------------------------------------------------------------------
 197
 198 OUString VCLXAccessibleButton::getAccessibleActionDescription ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 199 {
 200     OExternalLockGuard aGuard( this );
 201
 202     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 203         throw IndexOutOfBoundsException();
 204
 205     return OUString( TK_RES_STRING( RID_STR_ACC_ACTION_CLICK ) );
 206 }
 207
 208 // -----------------------------------------------------------------------------
 209
 210 Reference< XAccessibleKeyBinding > VCLXAccessibleButton::getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 211 {
 212     OExternalLockGuard aGuard( this );
 213
 214     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 215         throw IndexOutOfBoundsException();
 216
 217     OAccessibleKeyBindingHelper* pKeyBindingHelper = new OAccessibleKeyBindingHelper();
 218     Reference< XAccessibleKeyBinding > xKeyBinding = pKeyBindingHelper;
 219
 220     Window* pWindow = GetWindow();
 221     if ( pWindow )
 222     {
 223         KeyEvent aKeyEvent = pWindow->GetActivationKey();
 224         KeyCode aKeyCode = aKeyEvent.GetKeyCode();
 225         if ( aKeyCode.GetCode() != 0 )
 226         {
 227             awt::KeyStroke aKeyStroke;
 228             aKeyStroke.Modifiers = 0;
 229             if ( aKeyCode.IsShift() )
 230                 aKeyStroke.Modifiers |= awt::KeyModifier::SHIFT;
 231             if ( aKeyCode.IsMod1() )
 232                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD1;
 233             if ( aKeyCode.IsMod2() )
 234                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD2;
 235             if ( aKeyCode.IsMod3() )
 236                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD3;
 237             aKeyStroke.KeyCode = aKeyCode.GetCode();
 238             aKeyStroke.KeyChar = aKeyEvent.GetCharCode();
 239             aKeyStroke.KeyFunc = static_cast< sal_Int16 >( aKeyCode.GetFunction() );
 240             pKeyBindingHelper->AddKeyBinding( aKeyStroke );
 241         }
 242     }
 243
 244     return xKeyBinding;
 245 }
 246
 247 // -----------------------------------------------------------------------------
 248 // XAccessibleValue
 249 // -----------------------------------------------------------------------------
 250
 251 Any VCLXAccessibleButton::getCurrentValue(  ) throw (RuntimeException)
 252 {
 253     OExternalLockGuard aGuard( this );
 254
 255     Any aValue;
 256
 257     PushButton* pButton = (PushButton*) GetWindow();
 258     if ( pButton )
 259         aValue <<= (sal_Int32) pButton->IsPressed();
 260
 261     return aValue;
 262 }
 263
 264 // -----------------------------------------------------------------------------
 265
 266 sal_Bool VCLXAccessibleButton::setCurrentValue( const Any& aNumber ) throw (RuntimeException)
 267 {
 268     OExternalLockGuard aGuard( this );
 269
 270     sal_Bool bReturn = sal_False;
 271
 272     PushButton* pButton = (PushButton*) GetWindow();
 273     if ( pButton )
 274     {
 275         sal_Int32 nValue = 0;
 276         OSL_VERIFY( aNumber >>= nValue );
 277
 278         if ( nValue < 0 )
 279             nValue = 0;
 280         else if ( nValue > 1 )
 281             nValue = 1;
 282
 283         pButton->SetPressed( (sal_Bool) nValue );
 284         bReturn = sal_True;
 285     }
 286
 287     return bReturn;
 288 }
 289
 290 // -----------------------------------------------------------------------------
 291
 292 Any VCLXAccessibleButton::getMaximumValue(  ) throw (RuntimeException)
 293 {
 294     OExternalLockGuard aGuard( this );
 295
 296     Any aValue;
 297     aValue <<= (sal_Int32) 1;
 298
 299     return aValue;
 300 }
 301
 302 // -----------------------------------------------------------------------------
 303
 304 Any VCLXAccessibleButton::getMinimumValue(  ) throw (RuntimeException)
 305 {
 306     OExternalLockGuard aGuard( this );
 307
 308     Any aValue;
 309     aValue <<= (sal_Int32) 0;
 310
 311     return aValue;
 312 }
 313
 314 // -----------------------------------------------------------------------------
 315
 316 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */