accessibility/source/standard/vclxaccessiblebutton.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: vclxaccessiblebutton.cxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_accessibility.hxx"
  33
  34 // includes --------------------------------------------------------------
  35 #include <accessibility/standard/vclxaccessiblebutton.hxx>
  36 #include <accessibility/helper/accresmgr.hxx>
  37 #include <accessibility/helper/accessiblestrings.hrc>
  38
  39 #include <unotools/accessiblestatesethelper.hxx>
  40 #include <comphelper/accessiblekeybindinghelper.hxx>
  41 #include <com/sun/star/awt/KeyModifier.hpp>
  42 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  43 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  44 #include <cppuhelper/typeprovider.hxx>
  45 #include <comphelper/sequence.hxx>
  46
  47 #include <vcl/button.hxx>
  48
  49 using namespace ::com::sun::star;
  50 using namespace ::com::sun::star::uno;
  51 using namespace ::com::sun::star::lang;
  52 using namespace ::com::sun::star::beans;
  53 using namespace ::com::sun::star::accessibility;
  54 using namespace ::comphelper;
  55
  56
  57 // -----------------------------------------------------------------------------
  58 // VCLXAccessibleButton
  59 // -----------------------------------------------------------------------------
  60
  61 VCLXAccessibleButton::VCLXAccessibleButton( VCLXWindow* pVCLWindow )
  62     :VCLXAccessibleTextComponent( pVCLWindow )
  63 {
  64 }
  65
  66 // -----------------------------------------------------------------------------
  67
  68 VCLXAccessibleButton::~VCLXAccessibleButton()
  69 {
  70 }
  71
  72 // -----------------------------------------------------------------------------
  73
  74 void VCLXAccessibleButton::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  75 {
  76     switch ( rVclWindowEvent.GetId() )
  77     {
  78         case VCLEVENT_PUSHBUTTON_TOGGLE:
  79         {
  80             Any aOldValue;
  81             Any aNewValue;
  82
  83             PushButton* pButton = (PushButton*) GetWindow();
  84             if ( pButton && pButton->GetState() == STATE_CHECK )
  85                 aNewValue <<= AccessibleStateType::CHECKED;
  86             else
  87                 aOldValue <<= AccessibleStateType::CHECKED;
  88
  89             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  90         }
  91         break;
  92         default:
  93             VCLXAccessibleTextComponent::ProcessWindowEvent( rVclWindowEvent );
  94    }
  95 }
  96
  97 // -----------------------------------------------------------------------------
  98
  99 void VCLXAccessibleButton::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 100 {
 101     VCLXAccessibleTextComponent::FillAccessibleStateSet( rStateSet );
 102
 103     PushButton* pButton = (PushButton*) GetWindow();
 104     if ( pButton )
 105     {
 106         rStateSet.AddState( AccessibleStateType::FOCUSABLE );
 107
 108         if ( pButton->GetState() == STATE_CHECK )
 109             rStateSet.AddState( AccessibleStateType::CHECKED );
 110
 111         if ( pButton->IsPressed() )
 112             rStateSet.AddState( AccessibleStateType::PRESSED );
 113     }
 114 }
 115
 116 // -----------------------------------------------------------------------------
 117 // XInterface
 118 // -----------------------------------------------------------------------------
 119
 120 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleButton, VCLXAccessibleTextComponent, VCLXAccessibleButton_BASE )
 121
 122 // -----------------------------------------------------------------------------
 123 // XTypeProvider
 124 // -----------------------------------------------------------------------------
 125
 126 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleButton, VCLXAccessibleTextComponent, VCLXAccessibleButton_BASE )
 127
 128 // -----------------------------------------------------------------------------
 129 // XServiceInfo
 130 // -----------------------------------------------------------------------------
 131
 132 ::rtl::OUString VCLXAccessibleButton::getImplementationName() throw (RuntimeException)
 133 {
 134     return ::rtl::OUString::createFromAscii( "com.sun.star.comp.toolkit.AccessibleButton" );
 135 }
 136
 137 // -----------------------------------------------------------------------------
 138
 139 Sequence< ::rtl::OUString > VCLXAccessibleButton::getSupportedServiceNames() throw (RuntimeException)
 140 {
 141     Sequence< ::rtl::OUString > aNames(1);
 142     aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleButton" );
 143     return aNames;
 144 }
 145
 146 // -----------------------------------------------------------------------------
 147 // XAccessibleContext
 148 // -----------------------------------------------------------------------------
 149
 150 ::rtl::OUString VCLXAccessibleButton::getAccessibleName(  ) throw (RuntimeException)
 151 {
 152     OExternalLockGuard aGuard( this );
 153
 154     ::rtl::OUString aName( VCLXAccessibleTextComponent::getAccessibleName() );
 155     sal_Int32 nLength = aName.getLength();
 156
 157     if ( nLength >= 3 && aName.matchAsciiL( RTL_CONSTASCII_STRINGPARAM("..."), nLength - 3 ) )
 158     {
 159         if ( nLength == 3 )
 160         {
 161             // it's a browse button
 162             aName = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_NAME_BROWSEBUTTON ) );
 163         }
 164         else
 165         {
 166             // remove the three trailing dots
 167             aName = aName.copy( 0, nLength - 3 );
 168         }
 169     }
 170     else if ( nLength >= 3 && aName.matchAsciiL( RTL_CONSTASCII_STRINGPARAM("<< "), 0 ) )
 171     {
 172         // remove the leading symbols
 173         aName = aName.copy( 3, nLength - 3 );
 174     }
 175     else if ( nLength >= 3 && aName.matchAsciiL( RTL_CONSTASCII_STRINGPARAM(" >>"), nLength - 3 ) )
 176     {
 177         // remove the trailing symbols
 178         aName = aName.copy( 0, nLength - 3 );
 179     }
 180
 181     return aName;
 182 }
 183
 184 // -----------------------------------------------------------------------------
 185 // XAccessibleAction
 186 // -----------------------------------------------------------------------------
 187
 188 sal_Int32 VCLXAccessibleButton::getAccessibleActionCount( ) throw (RuntimeException)
 189 {
 190     OExternalLockGuard aGuard( this );
 191
 192     return 1;
 193 }
 194
 195 // -----------------------------------------------------------------------------
 196
 197 sal_Bool VCLXAccessibleButton::doAccessibleAction ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 198 {
 199     OExternalLockGuard aGuard( this );
 200
 201     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 202         throw IndexOutOfBoundsException();
 203
 204     PushButton* pButton = (PushButton*) GetWindow();
 205     if ( pButton )
 206         pButton->Click();
 207
 208     return sal_True;
 209 }
 210
 211 // -----------------------------------------------------------------------------
 212
 213 ::rtl::OUString VCLXAccessibleButton::getAccessibleActionDescription ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 214 {
 215     OExternalLockGuard aGuard( this );
 216
 217     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 218         throw IndexOutOfBoundsException();
 219
 220     return ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_CLICK ) );
 221 }
 222
 223 // -----------------------------------------------------------------------------
 224
 225 Reference< XAccessibleKeyBinding > VCLXAccessibleButton::getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 226 {
 227     OExternalLockGuard aGuard( this );
 228
 229     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 230         throw IndexOutOfBoundsException();
 231
 232     OAccessibleKeyBindingHelper* pKeyBindingHelper = new OAccessibleKeyBindingHelper();
 233     Reference< XAccessibleKeyBinding > xKeyBinding = pKeyBindingHelper;
 234
 235     Window* pWindow = GetWindow();
 236     if ( pWindow )
 237     {
 238         KeyEvent aKeyEvent = pWindow->GetActivationKey();
 239         KeyCode aKeyCode = aKeyEvent.GetKeyCode();
 240         if ( aKeyCode.GetCode() != 0 )
 241         {
 242             awt::KeyStroke aKeyStroke;
 243             aKeyStroke.Modifiers = 0;
 244             if ( aKeyCode.IsShift() )
 245                 aKeyStroke.Modifiers |= awt::KeyModifier::SHIFT;
 246             if ( aKeyCode.IsMod1() )
 247                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD1;
 248             if ( aKeyCode.IsMod2() )
 249                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD2;
 250             if ( aKeyCode.IsMod3() )
 251                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD3;
 252             aKeyStroke.KeyCode = aKeyCode.GetCode();
 253             aKeyStroke.KeyChar = aKeyEvent.GetCharCode();
 254             aKeyStroke.KeyFunc = static_cast< sal_Int16 >( aKeyCode.GetFunction() );
 255             pKeyBindingHelper->AddKeyBinding( aKeyStroke );
 256         }
 257     }
 258
 259     return xKeyBinding;
 260 }
 261
 262 // -----------------------------------------------------------------------------
 263 // XAccessibleValue
 264 // -----------------------------------------------------------------------------
 265
 266 Any VCLXAccessibleButton::getCurrentValue(  ) throw (RuntimeException)
 267 {
 268     OExternalLockGuard aGuard( this );
 269
 270     Any aValue;
 271
 272     PushButton* pButton = (PushButton*) GetWindow();
 273     if ( pButton )
 274         aValue <<= (sal_Int32) pButton->IsPressed();
 275
 276     return aValue;
 277 }
 278
 279 // -----------------------------------------------------------------------------
 280
 281 sal_Bool VCLXAccessibleButton::setCurrentValue( const Any& aNumber ) throw (RuntimeException)
 282 {
 283     OExternalLockGuard aGuard( this );
 284
 285     sal_Bool bReturn = sal_False;
 286
 287     PushButton* pButton = (PushButton*) GetWindow();
 288     if ( pButton )
 289     {
 290         sal_Int32 nValue = 0;
 291         OSL_VERIFY( aNumber >>= nValue );
 292
 293         if ( nValue < 0 )
 294             nValue = 0;
 295         else if ( nValue > 1 )
 296             nValue = 1;
 297
 298         pButton->SetPressed( (BOOL) nValue );
 299         bReturn = sal_True;
 300     }
 301
 302     return bReturn;
 303 }
 304
 305 // -----------------------------------------------------------------------------
 306
 307 Any VCLXAccessibleButton::getMaximumValue(  ) throw (RuntimeException)
 308 {
 309     OExternalLockGuard aGuard( this );
 310
 311     Any aValue;
 312     aValue <<= (sal_Int32) 1;
 313
 314     return aValue;
 315 }
 316
 317 // -----------------------------------------------------------------------------
 318
 319 Any VCLXAccessibleButton::getMinimumValue(  ) throw (RuntimeException)
 320 {
 321     OExternalLockGuard aGuard( this );
 322
 323     Any aValue;
 324     aValue <<= (sal_Int32) 0;
 325
 326     return aValue;
 327 }
 328
 329 // -----------------------------------------------------------------------------