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 <comphelper/accessiblecontexthelper.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
  31 #include <vcl/accessibility/strings.hxx>
  32 #include <vcl/toolkit/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::accessibility;
  40 using namespace ::comphelper;
  41
  42
  43 // VCLXAccessibleButton
  44
  45
  46 void VCLXAccessibleButton::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  47 {
  48     switch ( rVclWindowEvent.GetId() )
  49     {
  50         case VclEventId::PushbuttonToggle:
  51         {
  52             Any aOldValue;
  53             Any aNewValue;
  54
  55             VclPtr< PushButton > pButton = GetAs< PushButton >();
  56             if ( pButton && pButton->GetState() == TRISTATE_TRUE )
  57                 aNewValue <<= AccessibleStateType::CHECKED;
  58             else
  59                 aOldValue <<= AccessibleStateType::CHECKED;
  60
  61             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  62         }
  63         break;
  64         default:
  65             VCLXAccessibleTextComponent::ProcessWindowEvent( rVclWindowEvent );
  66    }
  67 }
  68
  69
  70 void VCLXAccessibleButton::FillAccessibleStateSet( sal_Int64& rStateSet )
  71 {
  72     VCLXAccessibleTextComponent::FillAccessibleStateSet( rStateSet );
  73
  74     VclPtr< PushButton > pButton = GetAs< PushButton >();
  75     if ( !pButton )
  76         return;
  77
  78     rStateSet |= AccessibleStateType::FOCUSABLE;
  79
  80     if (pButton->isToggleButton())
  81         rStateSet |= AccessibleStateType::CHECKABLE;
  82
  83     if ( pButton->GetState() == TRISTATE_TRUE )
  84         rStateSet |= AccessibleStateType::CHECKED;
  85
  86     if ( pButton->IsPressed() )
  87         rStateSet |= AccessibleStateType::PRESSED;
  88
  89     // IA2 CWS: if the button has a popup menu, it should has the state EXPANDABLE
  90     if( pButton->GetType() == WindowType::MENUBUTTON )
  91     {
  92         rStateSet |= AccessibleStateType::EXPANDABLE;
  93     }
  94     if( pButton->GetStyle() & WB_DEFBUTTON )
  95     {
  96         rStateSet |= AccessibleStateType::DEFAULT;
  97     }
  98 }
  99
 100
 101 // XServiceInfo
 102
 103
 104 OUString VCLXAccessibleButton::getImplementationName()
 105 {
 106     return u"com.sun.star.comp.toolkit.AccessibleButton"_ustr;
 107 }
 108
 109
 110 Sequence< OUString > VCLXAccessibleButton::getSupportedServiceNames()
 111 {
 112     return { u"com.sun.star.awt.AccessibleButton"_ustr };
 113 }
 114
 115
 116 // XAccessibleContext
 117
 118
 119 OUString VCLXAccessibleButton::getAccessibleName(  )
 120 {
 121     OUString aName( VCLXAccessibleTextComponent::getAccessibleName() );
 122     sal_Int32 nLength = aName.getLength();
 123
 124     if ( nLength >= 3 && aName.match( "...", nLength - 3 ) )
 125     {
 126         if ( nLength == 3 )
 127         {
 128             // it's a browse button
 129             aName = AccResId( RID_STR_ACC_NAME_BROWSEBUTTON );
 130         }
 131         else
 132         {
 133             // remove the three trailing dots
 134             aName = aName.copy( 0, nLength - 3 );
 135         }
 136     }
 137     else if ( nLength >= 3 && aName.match( "<< ", 0 ) )
 138     {
 139         // remove the leading symbols
 140         aName = aName.copy( 3, nLength - 3 );
 141     }
 142     else if ( nLength >= 3 && aName.match( " >>", nLength - 3 ) )
 143     {
 144         // remove the trailing symbols
 145         aName = aName.copy( 0, nLength - 3 );
 146     }
 147
 148     return aName;
 149 }
 150
 151
 152 // XAccessibleAction
 153
 154
 155 sal_Int32 VCLXAccessibleButton::getAccessibleActionCount( )
 156 {
 157     OExternalLockGuard aGuard( this );
 158
 159     return 1;
 160 }
 161
 162
 163 sal_Bool VCLXAccessibleButton::doAccessibleAction ( sal_Int32 nIndex )
 164 {
 165     OExternalLockGuard aGuard( this );
 166
 167     if ( nIndex != 0 )
 168         throw IndexOutOfBoundsException();
 169
 170     VclPtr< PushButton > pButton = GetAs< PushButton >();
 171     if ( pButton )
 172     {
 173         if (pButton->isToggleButton())
 174         {
 175             // PushButton::Click doesn't toggle when it's a toggle button
 176             pButton->Check(!pButton->IsChecked());
 177             pButton->Toggle();
 178         }
 179         else
 180         {
 181             pButton->Click();
 182         }
 183     }
 184
 185     return true;
 186 }
 187
 188
 189 OUString VCLXAccessibleButton::getAccessibleActionDescription ( sal_Int32 nIndex )
 190 {
 191     OExternalLockGuard aGuard( this );
 192
 193     if ( nIndex != 0 )
 194         throw IndexOutOfBoundsException();
 195
 196     return RID_STR_ACC_ACTION_CLICK;
 197 }
 198
 199
 200 Reference< XAccessibleKeyBinding > VCLXAccessibleButton::getAccessibleActionKeyBinding( sal_Int32 nIndex )
 201 {
 202     OExternalLockGuard aGuard( this );
 203
 204     if ( nIndex != 0 )
 205         throw IndexOutOfBoundsException();
 206
 207     rtl::Reference<OAccessibleKeyBindingHelper> pKeyBindingHelper = new OAccessibleKeyBindingHelper();
 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 pKeyBindingHelper;
 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 Any VCLXAccessibleButton::getMinimumIncrement(  )
 301 {
 302     OExternalLockGuard aGuard( this );
 303
 304     Any aValue;
 305     aValue <<= sal_Int32(1);
 306
 307     return aValue;
 308 }
 309
 310
 311 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */