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 0 : OAccessibleMenuItemComponent::OAccessibleMenuItemComponent( Menu* pParent, sal_uInt16 nItemPos, Menu* pMenu )
59 : :OAccessibleMenuBaseComponent( pMenu )
60 : ,m_pParent( pParent )
61 0 : ,m_nItemPos( nItemPos )
62 : {
63 0 : m_sAccessibleName = GetAccessibleName();
64 0 : m_sItemText = GetItemText();
65 0 : }
66 :
67 :
68 :
69 0 : OAccessibleMenuItemComponent::~OAccessibleMenuItemComponent()
70 : {
71 0 : }
72 :
73 :
74 :
75 0 : sal_Bool OAccessibleMenuItemComponent::IsEnabled()
76 : {
77 0 : OExternalLockGuard aGuard( this );
78 :
79 0 : sal_Bool bEnabled = sal_False;
80 0 : if ( m_pParent )
81 0 : bEnabled = m_pParent->IsItemEnabled( m_pParent->GetItemId( m_nItemPos ) );
82 :
83 0 : return bEnabled;
84 : }
85 :
86 :
87 :
88 0 : sal_Bool OAccessibleMenuItemComponent::IsVisible()
89 : {
90 0 : sal_Bool bVisible = sal_False;
91 :
92 0 : if ( m_pParent )
93 0 : bVisible = m_pParent->IsItemPosVisible( m_nItemPos );
94 :
95 0 : 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 0 : void OAccessibleMenuItemComponent::Click()
127 : {
128 : // open the parent menu
129 0 : Reference< XAccessible > xParent( getAccessibleParent() );
130 0 : if ( xParent.is() )
131 : {
132 0 : OAccessibleMenuBaseComponent* pComp = static_cast< OAccessibleMenuBaseComponent* >( xParent.get() );
133 0 : if ( pComp && pComp->getAccessibleRole() == AccessibleRole::MENU && !pComp->IsPopupMenuOpen() )
134 0 : pComp->Click();
135 : }
136 :
137 : // click the menu item
138 0 : if ( m_pParent )
139 : {
140 0 : Window* pWindow = m_pParent->GetWindow();
141 0 : 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 0 : AllSettings aSettings = pWindow->GetSettings();
149 0 : MouseSettings aMouseSettings = aSettings.GetMouseSettings();
150 0 : sal_uLong nDelay = aMouseSettings.GetMenuDelay();
151 0 : aMouseSettings.SetMenuDelay( 0 );
152 0 : aSettings.SetMouseSettings( aMouseSettings );
153 0 : pWindow->SetSettings( aSettings );
154 :
155 0 : m_pParent->SelectItem( m_pParent->GetItemId( m_nItemPos ) );
156 :
157 : // meanwhile the window pointer may be invalid
158 0 : pWindow = m_pParent->GetWindow();
159 0 : if ( pWindow )
160 : {
161 : // set the menu delay back to the old value
162 0 : aSettings = pWindow->GetSettings();
163 0 : aMouseSettings = aSettings.GetMouseSettings();
164 0 : aMouseSettings.SetMenuDelay( nDelay );
165 0 : aSettings.SetMouseSettings( aMouseSettings );
166 0 : pWindow->SetSettings( aSettings );
167 0 : }
168 : }
169 0 : }
170 0 : }
171 :
172 :
173 :
174 0 : void OAccessibleMenuItemComponent::SetItemPos( sal_uInt16 nItemPos )
175 : {
176 0 : m_nItemPos = nItemPos;
177 0 : }
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 0 : OUString OAccessibleMenuItemComponent::GetAccessibleName()
196 : {
197 0 : OUString sName;
198 0 : if ( m_pParent )
199 : {
200 0 : sal_uInt16 nItemId = m_pParent->GetItemId( m_nItemPos );
201 0 : sName = m_pParent->GetAccessibleName( nItemId );
202 0 : if ( sName.isEmpty() )
203 0 : sName = m_pParent->GetItemText( nItemId );
204 0 : sName = OutputDevice::GetNonMnemonicString( sName );
205 : }
206 :
207 0 : return sName;
208 : }
209 :
210 :
211 :
212 0 : void OAccessibleMenuItemComponent::SetItemText( const OUString& sItemText )
213 : {
214 0 : Any aOldValue, aNewValue;
215 0 : if ( OCommonAccessibleText::implInitTextChangedEvent( m_sItemText, sItemText, aOldValue, aNewValue ) )
216 : {
217 0 : m_sItemText = sItemText;
218 0 : NotifyAccessibleEvent( AccessibleEventId::TEXT_CHANGED, aOldValue, aNewValue );
219 0 : }
220 0 : }
221 :
222 :
223 :
224 0 : OUString OAccessibleMenuItemComponent::GetItemText()
225 : {
226 0 : OUString sText;
227 0 : if ( m_pParent )
228 0 : sText = OutputDevice::GetNonMnemonicString( m_pParent->GetItemText( m_pParent->GetItemId( m_nItemPos ) ) );
229 :
230 0 : return sText;
231 : }
232 :
233 :
234 :
235 0 : void OAccessibleMenuItemComponent::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
236 : {
237 0 : sal_Bool bEnabled = IsEnabled();
238 0 : if ( bEnabled )
239 : {
240 0 : rStateSet.AddState( AccessibleStateType::ENABLED );
241 0 : rStateSet.AddState( AccessibleStateType::SENSITIVE );
242 : }
243 :
244 0 : if ( IsVisible() )
245 : {
246 0 : rStateSet.AddState( AccessibleStateType::SHOWING );
247 0 : if( !IsMenuHideDisabledEntries() || bEnabled )
248 0 : rStateSet.AddState( AccessibleStateType::VISIBLE );
249 : }
250 0 : rStateSet.AddState( AccessibleStateType::OPAQUE );
251 0 : }
252 :
253 :
254 : // OCommonAccessibleComponent
255 :
256 :
257 0 : awt::Rectangle OAccessibleMenuItemComponent::implGetBounds() throw (RuntimeException)
258 : {
259 0 : awt::Rectangle aBounds( 0, 0, 0, 0 );
260 :
261 0 : if ( m_pParent )
262 : {
263 : // get bounding rectangle of the item relative to the containing window
264 0 : aBounds = AWTRectangle( m_pParent->GetBoundingRectangle( m_nItemPos ) );
265 :
266 : // get position of containing window in screen coordinates
267 0 : Window* pWindow = m_pParent->GetWindow();
268 0 : if ( pWindow )
269 : {
270 0 : Rectangle aRect = pWindow->GetWindowExtentsRelative( NULL );
271 0 : awt::Point aWindowScreenLoc = AWTPoint( aRect.TopLeft() );
272 :
273 : // get position of accessible parent in screen coordinates
274 0 : Reference< XAccessible > xParent = getAccessibleParent();
275 0 : if ( xParent.is() )
276 : {
277 0 : Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), UNO_QUERY );
278 0 : if ( xParentComponent.is() )
279 : {
280 0 : awt::Point aParentScreenLoc = xParentComponent->getLocationOnScreen();
281 :
282 : // calculate bounding rectangle of the item relative to the accessible parent
283 0 : aBounds.X += aWindowScreenLoc.X - aParentScreenLoc.X;
284 0 : aBounds.Y += aWindowScreenLoc.Y - aParentScreenLoc.Y;
285 0 : }
286 0 : }
287 : }
288 : }
289 :
290 0 : return aBounds;
291 : }
292 :
293 :
294 : // XComponent
295 :
296 :
297 0 : void SAL_CALL OAccessibleMenuItemComponent::disposing()
298 : {
299 0 : OAccessibleMenuBaseComponent::disposing();
300 :
301 0 : m_pParent = NULL;
302 0 : m_sAccessibleName = OUString();
303 0 : m_sItemText = OUString();
304 0 : }
305 :
306 :
307 : // XAccessibleContext
308 :
309 :
310 0 : sal_Int32 OAccessibleMenuItemComponent::getAccessibleChildCount() throw (RuntimeException, std::exception)
311 : {
312 0 : OExternalLockGuard aGuard( this );
313 :
314 0 : return 0;
315 : }
316 :
317 :
318 :
319 0 : Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
320 : {
321 0 : OExternalLockGuard aGuard( this );
322 :
323 0 : if ( i < 0 || i >= getAccessibleChildCount() )
324 0 : throw IndexOutOfBoundsException();
325 :
326 0 : return Reference< XAccessible >();
327 : }
328 :
329 :
330 :
331 0 : Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleParent( ) throw (RuntimeException, std::exception)
332 : {
333 0 : OExternalLockGuard aGuard( this );
334 :
335 0 : return m_pParent->GetAccessible();
336 : }
337 :
338 :
339 :
340 0 : sal_Int32 OAccessibleMenuItemComponent::getAccessibleIndexInParent( ) throw (RuntimeException, std::exception)
341 : {
342 0 : OExternalLockGuard aGuard( this );
343 :
344 0 : return m_nItemPos;
345 : }
346 :
347 :
348 :
349 0 : sal_Int16 OAccessibleMenuItemComponent::getAccessibleRole( ) throw (RuntimeException, std::exception)
350 : {
351 0 : OExternalLockGuard aGuard( this );
352 :
353 0 : return AccessibleRole::UNKNOWN;
354 : }
355 :
356 :
357 :
358 0 : OUString OAccessibleMenuItemComponent::getAccessibleDescription( ) throw (RuntimeException, std::exception)
359 : {
360 0 : OExternalLockGuard aGuard( this );
361 :
362 0 : OUString sDescription;
363 0 : if ( m_pParent )
364 0 : sDescription = m_pParent->GetHelpText( m_pParent->GetItemId( m_nItemPos ) );
365 :
366 0 : return sDescription;
367 : }
368 :
369 :
370 :
371 0 : OUString OAccessibleMenuItemComponent::getAccessibleName( ) throw (RuntimeException, std::exception)
372 : {
373 0 : OExternalLockGuard aGuard( this );
374 :
375 0 : return m_sAccessibleName;
376 : }
377 :
378 :
379 :
380 0 : Reference< XAccessibleRelationSet > OAccessibleMenuItemComponent::getAccessibleRelationSet( ) throw (RuntimeException, std::exception)
381 : {
382 0 : OExternalLockGuard aGuard( this );
383 :
384 0 : utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
385 0 : Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
386 0 : return xSet;
387 : }
388 :
389 :
390 :
391 0 : Locale OAccessibleMenuItemComponent::getLocale( ) throw (IllegalAccessibleComponentStateException, RuntimeException, std::exception)
392 : {
393 0 : OExternalLockGuard aGuard( this );
394 :
395 0 : return Application::GetSettings().GetLanguageTag().getLocale();
396 : }
397 :
398 :
399 : // XAccessibleComponent
400 :
401 :
402 0 : Reference< XAccessible > OAccessibleMenuItemComponent::getAccessibleAtPoint( const awt::Point& ) throw (RuntimeException, std::exception)
403 : {
404 0 : OExternalLockGuard aGuard( this );
405 :
406 0 : return Reference< XAccessible >();
407 : }
408 :
409 :
410 :
411 0 : void OAccessibleMenuItemComponent::grabFocus( ) throw (RuntimeException, std::exception)
412 : {
413 : // no focus for items
414 0 : }
415 :
416 :
417 :
418 0 : sal_Int32 OAccessibleMenuItemComponent::getForeground( ) throw (RuntimeException, std::exception)
419 : {
420 0 : OExternalLockGuard aGuard( this );
421 :
422 0 : sal_Int32 nColor = 0;
423 0 : Reference< XAccessible > xParent = getAccessibleParent();
424 0 : if ( xParent.is() )
425 : {
426 0 : Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
427 0 : if ( xParentComp.is() )
428 0 : nColor = xParentComp->getForeground();
429 : }
430 :
431 0 : return nColor;
432 : }
433 :
434 :
435 :
436 0 : sal_Int32 OAccessibleMenuItemComponent::getBackground( ) throw (RuntimeException, std::exception)
437 : {
438 0 : OExternalLockGuard aGuard( this );
439 :
440 0 : sal_Int32 nColor = 0;
441 0 : Reference< XAccessible > xParent = getAccessibleParent();
442 0 : if ( xParent.is() )
443 : {
444 0 : Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
445 0 : if ( xParentComp.is() )
446 0 : nColor = xParentComp->getBackground();
447 : }
448 :
449 0 : return nColor;
450 : }
451 :
452 :
453 : // XAccessibleExtendedComponent
454 :
455 :
456 0 : Reference< awt::XFont > OAccessibleMenuItemComponent::getFont( ) throw (RuntimeException, std::exception)
457 : {
458 0 : OExternalLockGuard aGuard( this );
459 :
460 0 : Reference< awt::XFont > xFont;
461 0 : Reference< XAccessible > xParent = getAccessibleParent();
462 0 : if ( xParent.is() )
463 : {
464 0 : Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
465 0 : if ( xParentComp.is() )
466 0 : xFont = xParentComp->getFont();
467 : }
468 :
469 0 : return xFont;
470 : }
471 :
472 :
473 :
474 0 : OUString OAccessibleMenuItemComponent::getTitledBorderText( ) throw (RuntimeException, std::exception)
475 : {
476 0 : OExternalLockGuard aGuard( this );
477 :
478 0 : return OUString();
479 : }
480 :
481 :
482 :
483 0 : OUString OAccessibleMenuItemComponent::getToolTipText( ) throw (RuntimeException, std::exception)
484 : {
485 0 : OExternalLockGuard aGuard( this );
486 :
487 0 : OUString sRet;
488 0 : if ( m_pParent )
489 0 : sRet = m_pParent->GetTipHelpText( m_pParent->GetItemId( m_nItemPos ) );
490 :
491 0 : return sRet;
492 : }
493 :
494 :
495 :
496 0 : sal_Bool OAccessibleMenuItemComponent::IsMenuHideDisabledEntries()
497 : {
498 0 : if (m_pParent )
499 : {
500 0 : if( m_pParent->GetMenuFlags() & MENU_FLAG_HIDEDISABLEDENTRIES)
501 : {
502 0 : return sal_True;
503 : }
504 : }
505 0 : return sal_False;
506 : }
507 :
508 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
