Line data Source code
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/extended/AccessibleBrowseBoxHeaderBar.hxx"
21 : #include <svtools/accessibletableprovider.hxx>
22 : #include <comphelper/servicehelper.hxx>
23 :
24 : // ============================================================================
25 :
26 : using ::com::sun::star::uno::Reference;
27 : using ::com::sun::star::uno::Sequence;
28 : using ::com::sun::star::uno::Any;
29 :
30 : using namespace ::com::sun::star;
31 : using namespace ::com::sun::star::accessibility;
32 : using namespace ::svt;
33 :
34 : // ============================================================================
35 :
36 : namespace accessibility {
37 :
38 : // ============================================================================
39 :
40 : // Ctor/Dtor/disposing --------------------------------------------------------
41 :
42 0 : AccessibleBrowseBoxHeaderBar::AccessibleBrowseBoxHeaderBar(
43 : const Reference< XAccessible >& rxParent,
44 : IAccessibleTableProvider& rBrowseBox,
45 : AccessibleBrowseBoxObjType eObjType ) :
46 0 : AccessibleBrowseBoxTableBase( rxParent, rBrowseBox,eObjType )
47 : {
48 : OSL_ENSURE( isRowBar() || isColumnBar(),
49 : "accessibility/extended/AccessibleBrowseBoxHeaderBar - invalid object type" );
50 0 : }
51 :
52 0 : AccessibleBrowseBoxHeaderBar::~AccessibleBrowseBoxHeaderBar()
53 : {
54 0 : }
55 :
56 : // XAccessibleContext ---------------------------------------------------------
57 :
58 : Reference< XAccessible > SAL_CALL
59 0 : AccessibleBrowseBoxHeaderBar::getAccessibleChild( sal_Int32 nChildIndex )
60 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
61 : {
62 0 : SolarMutexGuard aSolarGuard;
63 0 : ::osl::MutexGuard aGuard( getOslMutex() );
64 0 : ensureIsAlive();
65 0 : ensureIsValidHeaderIndex( nChildIndex );
66 0 : return implGetChild( nChildIndex, implToVCLColumnPos( nChildIndex ) );
67 : }
68 :
69 0 : sal_Int32 SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleIndexInParent()
70 : throw ( uno::RuntimeException )
71 : {
72 0 : return isRowBar() ? BBINDEX_ROWHEADERBAR : BBINDEX_COLUMNHEADERBAR;
73 : }
74 :
75 : // XAccessibleComponent -------------------------------------------------------
76 :
77 : Reference< XAccessible > SAL_CALL
78 0 : AccessibleBrowseBoxHeaderBar::getAccessibleAtPoint( const awt::Point& rPoint )
79 : throw ( uno::RuntimeException )
80 : {
81 0 : SolarMutexGuard aSolarGuard;
82 0 : ::osl::MutexGuard aGuard( getOslMutex() );
83 0 : ensureIsAlive();
84 :
85 0 : sal_Int32 nRow = 0;
86 0 : sal_uInt16 nColumnPos = 0;
87 0 : sal_Bool bConverted = isRowBar() ?
88 0 : mpBrowseBox->ConvertPointToRowHeader( nRow, VCLPoint( rPoint ) ) :
89 0 : mpBrowseBox->ConvertPointToColumnHeader( nColumnPos, VCLPoint( rPoint ) );
90 :
91 0 : return bConverted ? implGetChild( nRow, nColumnPos ) : Reference< XAccessible >();
92 : }
93 :
94 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::grabFocus()
95 : throw ( uno::RuntimeException )
96 : {
97 0 : ensureIsAlive();
98 : // focus on header not supported
99 0 : }
100 :
101 0 : Any SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleKeyBinding()
102 : throw ( uno::RuntimeException )
103 : {
104 0 : ensureIsAlive();
105 0 : return Any(); // no special key bindings for header
106 : }
107 :
108 : // XAccessibleTable -----------------------------------------------------------
109 :
110 0 : OUString SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleRowDescription( sal_Int32 nRow )
111 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
112 : {
113 0 : SolarMutexGuard aSolarGuard;
114 0 : ::osl::MutexGuard aGuard( getOslMutex() );
115 0 : ensureIsAlive();
116 0 : ensureIsValidRow( nRow );
117 0 : return OUString(); // no headers in headers
118 : }
119 :
120 0 : OUString SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleColumnDescription( sal_Int32 nColumn )
121 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
122 : {
123 0 : SolarMutexGuard aSolarGuard;
124 0 : ::osl::MutexGuard aGuard( getOslMutex() );
125 0 : ensureIsAlive();
126 0 : ensureIsValidColumn( nColumn );
127 0 : return OUString(); // no headers in headers
128 : }
129 :
130 0 : Reference< XAccessibleTable > SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleRowHeaders()
131 : throw ( uno::RuntimeException )
132 : {
133 0 : ensureIsAlive();
134 0 : return NULL; // no headers in headers
135 : }
136 :
137 0 : Reference< XAccessibleTable > SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleColumnHeaders()
138 : throw ( uno::RuntimeException )
139 : {
140 0 : ensureIsAlive();
141 0 : return NULL; // no headers in headers
142 : }
143 :
144 0 : Sequence< sal_Int32 > SAL_CALL AccessibleBrowseBoxHeaderBar::getSelectedAccessibleRows()
145 : throw ( uno::RuntimeException )
146 : {
147 0 : SolarMutexGuard aSolarGuard;
148 0 : ::osl::MutexGuard aGuard( getOslMutex() );
149 0 : ensureIsAlive();
150 :
151 0 : Sequence< sal_Int32 > aSelSeq;
152 : // row of column header bar not selectable
153 0 : if( isRowBar() )
154 0 : implGetSelectedRows( aSelSeq );
155 0 : return aSelSeq;
156 : }
157 :
158 0 : Sequence< sal_Int32 > SAL_CALL AccessibleBrowseBoxHeaderBar::getSelectedAccessibleColumns()
159 : throw ( uno::RuntimeException )
160 : {
161 0 : SolarMutexGuard aSolarGuard;
162 0 : ::osl::MutexGuard aGuard( getOslMutex() );
163 0 : ensureIsAlive();
164 :
165 0 : Sequence< sal_Int32 > aSelSeq;
166 : // column of row header bar ("handle column") not selectable
167 0 : if( isColumnBar() )
168 0 : implGetSelectedColumns( aSelSeq );
169 0 : return aSelSeq;
170 : }
171 :
172 0 : sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleRowSelected( sal_Int32 nRow )
173 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
174 : {
175 0 : SolarMutexGuard aSolarGuard;
176 0 : ::osl::MutexGuard aGuard( getOslMutex() );
177 0 : ensureIsAlive();
178 0 : ensureIsValidRow( nRow );
179 0 : return isRowBar() ? implIsRowSelected( nRow ) : sal_False;
180 : }
181 :
182 0 : sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleColumnSelected( sal_Int32 nColumn )
183 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
184 : {
185 0 : SolarMutexGuard aSolarGuard;
186 0 : ::osl::MutexGuard aGuard( getOslMutex() );
187 0 : ensureIsAlive();
188 0 : ensureIsValidColumn( nColumn );
189 0 : return isColumnBar() ? implIsColumnSelected( nColumn ) : sal_False;
190 : }
191 :
192 0 : Reference< XAccessible > SAL_CALL AccessibleBrowseBoxHeaderBar::getAccessibleCellAt(
193 : sal_Int32 nRow, sal_Int32 nColumn )
194 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
195 : {
196 0 : SolarMutexGuard aSolarGuard;
197 0 : ::osl::MutexGuard aGuard( getOslMutex() );
198 0 : ensureIsAlive();
199 0 : ensureIsValidAddress( nRow, nColumn );
200 0 : return implGetChild( nRow, implToVCLColumnPos( nColumn ) );
201 : }
202 :
203 0 : sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleSelected(
204 : sal_Int32 nRow, sal_Int32 nColumn )
205 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
206 : {
207 0 : SolarMutexGuard aSolarGuard;
208 0 : ::osl::MutexGuard aGuard( getOslMutex() );
209 0 : ensureIsAlive();
210 0 : ensureIsValidAddress( nRow, nColumn );
211 0 : return isRowBar() ? implIsRowSelected( nRow ) : implIsColumnSelected( nColumn );
212 : }
213 :
214 : // XAccessibleSelection -------------------------------------------------------
215 :
216 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::selectAccessibleChild( sal_Int32 nChildIndex )
217 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
218 : {
219 0 : SolarMutexGuard aSolarGuard;
220 0 : ::osl::MutexGuard aGuard( getOslMutex() );
221 0 : ensureIsAlive();
222 0 : ensureIsValidHeaderIndex( nChildIndex );
223 0 : if( isRowBar() )
224 0 : implSelectRow( nChildIndex, sal_True );
225 : else
226 0 : implSelectColumn( implToVCLColumnPos( nChildIndex ), sal_True );
227 0 : }
228 :
229 0 : sal_Bool SAL_CALL AccessibleBrowseBoxHeaderBar::isAccessibleChildSelected( sal_Int32 nChildIndex )
230 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
231 : {
232 : // using interface methods - no mutex
233 0 : return isRowBar() ?
234 0 : isAccessibleRowSelected( nChildIndex ) :
235 0 : isAccessibleColumnSelected( nChildIndex );
236 : }
237 :
238 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::clearAccessibleSelection()
239 : throw ( uno::RuntimeException )
240 : {
241 0 : SolarMutexGuard aSolarGuard;
242 0 : ::osl::MutexGuard aGuard( getOslMutex() );
243 0 : ensureIsAlive();
244 0 : mpBrowseBox->SetNoSelection();
245 0 : }
246 :
247 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::selectAllAccessibleChildren()
248 : throw ( uno::RuntimeException )
249 : {
250 0 : SolarMutexGuard aSolarGuard;
251 0 : ::osl::MutexGuard aGuard( getOslMutex() );
252 0 : ensureIsAlive();
253 : // no multiselection of columns possible
254 0 : if( isRowBar() )
255 0 : mpBrowseBox->SelectAll();
256 : else
257 0 : implSelectColumn( implToVCLColumnPos( 0 ), sal_True );
258 0 : }
259 :
260 0 : sal_Int32 SAL_CALL AccessibleBrowseBoxHeaderBar::getSelectedAccessibleChildCount()
261 : throw ( uno::RuntimeException )
262 : {
263 0 : SolarMutexGuard aSolarGuard;
264 0 : ::osl::MutexGuard aGuard( getOslMutex() );
265 0 : ensureIsAlive();
266 0 : return isRowBar() ? implGetSelectedRowCount() : implGetSelectedColumnCount();
267 : }
268 :
269 : Reference< XAccessible > SAL_CALL
270 0 : AccessibleBrowseBoxHeaderBar::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex )
271 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
272 : {
273 0 : SolarMutexGuard aSolarGuard;
274 0 : ::osl::MutexGuard aGuard( getOslMutex() );
275 0 : ensureIsAlive();
276 :
277 : // method may throw lang::IndexOutOfBoundsException
278 0 : sal_Int32 nIndex = implGetChildIndexFromSelectedIndex( nSelectedChildIndex );
279 0 : return implGetChild( nIndex, implToVCLColumnPos( nIndex ) );
280 : }
281 :
282 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::deselectAccessibleChild(
283 : sal_Int32 nSelectedChildIndex )
284 : throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
285 : {
286 0 : SolarMutexGuard aSolarGuard;
287 0 : ::osl::MutexGuard aGuard( getOslMutex() );
288 0 : ensureIsAlive();
289 :
290 : // method may throw lang::IndexOutOfBoundsException
291 0 : if ( isAccessibleChildSelected(nSelectedChildIndex) )
292 : {
293 0 : if( isRowBar() )
294 0 : implSelectRow( nSelectedChildIndex, sal_False );
295 : else
296 0 : implSelectColumn( implToVCLColumnPos( nSelectedChildIndex ), sal_False );
297 0 : }
298 0 : }
299 :
300 : // XInterface -----------------------------------------------------------------
301 :
302 0 : Any SAL_CALL AccessibleBrowseBoxHeaderBar::queryInterface( const uno::Type& rType )
303 : throw ( uno::RuntimeException )
304 : {
305 0 : Any aAny( AccessibleBrowseBoxTableBase::queryInterface( rType ) );
306 0 : return aAny.hasValue() ?
307 0 : aAny : AccessibleBrowseBoxHeaderBarImplHelper::queryInterface( rType );
308 : }
309 :
310 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::acquire() throw ()
311 : {
312 0 : AccessibleBrowseBoxTableBase::acquire();
313 0 : }
314 :
315 0 : void SAL_CALL AccessibleBrowseBoxHeaderBar::release() throw ()
316 : {
317 0 : AccessibleBrowseBoxTableBase::release();
318 0 : }
319 :
320 : // XServiceInfo ---------------------------------------------------------------
321 :
322 0 : OUString SAL_CALL AccessibleBrowseBoxHeaderBar::getImplementationName()
323 : throw ( uno::RuntimeException )
324 : {
325 0 : return OUString( "com.sun.star.comp.svtools.AccessibleBrowseBoxHeaderBar" );
326 : }
327 :
328 : namespace
329 : {
330 : class theAccessibleBrowseBoxHeaderBarImplementationId : public rtl::Static< UnoTunnelIdInit, theAccessibleBrowseBoxHeaderBarImplementationId > {};
331 : }
332 :
333 0 : Sequence< sal_Int8 > SAL_CALL AccessibleBrowseBoxHeaderBar::getImplementationId()
334 : throw ( uno::RuntimeException )
335 : {
336 0 : return theAccessibleBrowseBoxHeaderBarImplementationId::get().getSeq();
337 : }
338 :
339 : // internal virtual methods ---------------------------------------------------
340 :
341 0 : Rectangle AccessibleBrowseBoxHeaderBar::implGetBoundingBox()
342 : {
343 0 : return mpBrowseBox->calcHeaderRect(isColumnBar(),sal_False);
344 : }
345 :
346 0 : Rectangle AccessibleBrowseBoxHeaderBar::implGetBoundingBoxOnScreen()
347 : {
348 0 : return mpBrowseBox->calcHeaderRect(isColumnBar(),sal_True);
349 : }
350 :
351 0 : sal_Int32 AccessibleBrowseBoxHeaderBar::implGetRowCount() const
352 : {
353 : // column header bar: only 1 row
354 0 : return isRowBar() ? AccessibleBrowseBoxTableBase::implGetRowCount() : 1;
355 : }
356 :
357 0 : sal_Int32 AccessibleBrowseBoxHeaderBar::implGetColumnCount() const
358 : {
359 : // row header bar ("handle column"): only 1 column
360 0 : return isColumnBar() ? AccessibleBrowseBoxTableBase::implGetColumnCount() : 1;
361 : }
362 :
363 : // internal helper methods ----------------------------------------------------
364 :
365 0 : Reference< XAccessible > AccessibleBrowseBoxHeaderBar::implGetChild(
366 : sal_Int32 nRow, sal_uInt16 nColumnPos )
367 : {
368 0 : return isRowBar() ?
369 0 : mpBrowseBox->CreateAccessibleRowHeader( nRow ) :
370 0 : mpBrowseBox->CreateAccessibleColumnHeader( nColumnPos );
371 : }
372 :
373 0 : sal_Int32 AccessibleBrowseBoxHeaderBar::implGetChildIndexFromSelectedIndex(
374 : sal_Int32 nSelectedChildIndex )
375 : throw ( lang::IndexOutOfBoundsException )
376 : {
377 0 : Sequence< sal_Int32 > aSelSeq;
378 0 : if( isRowBar() )
379 0 : implGetSelectedRows( aSelSeq );
380 : else
381 0 : implGetSelectedColumns( aSelSeq );
382 :
383 0 : if( (nSelectedChildIndex < 0) || (nSelectedChildIndex >= aSelSeq.getLength()) )
384 0 : throw lang::IndexOutOfBoundsException();
385 :
386 0 : return aSelSeq[ nSelectedChildIndex ];
387 : }
388 :
389 0 : void AccessibleBrowseBoxHeaderBar::ensureIsValidHeaderIndex( sal_Int32 nIndex )
390 : throw ( lang::IndexOutOfBoundsException )
391 : {
392 0 : if( isRowBar() )
393 0 : ensureIsValidRow( nIndex );
394 : else
395 0 : ensureIsValidColumn( nIndex );
396 0 : }
397 :
398 : // ============================================================================
399 :
400 : } // namespace accessibility
401 :
402 : // ============================================================================
403 :
404 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|