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 <standard/vclxaccessiblescrollbar.hxx>
  21
  22 #include <helper/accresmgr.hxx>
  23 #include <strings.hrc>
  24
  25 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  26 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  27 #include <com/sun/star/awt/ScrollBarOrientation.hpp>
  28 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  29 #include <comphelper/accessiblecontexthelper.hxx>
  30 #include <vcl/accessibility/strings.hxx>
  31 #include <vcl/vclevent.hxx>
  32
  33 using namespace ::com::sun::star;
  34 using namespace ::com::sun::star::uno;
  35 using namespace ::com::sun::star::awt;
  36 using namespace ::com::sun::star::lang;
  37 using namespace ::com::sun::star::accessibility;
  38 using namespace ::comphelper;
  39
  40
  41 // VCLXAccessibleScrollBar
  42
  43
  44 void VCLXAccessibleScrollBar::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  45 {
  46     switch ( rVclWindowEvent.GetId() )
  47     {
  48         case VclEventId::ScrollbarScroll:
  49         {
  50             NotifyAccessibleEvent( AccessibleEventId::VALUE_CHANGED, Any(), Any() );
  51         }
  52         break;
  53         default:
  54             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
  55    }
  56 }
  57
  58
  59 void VCLXAccessibleScrollBar::FillAccessibleStateSet( sal_Int64& rStateSet )
  60 {
  61     VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
  62
  63     // IA2 CWS: scroll bar should not have FOCUSABLE state.
  64     // rStateSet.AddState( AccessibleStateType::FOCUSABLE );
  65     rStateSet |= GetOrientationState();
  66 }
  67
  68
  69 // XServiceInfo
  70
  71
  72 OUString VCLXAccessibleScrollBar::getImplementationName()
  73 {
  74     return u"com.sun.star.comp.toolkit.AccessibleScrollBar"_ustr;
  75 }
  76
  77
  78 Sequence< OUString > VCLXAccessibleScrollBar::getSupportedServiceNames()
  79 {
  80     return { u"com.sun.star.awt.AccessibleScrollBar"_ustr };
  81 }
  82
  83
  84 // XAccessibleAction
  85
  86 constexpr sal_Int32 ACCESSIBLE_ACTION_COUNT=4;
  87
  88 sal_Int32 VCLXAccessibleScrollBar::getAccessibleActionCount( )
  89 {
  90     OExternalLockGuard aGuard( this );
  91
  92     return ACCESSIBLE_ACTION_COUNT;
  93 }
  94
  95
  96 sal_Bool VCLXAccessibleScrollBar::doAccessibleAction ( sal_Int32 nIndex )
  97 {
  98     OExternalLockGuard aGuard( this );
  99
 100     if ( nIndex < 0 || nIndex >= ACCESSIBLE_ACTION_COUNT )
 101         throw IndexOutOfBoundsException();
 102
 103     bool bReturn = false;
 104     VclPtr< ScrollBar > pScrollBar = GetAs< ScrollBar >();
 105     if ( pScrollBar )
 106     {
 107         ScrollType eScrollType;
 108         switch ( nIndex )
 109         {
 110             case 0:     eScrollType = ScrollType::LineUp;    break;
 111             case 1:     eScrollType = ScrollType::LineDown;  break;
 112             case 2:     eScrollType = ScrollType::PageUp;    break;
 113             case 3:     eScrollType = ScrollType::PageDown;  break;
 114             default:    eScrollType = ScrollType::DontKnow;  break;
 115         }
 116         if ( pScrollBar->DoScrollAction( eScrollType ) )
 117             bReturn = true;
 118     }
 119
 120     return bReturn;
 121 }
 122
 123
 124 OUString VCLXAccessibleScrollBar::getAccessibleActionDescription ( sal_Int32 nIndex )
 125 {
 126     OExternalLockGuard aGuard( this );
 127
 128     if ( nIndex < 0 || nIndex >= ACCESSIBLE_ACTION_COUNT )
 129         throw IndexOutOfBoundsException();
 130
 131     OUString sDescription;
 132
 133     switch ( nIndex )
 134     {
 135         case 0:     sDescription = RID_STR_ACC_ACTION_DECLINE;      break;
 136         case 1:     sDescription = RID_STR_ACC_ACTION_INCLINE;      break;
 137         case 2:     sDescription = RID_STR_ACC_ACTION_DECBLOCK;     break;
 138         case 3:     sDescription = RID_STR_ACC_ACTION_INCBLOCK;     break;
 139         default:                                                              break;
 140     }
 141
 142     return sDescription;
 143 }
 144
 145
 146 Reference< XAccessibleKeyBinding > VCLXAccessibleScrollBar::getAccessibleActionKeyBinding( sal_Int32 nIndex )
 147 {
 148     OExternalLockGuard aGuard( this );
 149
 150     if ( nIndex < 0 || nIndex >= ACCESSIBLE_ACTION_COUNT )
 151         throw IndexOutOfBoundsException();
 152
 153     return Reference< XAccessibleKeyBinding >();
 154 }
 155
 156
 157 // XAccessibleValue
 158
 159
 160 Any VCLXAccessibleScrollBar::getCurrentValue(  )
 161 {
 162     OExternalLockGuard aGuard( this );
 163
 164     Any aValue;
 165
 166     VclPtr<ScrollBar> pScrollBar = GetAs<ScrollBar>();
 167     if (pScrollBar)
 168         aValue <<= sal_Int32(pScrollBar->GetThumbPos());
 169
 170     return aValue;
 171 }
 172
 173
 174 sal_Bool VCLXAccessibleScrollBar::setCurrentValue( const Any& aNumber )
 175 {
 176     OExternalLockGuard aGuard( this );
 177
 178     bool bReturn = false;
 179
 180     VclPtr<ScrollBar> pScrollBar = GetAs<ScrollBar>();
 181     if (pScrollBar)
 182     {
 183         sal_Int32 nValue = 0;
 184         OSL_VERIFY( aNumber >>= nValue );
 185         sal_Int32 nValueMax = pScrollBar->GetRangeMax();
 186
 187         if (nValue < 0)
 188             nValue = 0;
 189         else if ( nValue > nValueMax )
 190             nValue = nValueMax;
 191
 192         pScrollBar->DoScroll(nValue);
 193         bReturn = true;
 194     }
 195
 196     return bReturn;
 197 }
 198
 199
 200 Any VCLXAccessibleScrollBar::getMaximumValue(  )
 201 {
 202     OExternalLockGuard aGuard( this );
 203
 204     Any aValue;
 205
 206     VclPtr<ScrollBar> pScrollBar = GetAs<ScrollBar>();
 207     if (pScrollBar)
 208         aValue <<= sal_Int32(pScrollBar->GetRangeMax());
 209
 210     return aValue;
 211 }
 212
 213
 214 Any VCLXAccessibleScrollBar::getMinimumValue(  )
 215 {
 216     OExternalLockGuard aGuard( this );
 217
 218     Any aValue;
 219     aValue <<= sal_Int32(0);
 220
 221     return aValue;
 222 }
 223
 224 Any VCLXAccessibleScrollBar::getMinimumIncrement(  )
 225 {
 226     OExternalLockGuard aGuard( this );
 227
 228     return Any();
 229 }
 230
 231
 232 OUString VCLXAccessibleScrollBar::getAccessibleName(  )
 233 {
 234     OExternalLockGuard aGuard( this );
 235
 236     if (VCLXAccessibleScrollBar::GetOrientationState() == AccessibleStateType::HORIZONTAL)
 237         return AccResId(RID_STR_ACC_SCROLLBAR_NAME_HORIZONTAL);
 238
 239     return AccResId(RID_STR_ACC_SCROLLBAR_NAME_VERTICAL);
 240 }
 241
 242 sal_Int64 VCLXAccessibleScrollBar::GetOrientationState() const
 243 {
 244     VclPtr<ScrollBar> pScrollBar = GetAs<ScrollBar>();
 245     if (!pScrollBar || pScrollBar->GetStyle() & WB_HORZ)
 246         return AccessibleStateType::HORIZONTAL;
 247
 248     return AccessibleStateType::VERTICAL;
 249 }
 250
 251
 252 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */