comphelper/source/misc/accessibleselectionhelper.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: accessibleselectionhelper.cxx,v $
  10  * $Revision: 1.8 $
  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_comphelper.hxx"
  33 #include <comphelper/accessibleselectionhelper.hxx>
  34
  35 //.........................................................................
  36 namespace comphelper
  37 {
  38 //.........................................................................
  39
  40     using namespace ::com::sun::star::uno;
  41     using namespace ::com::sun::star::awt;
  42     using namespace ::com::sun::star::lang;
  43     using namespace ::com::sun::star::accessibility;
  44
  45     //=====================================================================
  46     //= OCommonAccessibleSelection
  47     //=====================================================================
  48     //---------------------------------------------------------------------
  49     OCommonAccessibleSelection::OCommonAccessibleSelection( )
  50     {
  51     }
  52
  53     //--------------------------------------------------------------------
  54     void SAL_CALL OCommonAccessibleSelection::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
  55     {
  56         implSelect( nChildIndex, sal_True );
  57     }
  58
  59     //--------------------------------------------------------------------
  60     sal_Bool SAL_CALL OCommonAccessibleSelection::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
  61     {
  62         return( implIsSelected( nChildIndex ) );
  63     }
  64
  65     //--------------------------------------------------------------------
  66     void SAL_CALL OCommonAccessibleSelection::clearAccessibleSelection(  ) throw (RuntimeException)
  67     {
  68         implSelect( ACCESSIBLE_SELECTION_CHILD_ALL, sal_False );
  69     }
  70
  71     //--------------------------------------------------------------------
  72     void SAL_CALL OCommonAccessibleSelection::selectAllAccessibleChildren(  ) throw (RuntimeException)
  73     {
  74         implSelect( ACCESSIBLE_SELECTION_CHILD_ALL, sal_True );
  75     }
  76
  77     //--------------------------------------------------------------------
  78     sal_Int32 SAL_CALL OCommonAccessibleSelection::getSelectedAccessibleChildCount(  ) throw (RuntimeException)
  79     {
  80         sal_Int32                       nRet = 0;
  81         Reference< XAccessibleContext > xParentContext( implGetAccessibleContext() );
  82
  83         OSL_ENSURE( xParentContext.is(), "OCommonAccessibleSelection::getSelectedAccessibleChildCount: no parent context!" );
  84
  85         if( xParentContext.is() )
  86         {
  87             for( sal_Int32 i = 0, nChildCount = xParentContext->getAccessibleChildCount(); i < nChildCount; i++ )
  88                 if( implIsSelected( i ) )
  89                     ++nRet;
  90         }
  91
  92         return( nRet );
  93     }
  94
  95     //--------------------------------------------------------------------
  96     Reference< XAccessible > SAL_CALL OCommonAccessibleSelection::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
  97     {
  98         Reference< XAccessible >        xRet;
  99         Reference< XAccessibleContext > xParentContext( implGetAccessibleContext() );
 100
 101         OSL_ENSURE( xParentContext.is(), "OCommonAccessibleSelection::getSelectedAccessibleChildCount: no parent context!" );
 102
 103         if( xParentContext.is() )
 104         {
 105             for( sal_Int32 i = 0, nChildCount = xParentContext->getAccessibleChildCount(), nPos = 0; ( i < nChildCount ) && !xRet.is(); i++ )
 106                 if( implIsSelected( i ) && ( nPos++ == nSelectedChildIndex ) )
 107                     xRet = xParentContext->getAccessibleChild( i );
 108         }
 109
 110         return( xRet );
 111     }
 112
 113     //--------------------------------------------------------------------
 114     void SAL_CALL OCommonAccessibleSelection::deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 115     {
 116         implSelect( nSelectedChildIndex, sal_False );
 117     }
 118
 119     //=====================================================================
 120     //= OAccessibleSelectionHelper
 121     //=====================================================================
 122     //---------------------------------------------------------------------
 123     OAccessibleSelectionHelper::OAccessibleSelectionHelper( )
 124     {
 125     }
 126
 127     //--------------------------------------------------------------------
 128     OAccessibleSelectionHelper::OAccessibleSelectionHelper( IMutex* _pExternalLock ) : OAccessibleComponentHelper(_pExternalLock)
 129     {
 130     }
 131
 132     //--------------------------------------------------------------------
 133     IMPLEMENT_FORWARD_XINTERFACE2( OAccessibleSelectionHelper, OAccessibleComponentHelper, OAccessibleSelectionHelper_Base )
 134     IMPLEMENT_FORWARD_XTYPEPROVIDER2( OAccessibleSelectionHelper, OAccessibleComponentHelper, OAccessibleSelectionHelper_Base )
 135     // (order matters: the first is the class name, the second is the class doing the ref counting)
 136
 137     //--------------------------------------------------------------------
 138     Reference< XAccessibleContext > OAccessibleSelectionHelper::implGetAccessibleContext() throw ( RuntimeException )
 139     {
 140         return( this );
 141     }
 142
 143     //--------------------------------------------------------------------
 144     void SAL_CALL OAccessibleSelectionHelper::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 145     {
 146         OExternalLockGuard aGuard( this );
 147         OCommonAccessibleSelection::selectAccessibleChild( nChildIndex );
 148     }
 149
 150     //--------------------------------------------------------------------
 151     sal_Bool SAL_CALL OAccessibleSelectionHelper::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 152     {
 153         OExternalLockGuard aGuard( this );
 154         return( OCommonAccessibleSelection::isAccessibleChildSelected( nChildIndex ) );
 155     }
 156
 157     //--------------------------------------------------------------------
 158     void SAL_CALL OAccessibleSelectionHelper::clearAccessibleSelection(  ) throw (RuntimeException)
 159     {
 160         OExternalLockGuard aGuard( this );
 161         OCommonAccessibleSelection::clearAccessibleSelection();
 162     }
 163
 164     //--------------------------------------------------------------------
 165     void SAL_CALL OAccessibleSelectionHelper::selectAllAccessibleChildren(  ) throw (RuntimeException)
 166     {
 167         OExternalLockGuard aGuard( this );
 168         OCommonAccessibleSelection::selectAllAccessibleChildren();
 169     }
 170
 171     //--------------------------------------------------------------------
 172     sal_Int32 SAL_CALL OAccessibleSelectionHelper::getSelectedAccessibleChildCount(  ) throw (RuntimeException)
 173     {
 174         OExternalLockGuard aGuard( this );
 175         return( OCommonAccessibleSelection::getSelectedAccessibleChildCount() );
 176     }
 177
 178     //--------------------------------------------------------------------
 179     Reference< XAccessible > SAL_CALL OAccessibleSelectionHelper::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 180     {
 181         OExternalLockGuard aGuard( this );
 182         return( OCommonAccessibleSelection::getSelectedAccessibleChild( nSelectedChildIndex ) );
 183     }
 184
 185     //--------------------------------------------------------------------
 186     void SAL_CALL OAccessibleSelectionHelper::deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 187     {
 188         OExternalLockGuard aGuard( this );
 189         OCommonAccessibleSelection::deselectAccessibleChild( nSelectedChildIndex );
 190     }
 191
 192 //.........................................................................
 193 }       // namespace comphelper
 194 //.........................................................................
 195