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/accessiblemenuitemcomponent.hxx>
21 :
22 :
23 : #include <accessibility/helper/accresmgr.hxx>
24 : #include <accessibility/helper/accessiblestrings.hrc>
25 : #include <toolkit/awt/vclxwindows.hxx>
26 : #include <toolkit/helper/externallock.hxx>
27 : #include <toolkit/helper/convert.hxx>
28 :
29 : #include <com/sun/star/accessibility/AccessibleEventId.hpp>
30 : #include <com/sun/star/accessibility/AccessibleRole.hpp>
31 : #include <com/sun/star/accessibility/AccessibleStateType.hpp>
32 : #include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
33 : #include <com/sun/star/datatransfer/clipboard/XFlushableClipboard.hpp>
34 :
35 : #include <unotools/accessiblestatesethelper.hxx>
36 : #include <unotools/accessiblerelationsethelper.hxx>
37 : #include <cppuhelper/typeprovider.hxx>
38 : #include <comphelper/sequence.hxx>
39 : #include <comphelper/accessibletexthelper.hxx>
40 : #include <vcl/svapp.hxx>
41 : #include <vcl/window.hxx>
42 : #include <vcl/menu.hxx>
43 : #include <vcl/unohelp2.hxx>
44 : #include <vcl/settings.hxx>
45 :
46 : using namespace ::com::sun::star::accessibility;
47 : using namespace ::com::sun::star::uno;
48 : using namespace ::com::sun::star::beans;
49 : using namespace ::com::sun::star::lang;
50 : using namespace ::com::sun::star;
51 : using namespace ::comphelper;
52 :
53 :
54 :
55 : // class OAccessibleMenuItemComponent
56 :
57 :
58 2545 : OAccessibleMenuItemComponent::OAccessibleMenuItemComponent( Menu* pParent, sal_uInt16 nItemPos, Menu* pMenu )
59 : :OAccessibleMenuBaseComponent( pMenu )
60 : ,m_pParent( pParent )
61 2545 : ,m_nItemPos( nItemPos )
62 : {
63 2545 : m_sAccessibleName = GetAccessibleName();
64 2545 : m_sItemText = GetItemText();
65 2545 : }
66 :
67 :
68 :
69 2545 : OAccessibleMenuItemComponent::~OAccessibleMenuItemComponent()
70 : {
71 2545 : }
72 :
73 :
74 :
75 5445 : bool OAccessibleMenuItemComponent::IsEnabled()
76 : {
77 5445 : OExternalLockGuard aGuard( this );
78 :
79 5445 : bool bEnabled = false;
80 5445 : if ( m_pParent )
81 5445 : bEnabled = m_pParent->IsItemEnabled( m_pParent->GetItemId( m_nItemPos ) );
82 :
83 5445 : return bEnabled;
84 : }
85 :
86 :
87 :
88 5655 : bool OAccessibleMenuItemComponent::IsVisible()
89 : {
90 5655 : bool bVisible = false;
91 :
92 5655 : if ( m_pParent )
93 5655 : bVisible = m_pParent->IsItemPosVisible( m_nItemPos );
94 :
95 5655 : return bVisible;
96 : }
97 :
98 :
99 :
100 0 : void OAccessibleMenuItemComponent::Select()
101 : {
102 : // open the parent menu
103 0 : Reference< XAccessible > xParent( getAccessibleParent() );
104 0 : if ( xParent.is() )
105 : {
106 0 : OAccessibleMenuBaseComponent* pComp = static_cast< OAccessibleMenuBaseComponent* >( xParent.get() );
107 0 : if ( pComp && pComp->getAccessibleRole() == AccessibleRole::MENU && !pComp->IsPopupMenuOpen() )
108 0 : pComp->Click();
109 : }
110 :
111 : // highlight the menu item
112 0 : if ( m_pParent )
113 0 : m_pParent->HighlightItem( m_nItemPos );
114 0 : }
115 :
116 :
117 :
118 0 : void OAccessibleMenuItemComponent::DeSelect()
119 : {
120 0 : if ( m_pParent && IsSelected() )
121 0 : m_pParent->DeHighlight();
122 0 : }
123 :
124 :
125 :
126 8 : void OAccessibleMenuItemComponent::Click()
127 : {
128 : // open the parent menu
129 8 : Reference< XAccessible > xParent( getAccessibleParent() );
130 8 : if ( xParent.is() )
131 : {
132 8 : OAccessibleMenuBaseComponent* pComp = static_cast< OAccessibleMenuBaseComponent* >( xParent.get() );
133 8 : if ( pComp && pComp->getAccessibleRole() == AccessibleRole::MENU && !pComp->IsPopupMenuOpen() )
134 0 : pComp->Click();
135 : }
136 :
137 : // click the menu item
138 8 : if ( m_pParent )
139 : {
140 8 : vcl::Window* pWindow = m_pParent->GetWindow();
141 8 : if ( pWindow )
142 : {
143 : // #102438# Menu items are not selectable
144 : // Popup menus are executed asynchronously, triggered by a timer.
145 : // As Menu::SelectItem only works, if the corresponding menu window is
146 : // already created, we have to set the menu delay to 0, so
147 : // that the popup menus are executed synchronously.
148 8 : AllSettings aSettings = pWindow->GetSettings();
149 16 : MouseSettings aMouseSettings = aSettings.GetMouseSettings();
150 8 : sal_uLong nDelay = aMouseSettings.GetMenuDelay();
151 8 : aMouseSettings.SetMenuDelay( 0 );
152 8 : aSettings.SetMouseSettings( aMouseSettings );
153 8 : pWindow->SetSettings( aSettings );
154 :
155 8 : m_pParent->SelectItem( m_pParent->GetItemId( m_nItemPos ) );
156 :
157 : // meanwhile the window pointer may be invalid
158 8 : pWindow = m_pParent->GetWindow();
159 8 : if ( pWindow )
160 : {
161 : // set the menu delay back to the old value
162 8 : aSettings = pWindow->GetSettings();
163 8 : aMouseSettings = aSettings.GetMouseSettings();
164 8 : aMouseSettings.SetMenuDelay( nDelay );
165 8 : aSettings.SetMouseSettings( aMouseSettings );
166 8 : pWindow->SetSettings( aSettings );
167 8 : }
168 : }
169 8 : }
170 8 : }
171 :
172 :
173 :
174 1384 : void OAccessibleMenuItemComponent::SetItemPos( sal_uInt16 nItemPos )
175 : {
176 1384 : m_nItemPos = nItemPos;
177 1384 : }
178 :
179 :
180 :
181 0 : void OAccessibleMenuItemComponent::SetAccessibleName( const OUString& sAccessibleName )
182 : {
183 0 : if ( !m_sAccessibleName.equals( sAccessibleName ) )
184 : {
185 0 : Any aOldValue, aNewValue;
186 0 : aOldValue <<= m_sAccessibleName;
187 0 : aNewValue <<= sAccessibleName;
188 0 : m_sAccessibleName = sAccessibleName;
189 0 : NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
190 : }
191 0 : }
192 :
193 :
194 :
195 2545 : OUString OAccessibleMenuItemComponent::GetAccessibleName()
196 : {
197 2545 : OUString sName;
198 2545 : if ( m_pParent )
199 : {
200 2545 : sal_uInt16 nItemId = m_pParent->GetItemId( m_nItemPos );
201 2545 : sName = m_pParent->GetAccessibleName( nItemId );
202 2545 : if ( sName.isEmpty() )
203 2545 : sName = m_pParent->GetItemText( nItemId );
204 2545 : sName = OutputDevice::GetNonMnemonicString( sName );
205 : #if defined WNT
206 : if ( m_pParent->GetAccelKey( nItemId ).GetName().getLength() )
207 : sName = sName + "\t" + m_pParent->GetAccelKey(nItemId).GetName();
208 : #endif
209 : }
210 :
211 2545 : return sName;
212 : }
213 :
214 :
215 :
216 0 : void OAccessibleMenuItemComponent::SetItemText( const OUString& sItemText )
217 : {
218 0 : Any aOldValue, aNewValue;
219 0 : if ( OCommonAccessibleText::implInitTextChangedEvent( m_sItemText, sItemText, aOldValue, aNewValue ) )
220 : {
221 0 : m_sItemText = sItemText;
222 0 : NotifyAccessibleEvent( AccessibleEventId::TEXT_CHANGED, aOldValue, aNewValue );
223 0 : }
224 0 : }
225 :
226 :
227 :
228 2545 : OUString OAccessibleMenuItemComponent::GetItemText()
229 : {
230 2545 : OUString sText;
231 2545 : if ( m_pParent )
232 2545 : sText = OutputDevice::GetNonMnemonicString( m_pParent->GetItemText( m_pParent->GetItemId( m_nItemPos ) ) );
233 :
234 2545 : return sText;
235 : }
236 :
237 :
238 :
239 2900 : void OAccessibleMenuItemComponent::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
240 : {
241 2900 : bool bEnabled = IsEnabled();
242 2900 : if ( bEnabled )
243 : {
244 2847 : rStateSet.AddState( AccessibleStateType::ENABLED );
245 2847 : rStateSet.AddState( AccessibleStateType::SENSITIVE );
246 : }
247 :
248 2900 : if ( IsVisible() )
249 : {
250 89 : rStateSet.AddState( AccessibleStateType::SHOWING );
251 89 : if( !IsMenuHideDisabledEntries() || bEnabled )
252 89 : rStateSet.AddState( AccessibleStateType::VISIBLE );
253 : }
254 2900 : rStateSet.AddState( AccessibleStateType::OPAQUE );
255 2900 : }
256 :
257 :
258 : // OCommonAccessibleComponent
259 :
260 :
261 2616 : awt::Rectangle OAccessibleMenuItemComponent::implGetBounds() throw (RuntimeException)
262 : {
263 2616 : awt::Rectangle aBounds( 0, 0, 0, 0 );
264 :
265 2616 : if ( m_pParent )
266 : {
267 : // get bounding rectangle of the item relative to the containing window
268 2616 : aBounds = AWTRectangle( m_pParent->GetBoundingRectangle( m_nItemPos ) );
269 :
270 : // get position of containing window in screen coordinates
271 2616 : vcl::Window* pWindow = m_pParent->GetWindow();
272 2616 : if ( pWindow )
273 : {
274 2616 : Rectangle aRect = pWindow->GetWindowExtentsRelative( NULL );
275 2616 : awt::Point aWindowScreenLoc = AWTPoint( aRect.TopLeft() );
276 :
277 : // get position of accessible parent in screen coordinates
278 2616 : Reference< XAccessible > xParent = getAccessibleParent();
279 2616 : if ( xParent.is() )
280 : {
281 2616 : Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), UNO_QUERY );
282 2616 : if ( xParentComponent.is() )
283 : {
284 2616 : awt::Point aParentScreenLoc = xParentComponent->getLocationOnScreen();
285 :
286 : // calculate bounding rectangle of the item relative to the accessible parent
287 2616 : aBounds.X += aWindowScreenLoc.X - aParentScreenLoc.X;
288 2616 : aBounds.Y += aWindowScreenLoc.Y - aParentScreenLoc.Y;
289 2616 : }
290 2616 : }
291 : }
292 : }
293 :
294 2616 : return aBounds;
295 : }
296 :
297 :
298 : // XComponent
299 :
300 :
301 2545 : void SAL_CALL OAccessibleMenuItemComponent::disposing()
302 : {
303 2545 : OAccessibleMenuBaseComponent::disposing();
304 :
305 2545 : m_pParent = NULL;
306 2545 : m_sAccessibleName.clear();
307 2545 : m_sItemText.clear();
308 2545 : }
309 :
310 :
311 : // XAccessibleContext
312 :
313 :
314 5067 : sal_Int32 OAccessibleMenuItemComponent::getAccessibleChildCount() throw (RuntimeException, std::exception)
315 : {
316 5067 : OExternalLockGuard aGuard( this );
317 :
318 5067 : return 0;
319 : }
320 :
321 :
322 :
323 0 : Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
324 : {
325 0 : OExternalLockGuard aGuard( this );
326 :
327 0 : if ( i < 0 || i >= getAccessibleChildCount() )
328 0 : throw IndexOutOfBoundsException();
329 :
330 0 : return Reference< XAccessible >();
331 : }
332 :
333 :
334 :
335 4091 : Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleParent( ) throw (RuntimeException, std::exception)
336 : {
337 4091 : OExternalLockGuard aGuard( this );
338 :
339 4091 : return m_pParent->GetAccessible();
340 : }
341 :
342 :
343 :
344 67 : sal_Int32 OAccessibleMenuItemComponent::getAccessibleIndexInParent( ) throw (RuntimeException, std::exception)
345 : {
346 67 : OExternalLockGuard aGuard( this );
347 :
348 67 : return m_nItemPos;
349 : }
350 :
351 :
352 :
353 0 : sal_Int16 OAccessibleMenuItemComponent::getAccessibleRole( ) throw (RuntimeException, std::exception)
354 : {
355 0 : OExternalLockGuard aGuard( this );
356 :
357 0 : return AccessibleRole::UNKNOWN;
358 : }
359 :
360 :
361 :
362 269 : OUString OAccessibleMenuItemComponent::getAccessibleDescription( ) throw (RuntimeException, std::exception)
363 : {
364 269 : OExternalLockGuard aGuard( this );
365 :
366 269 : OUString sDescription;
367 269 : if ( m_pParent )
368 269 : sDescription = m_pParent->GetHelpText( m_pParent->GetItemId( m_nItemPos ) );
369 :
370 269 : return sDescription;
371 : }
372 :
373 :
374 :
375 269 : OUString OAccessibleMenuItemComponent::getAccessibleName( ) throw (RuntimeException, std::exception)
376 : {
377 269 : OExternalLockGuard aGuard( this );
378 :
379 269 : return m_sAccessibleName;
380 : }
381 :
382 :
383 :
384 2 : Reference< XAccessibleRelationSet > OAccessibleMenuItemComponent::getAccessibleRelationSet( ) throw (RuntimeException, std::exception)
385 : {
386 2 : OExternalLockGuard aGuard( this );
387 :
388 2 : utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
389 2 : Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
390 2 : return xSet;
391 : }
392 :
393 :
394 :
395 2 : Locale OAccessibleMenuItemComponent::getLocale( ) throw (IllegalAccessibleComponentStateException, RuntimeException, std::exception)
396 : {
397 2 : OExternalLockGuard aGuard( this );
398 :
399 2 : return Application::GetSettings().GetLanguageTag().getLocale();
400 : }
401 :
402 :
403 : // XAccessibleComponent
404 :
405 :
406 0 : Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleAtPoint( const awt::Point& ) throw (RuntimeException, std::exception)
407 : {
408 0 : OExternalLockGuard aGuard( this );
409 :
410 0 : return Reference< XAccessible >();
411 : }
412 :
413 :
414 :
415 1 : void OAccessibleMenuItemComponent::grabFocus( ) throw (RuntimeException, std::exception)
416 : {
417 : // no focus for items
418 1 : }
419 :
420 :
421 :
422 1 : sal_Int32 OAccessibleMenuItemComponent::getForeground( ) throw (RuntimeException, std::exception)
423 : {
424 1 : OExternalLockGuard aGuard( this );
425 :
426 1 : sal_Int32 nColor = 0;
427 2 : Reference< XAccessible > xParent = getAccessibleParent();
428 1 : if ( xParent.is() )
429 : {
430 1 : Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
431 1 : if ( xParentComp.is() )
432 1 : nColor = xParentComp->getForeground();
433 : }
434 :
435 2 : return nColor;
436 : }
437 :
438 :
439 :
440 1 : sal_Int32 OAccessibleMenuItemComponent::getBackground( ) throw (RuntimeException, std::exception)
441 : {
442 1 : OExternalLockGuard aGuard( this );
443 :
444 1 : sal_Int32 nColor = 0;
445 2 : Reference< XAccessible > xParent = getAccessibleParent();
446 1 : if ( xParent.is() )
447 : {
448 1 : Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
449 1 : if ( xParentComp.is() )
450 1 : nColor = xParentComp->getBackground();
451 : }
452 :
453 2 : return nColor;
454 : }
455 :
456 :
457 : // XAccessibleExtendedComponent
458 :
459 :
460 3 : Reference< awt::XFont > OAccessibleMenuItemComponent::getFont( ) throw (RuntimeException, std::exception)
461 : {
462 3 : OExternalLockGuard aGuard( this );
463 :
464 3 : Reference< awt::XFont > xFont;
465 6 : Reference< XAccessible > xParent = getAccessibleParent();
466 3 : if ( xParent.is() )
467 : {
468 3 : Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
469 3 : if ( xParentComp.is() )
470 3 : xFont = xParentComp->getFont();
471 : }
472 :
473 6 : return xFont;
474 : }
475 :
476 :
477 :
478 2 : OUString OAccessibleMenuItemComponent::getTitledBorderText( ) throw (RuntimeException, std::exception)
479 : {
480 2 : OExternalLockGuard aGuard( this );
481 :
482 2 : return OUString();
483 : }
484 :
485 :
486 :
487 2 : OUString OAccessibleMenuItemComponent::getToolTipText( ) throw (RuntimeException, std::exception)
488 : {
489 2 : OExternalLockGuard aGuard( this );
490 :
491 2 : OUString sRet;
492 2 : if ( m_pParent )
493 2 : sRet = m_pParent->GetTipHelpText( m_pParent->GetItemId( m_nItemPos ) );
494 :
495 2 : return sRet;
496 : }
497 :
498 :
499 :
500 89 : bool OAccessibleMenuItemComponent::IsMenuHideDisabledEntries()
501 : {
502 89 : if (m_pParent )
503 : {
504 89 : if( m_pParent->GetMenuFlags() & MenuFlags::HideDisabledEntries)
505 : {
506 0 : return true;
507 : }
508 : }
509 89 : return false;
510 : }
511 :
512 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
