1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove 29*cdf0e10cSrcweir #include "precompiled_accessibility.hxx" 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir // includes -------------------------------------------------------------- 32*cdf0e10cSrcweir #include <accessibility/standard/vclxaccessiblescrollbar.hxx> 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir #include <toolkit/awt/vclxwindows.hxx> 35*cdf0e10cSrcweir #include <accessibility/helper/accresmgr.hxx> 36*cdf0e10cSrcweir #include <accessibility/helper/accessiblestrings.hrc> 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir #include <unotools/accessiblestatesethelper.hxx> 39*cdf0e10cSrcweir #include <com/sun/star/accessibility/AccessibleStateType.hpp> 40*cdf0e10cSrcweir #include <com/sun/star/accessibility/AccessibleEventId.hpp> 41*cdf0e10cSrcweir #include <com/sun/star/awt/ScrollBarOrientation.hpp> 42*cdf0e10cSrcweir #include <cppuhelper/typeprovider.hxx> 43*cdf0e10cSrcweir #include <comphelper/sequence.hxx> 44*cdf0e10cSrcweir #include <vcl/scrbar.hxx> 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir using namespace ::com::sun::star; 47*cdf0e10cSrcweir using namespace ::com::sun::star::uno; 48*cdf0e10cSrcweir using namespace ::com::sun::star::awt; 49*cdf0e10cSrcweir using namespace ::com::sun::star::lang; 50*cdf0e10cSrcweir using namespace ::com::sun::star::beans; 51*cdf0e10cSrcweir using namespace ::com::sun::star::accessibility; 52*cdf0e10cSrcweir using namespace ::comphelper; 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 56*cdf0e10cSrcweir // VCLXAccessibleScrollBar 57*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir VCLXAccessibleScrollBar::VCLXAccessibleScrollBar( VCLXWindow* pVCLWindow ) 60*cdf0e10cSrcweir :VCLXAccessibleComponent( pVCLWindow ) 61*cdf0e10cSrcweir { 62*cdf0e10cSrcweir } 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir VCLXAccessibleScrollBar::~VCLXAccessibleScrollBar() 67*cdf0e10cSrcweir { 68*cdf0e10cSrcweir } 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir void VCLXAccessibleScrollBar::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent ) 73*cdf0e10cSrcweir { 74*cdf0e10cSrcweir switch ( rVclWindowEvent.GetId() ) 75*cdf0e10cSrcweir { 76*cdf0e10cSrcweir case VCLEVENT_SCROLLBAR_SCROLL: 77*cdf0e10cSrcweir { 78*cdf0e10cSrcweir NotifyAccessibleEvent( AccessibleEventId::VALUE_CHANGED, Any(), Any() ); 79*cdf0e10cSrcweir } 80*cdf0e10cSrcweir break; 81*cdf0e10cSrcweir default: 82*cdf0e10cSrcweir VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent ); 83*cdf0e10cSrcweir } 84*cdf0e10cSrcweir } 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir void VCLXAccessibleScrollBar::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet ) 89*cdf0e10cSrcweir { 90*cdf0e10cSrcweir VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet ); 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() ); 93*cdf0e10cSrcweir if ( pVCLXScrollBar ) 94*cdf0e10cSrcweir { 95*cdf0e10cSrcweir rStateSet.AddState( AccessibleStateType::FOCUSABLE ); 96*cdf0e10cSrcweir if ( pVCLXScrollBar->getOrientation() == ScrollBarOrientation::HORIZONTAL ) 97*cdf0e10cSrcweir rStateSet.AddState( AccessibleStateType::HORIZONTAL ); 98*cdf0e10cSrcweir else if ( pVCLXScrollBar->getOrientation() == ScrollBarOrientation::VERTICAL ) 99*cdf0e10cSrcweir rStateSet.AddState( AccessibleStateType::VERTICAL ); 100*cdf0e10cSrcweir } 101*cdf0e10cSrcweir } 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 104*cdf0e10cSrcweir // XInterface 105*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleScrollBar, VCLXAccessibleComponent, VCLXAccessibleScrollBar_BASE ) 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 110*cdf0e10cSrcweir // XTypeProvider 111*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleScrollBar, VCLXAccessibleComponent, VCLXAccessibleScrollBar_BASE ) 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 116*cdf0e10cSrcweir // XServiceInfo 117*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 118*cdf0e10cSrcweir 119*cdf0e10cSrcweir ::rtl::OUString VCLXAccessibleScrollBar::getImplementationName() throw (RuntimeException) 120*cdf0e10cSrcweir { 121*cdf0e10cSrcweir return ::rtl::OUString::createFromAscii( "com.sun.star.comp.toolkit.AccessibleScrollBar" ); 122*cdf0e10cSrcweir } 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir Sequence< ::rtl::OUString > VCLXAccessibleScrollBar::getSupportedServiceNames() throw (RuntimeException) 127*cdf0e10cSrcweir { 128*cdf0e10cSrcweir Sequence< ::rtl::OUString > aNames(1); 129*cdf0e10cSrcweir aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleScrollBar" ); 130*cdf0e10cSrcweir return aNames; 131*cdf0e10cSrcweir } 132*cdf0e10cSrcweir 133*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 134*cdf0e10cSrcweir // XAccessibleAction 135*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir sal_Int32 VCLXAccessibleScrollBar::getAccessibleActionCount( ) throw (RuntimeException) 138*cdf0e10cSrcweir { 139*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 140*cdf0e10cSrcweir 141*cdf0e10cSrcweir return 4; 142*cdf0e10cSrcweir } 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 145*cdf0e10cSrcweir 146*cdf0e10cSrcweir sal_Bool VCLXAccessibleScrollBar::doAccessibleAction ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException) 147*cdf0e10cSrcweir { 148*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 149*cdf0e10cSrcweir 150*cdf0e10cSrcweir if ( nIndex < 0 || nIndex >= getAccessibleActionCount() ) 151*cdf0e10cSrcweir throw IndexOutOfBoundsException(); 152*cdf0e10cSrcweir 153*cdf0e10cSrcweir sal_Bool bReturn = sal_False; 154*cdf0e10cSrcweir ScrollBar* pScrollBar = static_cast< ScrollBar* >( GetWindow() ); 155*cdf0e10cSrcweir if ( pScrollBar ) 156*cdf0e10cSrcweir { 157*cdf0e10cSrcweir ScrollType eScrollType; 158*cdf0e10cSrcweir switch ( nIndex ) 159*cdf0e10cSrcweir { 160*cdf0e10cSrcweir case 0: eScrollType = SCROLL_LINEUP; break; 161*cdf0e10cSrcweir case 1: eScrollType = SCROLL_LINEDOWN; break; 162*cdf0e10cSrcweir case 2: eScrollType = SCROLL_PAGEUP; break; 163*cdf0e10cSrcweir case 3: eScrollType = SCROLL_PAGEDOWN; break; 164*cdf0e10cSrcweir default: eScrollType = SCROLL_DONTKNOW; break; 165*cdf0e10cSrcweir } 166*cdf0e10cSrcweir if ( pScrollBar->DoScrollAction( eScrollType ) ) 167*cdf0e10cSrcweir bReturn = sal_True; 168*cdf0e10cSrcweir } 169*cdf0e10cSrcweir 170*cdf0e10cSrcweir return bReturn; 171*cdf0e10cSrcweir } 172*cdf0e10cSrcweir 173*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 174*cdf0e10cSrcweir 175*cdf0e10cSrcweir ::rtl::OUString VCLXAccessibleScrollBar::getAccessibleActionDescription ( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException) 176*cdf0e10cSrcweir { 177*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 178*cdf0e10cSrcweir 179*cdf0e10cSrcweir if ( nIndex < 0 || nIndex >= getAccessibleActionCount() ) 180*cdf0e10cSrcweir throw IndexOutOfBoundsException(); 181*cdf0e10cSrcweir 182*cdf0e10cSrcweir ::rtl::OUString sDescription; 183*cdf0e10cSrcweir 184*cdf0e10cSrcweir switch ( nIndex ) 185*cdf0e10cSrcweir { 186*cdf0e10cSrcweir case 0: sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_DECLINE ) ); break; 187*cdf0e10cSrcweir case 1: sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_INCLINE ) ); break; 188*cdf0e10cSrcweir case 2: sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_DECBLOCK ) ); break; 189*cdf0e10cSrcweir case 3: sDescription = ::rtl::OUString( TK_RES_STRING( RID_STR_ACC_ACTION_INCBLOCK ) ); break; 190*cdf0e10cSrcweir default: break; 191*cdf0e10cSrcweir } 192*cdf0e10cSrcweir 193*cdf0e10cSrcweir return sDescription; 194*cdf0e10cSrcweir } 195*cdf0e10cSrcweir 196*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 197*cdf0e10cSrcweir 198*cdf0e10cSrcweir Reference< XAccessibleKeyBinding > VCLXAccessibleScrollBar::getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (IndexOutOfBoundsException, RuntimeException) 199*cdf0e10cSrcweir { 200*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 201*cdf0e10cSrcweir 202*cdf0e10cSrcweir if ( nIndex < 0 || nIndex >= getAccessibleActionCount() ) 203*cdf0e10cSrcweir throw IndexOutOfBoundsException(); 204*cdf0e10cSrcweir 205*cdf0e10cSrcweir return Reference< XAccessibleKeyBinding >(); 206*cdf0e10cSrcweir } 207*cdf0e10cSrcweir 208*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 209*cdf0e10cSrcweir // XAccessibleValue 210*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 211*cdf0e10cSrcweir 212*cdf0e10cSrcweir Any VCLXAccessibleScrollBar::getCurrentValue( ) throw (RuntimeException) 213*cdf0e10cSrcweir { 214*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 215*cdf0e10cSrcweir 216*cdf0e10cSrcweir Any aValue; 217*cdf0e10cSrcweir 218*cdf0e10cSrcweir VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() ); 219*cdf0e10cSrcweir if ( pVCLXScrollBar ) 220*cdf0e10cSrcweir aValue <<= (sal_Int32) pVCLXScrollBar->getValue(); 221*cdf0e10cSrcweir 222*cdf0e10cSrcweir return aValue; 223*cdf0e10cSrcweir } 224*cdf0e10cSrcweir 225*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 226*cdf0e10cSrcweir 227*cdf0e10cSrcweir sal_Bool VCLXAccessibleScrollBar::setCurrentValue( const Any& aNumber ) throw (RuntimeException) 228*cdf0e10cSrcweir { 229*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 230*cdf0e10cSrcweir 231*cdf0e10cSrcweir sal_Bool bReturn = sal_False; 232*cdf0e10cSrcweir 233*cdf0e10cSrcweir VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() ); 234*cdf0e10cSrcweir if ( pVCLXScrollBar ) 235*cdf0e10cSrcweir { 236*cdf0e10cSrcweir sal_Int32 nValue = 0, nValueMin = 0, nValueMax = 0; 237*cdf0e10cSrcweir OSL_VERIFY( aNumber >>= nValue ); 238*cdf0e10cSrcweir OSL_VERIFY( getMinimumValue() >>= nValueMin ); 239*cdf0e10cSrcweir OSL_VERIFY( getMaximumValue() >>= nValueMax ); 240*cdf0e10cSrcweir 241*cdf0e10cSrcweir if ( nValue < nValueMin ) 242*cdf0e10cSrcweir nValue = nValueMin; 243*cdf0e10cSrcweir else if ( nValue > nValueMax ) 244*cdf0e10cSrcweir nValue = nValueMax; 245*cdf0e10cSrcweir 246*cdf0e10cSrcweir pVCLXScrollBar->setValue( nValue ); 247*cdf0e10cSrcweir bReturn = sal_True; 248*cdf0e10cSrcweir } 249*cdf0e10cSrcweir 250*cdf0e10cSrcweir return bReturn; 251*cdf0e10cSrcweir } 252*cdf0e10cSrcweir 253*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 254*cdf0e10cSrcweir 255*cdf0e10cSrcweir Any VCLXAccessibleScrollBar::getMaximumValue( ) throw (RuntimeException) 256*cdf0e10cSrcweir { 257*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 258*cdf0e10cSrcweir 259*cdf0e10cSrcweir Any aValue; 260*cdf0e10cSrcweir 261*cdf0e10cSrcweir VCLXScrollBar* pVCLXScrollBar = static_cast< VCLXScrollBar* >( GetVCLXWindow() ); 262*cdf0e10cSrcweir if ( pVCLXScrollBar ) 263*cdf0e10cSrcweir aValue <<= (sal_Int32) pVCLXScrollBar->getMaximum(); 264*cdf0e10cSrcweir 265*cdf0e10cSrcweir return aValue; 266*cdf0e10cSrcweir } 267*cdf0e10cSrcweir 268*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 269*cdf0e10cSrcweir 270*cdf0e10cSrcweir Any VCLXAccessibleScrollBar::getMinimumValue( ) throw (RuntimeException) 271*cdf0e10cSrcweir { 272*cdf0e10cSrcweir OExternalLockGuard aGuard( this ); 273*cdf0e10cSrcweir 274*cdf0e10cSrcweir Any aValue; 275*cdf0e10cSrcweir aValue <<= (sal_Int32) 0; 276*cdf0e10cSrcweir 277*cdf0e10cSrcweir return aValue; 278*cdf0e10cSrcweir } 279*cdf0e10cSrcweir 280*cdf0e10cSrcweir // ----------------------------------------------------------------------------- 281