accessibility/source/standard/vclxaccessiblescrollbar.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: vclxaccessiblescrollbar.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/vclxaccessiblescrollbar.hxx>
  36
  37 #include <toolkit/awt/vclxwindows.hxx>
  38 #include <accessibility/helper/accresmgr.hxx>
  39 #include <accessibility/helper/accessiblestrings.hrc>
  40
  41 #include <unotools/accessiblestatesethelper.hxx>
  42 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  43 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  44 #include <com/sun/star/awt/ScrollBarOrientation.hpp>
  45 #include <cppuhelper/typeprovider.hxx>
  46 #include <comphelper/sequence.hxx>
  47 #include <vcl/scrbar.hxx>
  48
  49 using namespace ::com::sun::star;
  50 using namespace ::com::sun::star::uno;
  51 using namespace ::com::sun::star::awt;
  52 using namespace ::com::sun::star::lang;
  53 using namespace ::com::sun::star::beans;
  54 using namespace ::com::sun::star::accessibility;
  55 using namespace ::comphelper;
  56
  57
  58 // -----------------------------------------------------------------------------
  59 // VCLXAccessibleScrollBar
  60 // -----------------------------------------------------------------------------
  61
  62 VCLXAccessibleScrollBar::VCLXAccessibleScrollBar( VCLXWindow* pVCLWindow )
  63     :VCLXAccessibleComponent( pVCLWindow )
  64 {
  65 }
  66
  67 // -----------------------------------------------------------------------------
  68
  69 VCLXAccessibleScrollBar::~VCLXAccessibleScrollBar()
  70 {
  71 }
  72
  73 // -----------------------------------------------------------------------------
  74
  75 void VCLXAccessibleScrollBar::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  76 {
  77     switch ( rVclWindowEvent.GetId() )
  78     {
  79         case VCLEVENT_SCROLLBAR_SCROLL:
  80         {
  81             NotifyAccessibleEvent( AccessibleEventId::VALUE_CHANGED, Any(), Any() );
  82         }
  83         break;
  84         default:
  85             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
  86    }
  87 }
  88
  89 // -----------------------------------------------------------------------------
  90
  91 void VCLXAccessibleScrollBar::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
  92 {
  93     VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
  94
  95     VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() );
  96     if ( pVCLXScrollBar )
  97     {
  98         rStateSet.AddState( AccessibleStateType::FOCUSABLE );
  99         if ( pVCLXScrollBar->getOrientation() == ScrollBarOrientation::HORIZONTAL )
 100             rStateSet.AddState( AccessibleStateType::HORIZONTAL );
 101         else if ( pVCLXScrollBar->getOrientation() == ScrollBarOrientation::VERTICAL )
 102             rStateSet.AddState( AccessibleStateType::VERTICAL );
 103     }
 104 }
 105
 106 // -----------------------------------------------------------------------------
 107 // XInterface
 108 // -----------------------------------------------------------------------------
 109
 110 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleScrollBar, VCLXAccessibleComponent, VCLXAccessibleScrollBar_BASE )
 111
 112 // -----------------------------------------------------------------------------
 113 // XTypeProvider
 114 // -----------------------------------------------------------------------------
 115
 116 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleScrollBar, VCLXAccessibleComponent, VCLXAccessibleScrollBar_BASE )
 117
 118 // -----------------------------------------------------------------------------
 119 // XServiceInfo
 120 // -----------------------------------------------------------------------------
 121
 122 ::rtl::OUString VCLXAccessibleScrollBar::getImplementationName() throw (RuntimeException)
 123 {
 124     return ::rtl::OUString::createFromAscii( "com.sun.star.comp.toolkit.AccessibleScrollBar" );
 125 }
 126
 127 // -----------------------------------------------------------------------------
 128
 129 Sequence< ::rtl::OUString > VCLXAccessibleScrollBar::getSupportedServiceNames() throw (RuntimeException)
 130 {
 131     Sequence< ::rtl::OUString > aNames(1);
 132     aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleScrollBar" );
 133     return aNames;
 134 }
 135
 136 // -----------------------------------------------------------------------------
 137 // XAccessibleAction
 138 // -----------------------------------------------------------------------------
 139
 140 sal_Int32 VCLXAccessibleScrollBar::getAccessibleActionCount( ) throw (RuntimeException)
 141 {
 142     OExternalLockGuard aGuard( this );
 143
 144     return 4;
 145 }
 146
 147 // -----------------------------------------------------------------------------
 148
 149 sal_Bool VCLXAccessibleScrollBar::doAccessibleAction ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 150 {
 151     OExternalLockGuard aGuard( this );
 152
 153     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 154         throw IndexOutOfBoundsException();
 155
 156     sal_Bool bReturn = sal_False;
 157     ScrollBar* pScrollBar = static_cast< ScrollBar* >( GetWindow() );
 158     if ( pScrollBar )
 159     {
 160         ScrollType eScrollType;
 161         switch ( nIndex )
 162         {
 163             case 0:             eScrollType = SCROLL_LINEUP;    break;
 164             case 1:             eScrollType = SCROLL_LINEDOWN;  break;
 165             case 2:             eScrollType = SCROLL_PAGEUP;    break;
 166             case 3:             eScrollType = SCROLL_PAGEDOWN;  break;
 167             default:    eScrollType = SCROLL_DONTKNOW;  break;
 168         }
 169         if ( pScrollBar->DoScrollAction( eScrollType ) )
 170             bReturn = sal_True;
 171     }
 172
 173     return bReturn;
 174 }
 175
 176 // -----------------------------------------------------------------------------
 177
 178 ::rtl::OUString VCLXAccessibleScrollBar::getAccessibleActionDescription ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 179 {
 180     OExternalLockGuard aGuard( this );
 181
 182     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 183         throw IndexOutOfBoundsException();
 184
 185     ::rtl::OUString sDescription;
 186
 187     switch ( nIndex )
 188     {
 189         case 0:         sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_DECLINE ) );          break;
 190         case 1:         sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_INCLINE ) );          break;
 191         case 2:         sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_DECBLOCK ) );         break;
 192         case 3:         sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_INCBLOCK ) );         break;
 193         default:                                                                                                                                                                                break;
 194     }
 195
 196     return sDescription;
 197 }
 198
 199 // -----------------------------------------------------------------------------
 200
 201 Reference< XAccessibleKeyBinding > VCLXAccessibleScrollBar::getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 202 {
 203     OExternalLockGuard aGuard( this );
 204
 205     if ( nIndex < 0 || nIndex >= getAccessibleActionCount() )
 206         throw IndexOutOfBoundsException();
 207
 208     return Reference< XAccessibleKeyBinding >();
 209 }
 210
 211 // -----------------------------------------------------------------------------
 212 // XAccessibleValue
 213 // -----------------------------------------------------------------------------
 214
 215 Any VCLXAccessibleScrollBar::getCurrentValue(  ) throw (RuntimeException)
 216 {
 217     OExternalLockGuard aGuard( this );
 218
 219     Any aValue;
 220
 221     VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() );
 222     if ( pVCLXScrollBar )
 223         aValue <<= (sal_Int32) pVCLXScrollBar->getValue();
 224
 225     return aValue;
 226 }
 227
 228 // -----------------------------------------------------------------------------
 229
 230 sal_Bool VCLXAccessibleScrollBar::setCurrentValue( const Any& aNumber ) throw (RuntimeException)
 231 {
 232     OExternalLockGuard aGuard( this );
 233
 234     sal_Bool bReturn = sal_False;
 235
 236     VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() );
 237     if ( pVCLXScrollBar )
 238     {
 239         sal_Int32 nValue = 0, nValueMin = 0, nValueMax = 0;
 240         OSL_VERIFY( aNumber >>= nValue );
 241         OSL_VERIFY( getMinimumValue() >>= nValueMin );
 242         OSL_VERIFY( getMaximumValue() >>= nValueMax );
 243
 244         if ( nValue < nValueMin )
 245             nValue = nValueMin;
 246         else if ( nValue > nValueMax )
 247             nValue = nValueMax;
 248
 249         pVCLXScrollBar->setValue( nValue );
 250         bReturn = sal_True;
 251     }
 252
 253     return bReturn;
 254 }
 255
 256 // -----------------------------------------------------------------------------
 257
 258 Any VCLXAccessibleScrollBar::getMaximumValue(  ) throw (RuntimeException)
 259 {
 260     OExternalLockGuard aGuard( this );
 261
 262     Any aValue;
 263
 264     VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() );
 265     if ( pVCLXScrollBar )
 266         aValue <<= (sal_Int32) pVCLXScrollBar->getMaximum();
 267
 268     return aValue;
 269 }
 270
 271 // -----------------------------------------------------------------------------
 272
 273 Any VCLXAccessibleScrollBar::getMinimumValue(  ) throw (RuntimeException)
 274 {
 275     OExternalLockGuard aGuard( this );
 276
 277     Any aValue;
 278     aValue <<= (sal_Int32) 0;
 279
 280     return aValue;
 281 }
 282
 283 // -----------------------------------------------------------------------------