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/standard/vclxaccessibletabcontrol.hxx>
21 : #include <accessibility/standard/vclxaccessibletabpage.hxx>
22 :
23 : #include <com/sun/star/accessibility/AccessibleEventId.hpp>
24 : #include <com/sun/star/accessibility/AccessibleRole.hpp>
25 : #include <com/sun/star/accessibility/AccessibleStateType.hpp>
26 : #include <unotools/accessiblestatesethelper.hxx>
27 : #include <vcl/tabctrl.hxx>
28 : #include <vcl/tabpage.hxx>
29 :
30 : #include <vector>
31 :
32 : using namespace ::com::sun::star;
33 : using namespace ::com::sun::star::uno;
34 : using namespace ::com::sun::star::lang;
35 : using namespace ::com::sun::star::accessibility;
36 : using namespace ::comphelper;
37 :
38 :
39 :
40 : // class VCLXAccessibleTabControl
41 :
42 :
43 0 : VCLXAccessibleTabControl::VCLXAccessibleTabControl( VCLXWindow* pVCLXWindow )
44 0 : :VCLXAccessibleComponent( pVCLXWindow )
45 : {
46 0 : m_pTabControl = static_cast< TabControl* >( GetWindow() );
47 :
48 0 : if ( m_pTabControl )
49 0 : m_aAccessibleChildren.assign( m_pTabControl->GetPageCount(), Reference< XAccessible >() );
50 0 : }
51 :
52 :
53 :
54 0 : VCLXAccessibleTabControl::~VCLXAccessibleTabControl()
55 : {
56 0 : }
57 :
58 :
59 :
60 0 : void VCLXAccessibleTabControl::UpdateFocused()
61 : {
62 0 : for ( sal_uInt32 i = 0; i < m_aAccessibleChildren.size(); ++i )
63 : {
64 0 : Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
65 0 : if ( xChild.is() )
66 : {
67 0 : VCLXAccessibleTabPage* pVCLXAccessibleTabPage = static_cast< VCLXAccessibleTabPage* >( xChild.get() );
68 0 : if ( pVCLXAccessibleTabPage )
69 0 : pVCLXAccessibleTabPage->SetFocused( pVCLXAccessibleTabPage->IsFocused() );
70 : }
71 0 : }
72 0 : }
73 :
74 :
75 :
76 0 : void VCLXAccessibleTabControl::UpdateSelected( sal_Int32 i, bool bSelected )
77 : {
78 0 : if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
79 : {
80 0 : Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
81 0 : if ( xChild.is() )
82 : {
83 0 : VCLXAccessibleTabPage* pVCLXAccessibleTabPage = static_cast< VCLXAccessibleTabPage* >( xChild.get() );
84 0 : if ( pVCLXAccessibleTabPage )
85 0 : pVCLXAccessibleTabPage->SetSelected( bSelected );
86 0 : }
87 : }
88 0 : }
89 :
90 :
91 :
92 0 : void VCLXAccessibleTabControl::UpdatePageText( sal_Int32 i )
93 : {
94 0 : if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
95 : {
96 0 : Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
97 0 : if ( xChild.is() )
98 : {
99 0 : VCLXAccessibleTabPage* pVCLXAccessibleTabPage = static_cast< VCLXAccessibleTabPage* >( xChild.get() );
100 0 : if ( pVCLXAccessibleTabPage )
101 0 : pVCLXAccessibleTabPage->SetPageText( pVCLXAccessibleTabPage->GetPageText() );
102 0 : }
103 : }
104 0 : }
105 :
106 :
107 :
108 0 : void VCLXAccessibleTabControl::UpdateTabPage( sal_Int32 i, bool bNew )
109 : {
110 0 : if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
111 : {
112 0 : Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
113 0 : if ( xChild.is() )
114 : {
115 0 : VCLXAccessibleTabPage* pVCLXAccessibleTabPage = static_cast< VCLXAccessibleTabPage* >( xChild.get() );
116 0 : if ( pVCLXAccessibleTabPage )
117 0 : pVCLXAccessibleTabPage->Update( bNew );
118 0 : }
119 : }
120 0 : }
121 :
122 :
123 :
124 0 : void VCLXAccessibleTabControl::InsertChild( sal_Int32 i )
125 : {
126 0 : if ( i >= 0 && i <= (sal_Int32)m_aAccessibleChildren.size() )
127 : {
128 : // insert entry in child list
129 0 : m_aAccessibleChildren.insert( m_aAccessibleChildren.begin() + i, Reference< XAccessible >() );
130 :
131 : // send accessible child event
132 0 : Reference< XAccessible > xChild( getAccessibleChild( i ) );
133 0 : if ( xChild.is() )
134 : {
135 0 : Any aOldValue, aNewValue;
136 0 : aNewValue <<= xChild;
137 0 : NotifyAccessibleEvent( AccessibleEventId::CHILD, aOldValue, aNewValue );
138 0 : }
139 : }
140 0 : }
141 :
142 :
143 :
144 0 : void VCLXAccessibleTabControl::RemoveChild( sal_Int32 i )
145 : {
146 0 : if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
147 : {
148 : // get the accessible of the removed page
149 0 : Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
150 :
151 : // remove entry in child list
152 0 : m_aAccessibleChildren.erase( m_aAccessibleChildren.begin() + i );
153 :
154 : // send accessible child event
155 0 : if ( xChild.is() )
156 : {
157 0 : Any aOldValue, aNewValue;
158 0 : aOldValue <<= xChild;
159 0 : NotifyAccessibleEvent( AccessibleEventId::CHILD, aOldValue, aNewValue );
160 :
161 0 : Reference< XComponent > xComponent( xChild, UNO_QUERY );
162 0 : if ( xComponent.is() )
163 0 : xComponent->dispose();
164 0 : }
165 : }
166 0 : }
167 :
168 :
169 :
170 0 : void VCLXAccessibleTabControl::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
171 : {
172 0 : switch ( rVclWindowEvent.GetId() )
173 : {
174 : case VCLEVENT_TABPAGE_ACTIVATE:
175 : case VCLEVENT_TABPAGE_DEACTIVATE:
176 : {
177 0 : if ( m_pTabControl )
178 : {
179 0 : sal_uInt16 nPageId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
180 0 : sal_uInt16 nPagePos = m_pTabControl->GetPagePos( nPageId );
181 0 : UpdateFocused();
182 0 : UpdateSelected( nPagePos, rVclWindowEvent.GetId() == VCLEVENT_TABPAGE_ACTIVATE );
183 : }
184 : }
185 0 : break;
186 : case VCLEVENT_TABPAGE_PAGETEXTCHANGED:
187 : {
188 0 : if ( m_pTabControl )
189 : {
190 0 : sal_uInt16 nPageId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
191 0 : sal_uInt16 nPagePos = m_pTabControl->GetPagePos( nPageId );
192 0 : UpdatePageText( nPagePos );
193 : }
194 : }
195 0 : break;
196 : case VCLEVENT_TABPAGE_INSERTED:
197 : {
198 0 : if ( m_pTabControl )
199 : {
200 0 : sal_uInt16 nPageId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
201 0 : sal_uInt16 nPagePos = m_pTabControl->GetPagePos( nPageId );
202 0 : InsertChild( nPagePos );
203 : }
204 : }
205 0 : break;
206 : case VCLEVENT_TABPAGE_REMOVED:
207 : {
208 0 : if ( m_pTabControl )
209 : {
210 0 : sal_uInt16 nPageId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
211 0 : for ( sal_Int32 i = 0, nCount = getAccessibleChildCount(); i < nCount; ++i )
212 : {
213 0 : Reference< XAccessible > xChild( getAccessibleChild( i ) );
214 0 : if ( xChild.is() )
215 : {
216 0 : VCLXAccessibleTabPage* pVCLXAccessibleTabPage = static_cast< VCLXAccessibleTabPage* >( xChild.get() );
217 0 : if ( pVCLXAccessibleTabPage && pVCLXAccessibleTabPage->GetPageId() == nPageId )
218 : {
219 0 : RemoveChild( i );
220 0 : break;
221 : }
222 : }
223 0 : }
224 : }
225 : }
226 0 : break;
227 : case VCLEVENT_TABPAGE_REMOVEDALL:
228 : {
229 0 : for ( sal_Int32 i = m_aAccessibleChildren.size() - 1; i >= 0; --i )
230 0 : RemoveChild( i );
231 : }
232 0 : break;
233 : case VCLEVENT_WINDOW_GETFOCUS:
234 : case VCLEVENT_WINDOW_LOSEFOCUS:
235 : {
236 0 : UpdateFocused();
237 : }
238 0 : break;
239 : case VCLEVENT_OBJECT_DYING:
240 : {
241 0 : if ( m_pTabControl )
242 : {
243 0 : m_pTabControl = NULL;
244 :
245 : // dispose all tab pages
246 0 : for ( sal_uInt32 i = 0; i < m_aAccessibleChildren.size(); ++i )
247 : {
248 0 : Reference< XComponent > xComponent( m_aAccessibleChildren[i], UNO_QUERY );
249 0 : if ( xComponent.is() )
250 0 : xComponent->dispose();
251 0 : }
252 0 : m_aAccessibleChildren.clear();
253 : }
254 :
255 0 : VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
256 : }
257 0 : break;
258 : default:
259 0 : VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
260 : }
261 0 : }
262 :
263 :
264 :
265 0 : void VCLXAccessibleTabControl::ProcessWindowChildEvent( const VclWindowEvent& rVclWindowEvent )
266 : {
267 0 : switch ( rVclWindowEvent.GetId() )
268 : {
269 : case VCLEVENT_WINDOW_SHOW:
270 : case VCLEVENT_WINDOW_HIDE:
271 : {
272 0 : if ( m_pTabControl )
273 : {
274 0 : Window* pChild = static_cast< Window* >( rVclWindowEvent.GetData() );
275 0 : if ( pChild && pChild->GetType() == WINDOW_TABPAGE )
276 : {
277 0 : for ( sal_Int32 i = 0, nCount = m_pTabControl->GetPageCount(); i < nCount; ++i )
278 : {
279 0 : sal_uInt16 nPageId = m_pTabControl->GetPageId( (sal_uInt16)i );
280 0 : TabPage* pTabPage = m_pTabControl->GetTabPage( nPageId );
281 0 : if ( pTabPage == (TabPage*) pChild )
282 0 : UpdateTabPage( i, rVclWindowEvent.GetId() == VCLEVENT_WINDOW_SHOW );
283 : }
284 : }
285 : }
286 : }
287 0 : break;
288 : default:
289 0 : VCLXAccessibleComponent::ProcessWindowChildEvent( rVclWindowEvent );
290 : }
291 0 : }
292 :
293 :
294 :
295 :
296 0 : void VCLXAccessibleTabControl::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
297 : {
298 0 : VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
299 :
300 0 : if ( m_pTabControl )
301 0 : rStateSet.AddState( AccessibleStateType::FOCUSABLE );
302 0 : }
303 :
304 :
305 : // XInterface
306 :
307 :
308 0 : IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleTabControl, VCLXAccessibleComponent, VCLXAccessibleTabControl_BASE )
309 :
310 :
311 : // XTypeProvider
312 :
313 :
314 0 : IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleTabControl, VCLXAccessibleComponent, VCLXAccessibleTabControl_BASE )
315 :
316 :
317 : // XComponent
318 :
319 :
320 0 : void VCLXAccessibleTabControl::disposing()
321 : {
322 0 : VCLXAccessibleComponent::disposing();
323 :
324 0 : if ( m_pTabControl )
325 : {
326 0 : m_pTabControl = NULL;
327 :
328 : // dispose all tab pages
329 0 : for ( sal_uInt32 i = 0; i < m_aAccessibleChildren.size(); ++i )
330 : {
331 0 : Reference< XComponent > xComponent( m_aAccessibleChildren[i], UNO_QUERY );
332 0 : if ( xComponent.is() )
333 0 : xComponent->dispose();
334 0 : }
335 0 : m_aAccessibleChildren.clear();
336 : }
337 0 : }
338 :
339 :
340 : // XServiceInfo
341 :
342 :
343 0 : OUString VCLXAccessibleTabControl::getImplementationName() throw (RuntimeException, std::exception)
344 : {
345 0 : return OUString( "com.sun.star.comp.toolkit.AccessibleTabControl" );
346 : }
347 :
348 :
349 :
350 0 : Sequence< OUString > VCLXAccessibleTabControl::getSupportedServiceNames() throw (RuntimeException, std::exception)
351 : {
352 0 : Sequence< OUString > aNames(1);
353 0 : aNames[0] = "com.sun.star.awt.AccessibleTabControl";
354 0 : return aNames;
355 : }
356 :
357 :
358 : // XAccessibleContext
359 :
360 :
361 0 : sal_Int32 VCLXAccessibleTabControl::getAccessibleChildCount() throw (RuntimeException, std::exception)
362 : {
363 0 : OExternalLockGuard aGuard( this );
364 :
365 0 : return m_aAccessibleChildren.size();
366 : }
367 :
368 :
369 :
370 0 : Reference< XAccessible > VCLXAccessibleTabControl::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
371 : {
372 0 : OExternalLockGuard aGuard( this );
373 :
374 0 : if ( i < 0 || i >= getAccessibleChildCount() )
375 0 : throw IndexOutOfBoundsException();
376 :
377 0 : Reference< XAccessible > xChild = m_aAccessibleChildren[i];
378 0 : if ( !xChild.is() )
379 : {
380 0 : if ( m_pTabControl )
381 : {
382 0 : sal_uInt16 nPageId = m_pTabControl->GetPageId( (sal_uInt16)i );
383 :
384 0 : xChild = new VCLXAccessibleTabPage( m_pTabControl, nPageId );
385 :
386 : // insert into tab page list
387 0 : m_aAccessibleChildren[i] = xChild;
388 : }
389 : }
390 :
391 0 : return xChild;
392 : }
393 :
394 :
395 :
396 0 : sal_Int16 VCLXAccessibleTabControl::getAccessibleRole( ) throw (RuntimeException, std::exception)
397 : {
398 0 : OExternalLockGuard aGuard( this );
399 :
400 0 : return AccessibleRole::PAGE_TAB_LIST;
401 : }
402 :
403 :
404 :
405 0 : OUString VCLXAccessibleTabControl::getAccessibleName( ) throw (RuntimeException, std::exception)
406 : {
407 0 : OExternalLockGuard aGuard( this );
408 :
409 0 : return OUString();
410 : }
411 :
412 :
413 : // XAccessibleSelection
414 :
415 :
416 0 : void VCLXAccessibleTabControl::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
417 : {
418 0 : OExternalLockGuard aGuard( this );
419 :
420 0 : if ( nChildIndex < 0 || nChildIndex >= getAccessibleChildCount() )
421 0 : throw IndexOutOfBoundsException();
422 :
423 0 : if ( m_pTabControl )
424 0 : m_pTabControl->SelectTabPage( m_pTabControl->GetPageId( (sal_uInt16)nChildIndex ) );
425 0 : }
426 :
427 :
428 :
429 0 : sal_Bool VCLXAccessibleTabControl::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
430 : {
431 0 : OExternalLockGuard aGuard( this );
432 :
433 0 : if ( nChildIndex < 0 || nChildIndex >= getAccessibleChildCount() )
434 0 : throw IndexOutOfBoundsException();
435 :
436 0 : sal_Bool bSelected = sal_False;
437 0 : if ( m_pTabControl && m_pTabControl->GetCurPageId() == m_pTabControl->GetPageId( (sal_uInt16)nChildIndex ) )
438 0 : bSelected = sal_True;
439 :
440 0 : return bSelected;
441 : }
442 :
443 :
444 :
445 0 : void VCLXAccessibleTabControl::clearAccessibleSelection( ) throw (RuntimeException, std::exception)
446 : {
447 : // This method makes no sense in a tab control, and so does nothing.
448 0 : }
449 :
450 :
451 :
452 0 : void VCLXAccessibleTabControl::selectAllAccessibleChildren( ) throw (RuntimeException, std::exception)
453 : {
454 0 : OExternalLockGuard aGuard( this );
455 :
456 0 : selectAccessibleChild( 0 );
457 0 : }
458 :
459 :
460 :
461 0 : sal_Int32 VCLXAccessibleTabControl::getSelectedAccessibleChildCount( ) throw (RuntimeException, std::exception)
462 : {
463 0 : OExternalLockGuard aGuard( this );
464 :
465 0 : return 1;
466 : }
467 :
468 :
469 :
470 0 : Reference< XAccessible > VCLXAccessibleTabControl::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
471 : {
472 0 : OExternalLockGuard aGuard( this );
473 :
474 0 : if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
475 0 : throw IndexOutOfBoundsException();
476 :
477 0 : Reference< XAccessible > xChild;
478 :
479 0 : for ( sal_Int32 i = 0, j = 0, nCount = getAccessibleChildCount(); i < nCount; i++ )
480 : {
481 0 : if ( isAccessibleChildSelected( i ) && ( j++ == nSelectedChildIndex ) )
482 : {
483 0 : xChild = getAccessibleChild( i );
484 0 : break;
485 : }
486 : }
487 :
488 0 : return xChild;
489 : }
490 :
491 :
492 :
493 0 : void VCLXAccessibleTabControl::deselectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
494 : {
495 0 : OExternalLockGuard aGuard( this );
496 :
497 0 : if ( nChildIndex < 0 || nChildIndex >= getAccessibleChildCount() )
498 0 : throw IndexOutOfBoundsException();
499 :
500 : // This method makes no sense in a tab control, and so does nothing.
501 0 : }
502 :
503 :
504 :
505 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
