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