accessibility/source/standard/vclxaccessibleradiobutton.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: vclxaccessibleradiobutton.cxx,v $
  10  * $Revision: 1.4 $
  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/vclxaccessibleradiobutton.hxx>
  36
  37 #include <toolkit/awt/vclxwindows.hxx>
  38 #include <accessibility/helper/accresmgr.hxx>
  39 #include <accessibility/helper/accessiblestrings.hrc>
  40
  41 #include <unotools/accessiblerelationsethelper.hxx>
  42 #include <unotools/accessiblestatesethelper.hxx>
  43 #include <comphelper/accessiblekeybindinghelper.hxx>
  44 #include <com/sun/star/awt/KeyModifier.hpp>
  45 #include <com/sun/star/accessibility/AccessibleRelationType.hpp>
  46 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  47 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  48 #include <cppuhelper/typeprovider.hxx>
  49 #include <comphelper/sequence.hxx>
  50 #include <vcl/window.hxx>
  51 #include <vcl/button.hxx>
  52
  53
  54 using namespace ::com::sun::star;
  55 using namespace ::com::sun::star::uno;
  56 using namespace ::com::sun::star::lang;
  57 using namespace ::com::sun::star::beans;
  58 using namespace ::com::sun::star::accessibility;
  59 using namespace ::comphelper;
  60
  61
  62 // -----------------------------------------------------------------------------
  63 // VCLXAccessibleRadioButton
  64 // -----------------------------------------------------------------------------
  65
  66 VCLXAccessibleRadioButton::VCLXAccessibleRadioButton( VCLXWindow* pVCLWindow )
  67     :VCLXAccessibleTextComponent( pVCLWindow )
  68 {
  69 }
  70
  71 // -----------------------------------------------------------------------------
  72
  73 VCLXAccessibleRadioButton::~VCLXAccessibleRadioButton()
  74 {
  75 }
  76
  77 // -----------------------------------------------------------------------------
  78
  79 void VCLXAccessibleRadioButton::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  80 {
  81     switch ( rVclWindowEvent.GetId() )
  82     {
  83         case VCLEVENT_RADIOBUTTON_TOGGLE:
  84         {
  85             Any aOldValue;
  86             Any aNewValue;
  87
  88             VCLXRadioButton* pVCLXRadioButton = static_cast< VCLXRadioButton* >( GetVCLXWindow() );
  89             if ( pVCLXRadioButton && pVCLXRadioButton->getState() )
  90                 aNewValue <<= AccessibleStateType::CHECKED;
  91             else
  92                 aOldValue <<= AccessibleStateType::CHECKED;
  93
  94             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  95         }
  96         break;
  97         default:
  98             VCLXAccessibleTextComponent::ProcessWindowEvent( rVclWindowEvent );
  99    }
 100 }
 101
 102 // -----------------------------------------------------------------------------
 103
 104 void VCLXAccessibleRadioButton::FillAccessibleRelationSet( utl::AccessibleRelationSetHelper& rRelationSet )
 105 {
 106     VCLXAccessibleTextComponent::FillAccessibleRelationSet( rRelationSet );
 107
 108     RadioButton* pRadioButton = dynamic_cast< RadioButton* >( GetWindow() );
 109     if ( pRadioButton )
 110     {
 111         ::std::vector< RadioButton* > aGroup;
 112         pRadioButton->GetRadioButtonGroup( aGroup, true );
 113         if ( !aGroup.empty() )
 114         {
 115             sal_Int32 i = 0;
 116             Sequence< Reference< XInterface > > aSequence( static_cast< sal_Int32 >( aGroup.size() ) );
 117             ::std::vector< RadioButton* >::const_iterator aEndItr = aGroup.end();
 118             for ( ::std::vector< RadioButton* >::const_iterator aItr = aGroup.begin(); aItr < aEndItr; ++aItr )
 119             {
 120                 aSequence[i++] = (*aItr)->GetAccessible();
 121             }
 122             rRelationSet.AddRelation( AccessibleRelation( AccessibleRelationType::MEMBER_OF, aSequence ) );
 123         }
 124     }
 125 }
 126
 127 // -----------------------------------------------------------------------------
 128
 129 void VCLXAccessibleRadioButton::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 130 {
 131     VCLXAccessibleTextComponent::FillAccessibleStateSet( rStateSet );
 132
 133     VCLXRadioButton* pVCLXRadioButton = static_cast< VCLXRadioButton* >( GetVCLXWindow() );
 134     if ( pVCLXRadioButton )
 135     {
 136         rStateSet.AddState( AccessibleStateType::FOCUSABLE );
 137         if ( pVCLXRadioButton->getState() )
 138             rStateSet.AddState( AccessibleStateType::CHECKED );
 139     }
 140 }
 141
 142 // -----------------------------------------------------------------------------
 143 // XInterface
 144 // -----------------------------------------------------------------------------
 145
 146 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleRadioButton, VCLXAccessibleTextComponent, VCLXAccessibleRadioButton_BASE )
 147
 148 // -----------------------------------------------------------------------------
 149 // XTypeProvider
 150 // -----------------------------------------------------------------------------
 151
 152 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleRadioButton, VCLXAccessibleTextComponent, VCLXAccessibleRadioButton_BASE )
 153
 154 // -----------------------------------------------------------------------------
 155 // XServiceInfo
 156 // -----------------------------------------------------------------------------
 157
 158 ::rtl::OUString VCLXAccessibleRadioButton::getImplementationName() throw (RuntimeException)
 159 {
 160     return ::rtl::OUString::createFromAscii( "com.sun.star.comp.toolkit.AccessibleRadioButton" );
 161 }
 162
 163 // -----------------------------------------------------------------------------
 164
 165 Sequence< ::rtl::OUString > VCLXAccessibleRadioButton::getSupportedServiceNames() throw (RuntimeException)
 166 {
 167     Sequence< ::rtl::OUString > aNames(1);
 168     aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleRadioButton" );
 169     return aNames;
 170 }
 171
 172 // -----------------------------------------------------------------------------
 173 // XAccessibleAction
 174 // -----------------------------------------------------------------------------
 175
 176 sal_Int32 VCLXAccessibleRadioButton::getAccessibleActionCount( ) throw (RuntimeException)
 177 {
 178     OExternalLockGuard aGuard( this );
 179
 180     return 1;
 181 }
 182
 183 // -----------------------------------------------------------------------------
 184
 185 sal_Bool VCLXAccessibleRadioButton::doAccessibleAction ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 186 {
 187     OExternalLockGuard aGuard( this );
 188
 189     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 190         throw IndexOutOfBoundsException();
 191
 192     VCLXRadioButton* pVCLXRadioButton = static_cast< VCLXRadioButton* >( GetVCLXWindow() );
 193     if ( pVCLXRadioButton && !pVCLXRadioButton->getState() )
 194         pVCLXRadioButton->setState( sal_True );
 195
 196     return sal_True;
 197 }
 198
 199 // -----------------------------------------------------------------------------
 200
 201 ::rtl::OUString VCLXAccessibleRadioButton::getAccessibleActionDescription ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 202 {
 203     OExternalLockGuard aGuard( this );
 204
 205     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 206         throw IndexOutOfBoundsException();
 207
 208     return ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_CLICK ) );
 209 }
 210
 211 // -----------------------------------------------------------------------------
 212
 213 Reference< XAccessibleKeyBinding > VCLXAccessibleRadioButton::getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 214 {
 215     OExternalLockGuard aGuard( this );
 216
 217     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 218         throw IndexOutOfBoundsException();
 219
 220     OAccessibleKeyBindingHelper* pKeyBindingHelper = new OAccessibleKeyBindingHelper();
 221     Reference< XAccessibleKeyBinding > xKeyBinding = pKeyBindingHelper;
 222
 223     Window* pWindow = GetWindow();
 224     if ( pWindow )
 225     {
 226         KeyEvent aKeyEvent = pWindow->GetActivationKey();
 227         KeyCode aKeyCode = aKeyEvent.GetKeyCode();
 228         if ( aKeyCode.GetCode() != 0 )
 229         {
 230             awt::KeyStroke aKeyStroke;
 231             aKeyStroke.Modifiers = 0;
 232             if ( aKeyCode.IsShift() )
 233                 aKeyStroke.Modifiers |= awt::KeyModifier::SHIFT;
 234             if ( aKeyCode.IsMod1() )
 235                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD1;
 236             if ( aKeyCode.IsMod2() )
 237                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD2;
 238             if ( aKeyCode.IsMod3() )
 239                 aKeyStroke.Modifiers |= awt::KeyModifier::MOD3;
 240             aKeyStroke.KeyCode = aKeyCode.GetCode();
 241             aKeyStroke.KeyChar = aKeyEvent.GetCharCode();
 242             aKeyStroke.KeyFunc = static_cast< sal_Int16 >( aKeyCode.GetFunction() );
 243             pKeyBindingHelper->AddKeyBinding( aKeyStroke );
 244         }
 245     }
 246
 247     return xKeyBinding;
 248 }
 249
 250 // -----------------------------------------------------------------------------
 251 // XAccessibleValue
 252 // -----------------------------------------------------------------------------
 253
 254 Any VCLXAccessibleRadioButton::getCurrentValue(  ) throw (RuntimeException)
 255 {
 256     OExternalLockGuard aGuard( this );
 257
 258     Any aValue;
 259
 260     VCLXRadioButton* pVCLXRadioButton = static_cast< VCLXRadioButton* >( GetVCLXWindow() );
 261     if ( pVCLXRadioButton )
 262         aValue <<= (sal_Int32) pVCLXRadioButton->getState();
 263
 264     return aValue;
 265 }
 266
 267 // -----------------------------------------------------------------------------
 268
 269 sal_Bool VCLXAccessibleRadioButton::setCurrentValue( const Any& aNumber ) throw (RuntimeException)
 270 {
 271     OExternalLockGuard aGuard( this );
 272
 273     sal_Bool bReturn = sal_False;
 274
 275     VCLXRadioButton* pVCLXRadioButton = static_cast< VCLXRadioButton* >( GetVCLXWindow() );
 276     if ( pVCLXRadioButton )
 277     {
 278         sal_Int32 nValue = 0;
 279         OSL_VERIFY( aNumber >>= nValue );
 280
 281         if ( nValue < 0 )
 282             nValue = 0;
 283         else if ( nValue > 1 )
 284             nValue = 1;
 285
 286         pVCLXRadioButton->setState( (sal_Bool) nValue );
 287         bReturn = sal_True;
 288     }
 289
 290     return bReturn;
 291 }
 292
 293 // -----------------------------------------------------------------------------
 294
 295 Any VCLXAccessibleRadioButton::getMaximumValue(  ) throw (RuntimeException)
 296 {
 297     OExternalLockGuard aGuard( this );
 298
 299     Any aValue;
 300     aValue <<= (sal_Int32) 1;
 301
 302     return aValue;
 303 }
 304
 305 // -----------------------------------------------------------------------------
 306
 307 Any VCLXAccessibleRadioButton::getMinimumValue(  ) throw (RuntimeException)
 308 {
 309     OExternalLockGuard aGuard( this );
 310
 311     Any aValue;
 312     aValue <<= (sal_Int32) 0;
 313
 314     return aValue;
 315 }
 316
 317 // -----------------------------------------------------------------------------