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