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