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 <sal/config.h>
21 :
22 : #include <memory>
23 : #include <utility>
24 :
25 : #include "AccessibleEditObject.hxx"
26 : #include "scitems.hxx"
27 : #include <editeng/eeitem.hxx>
28 : #include "AccessibleText.hxx"
29 : #include "editsrc.hxx"
30 : #include "scmod.hxx"
31 : #include "inputhdl.hxx"
32 :
33 : #include <unotools/accessiblestatesethelper.hxx>
34 : #include <com/sun/star/accessibility/AccessibleRole.hpp>
35 : #include <com/sun/star/accessibility/AccessibleStateType.hpp>
36 : #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
37 : #include <com/sun/star/sheet/XSpreadsheet.hpp>
38 : #include <comphelper/servicehelper.hxx>
39 : #include <svx/AccessibleTextHelper.hxx>
40 : #include <editeng/editview.hxx>
41 : #include <editeng/editeng.hxx>
42 : #include <svx/svdmodel.hxx>
43 : #include <vcl/svapp.hxx>
44 : #include <sfx2/objsh.hxx>
45 :
46 : #include "unonames.hxx"
47 : #include "document.hxx"
48 : #include "AccessibleDocument.hxx"
49 : #include <com/sun/star/accessibility/AccessibleRelationType.hpp>
50 : #include <unotools/accessiblerelationsethelper.hxx>
51 : #include <com/sun/star/accessibility/XAccessibleText.hpp>
52 :
53 : using ::com::sun::star::lang::IndexOutOfBoundsException;
54 : using ::com::sun::star::uno::RuntimeException;
55 : using namespace ::com::sun::star;
56 : using namespace ::com::sun::star::accessibility;
57 :
58 : //===== internal ============================================================
59 :
60 0 : ScAccessibleEditObject::ScAccessibleEditObject(
61 : const uno::Reference<XAccessible>& rxParent,
62 : EditView* pEditView, vcl::Window* pWin, const OUString& rName,
63 : const OUString& rDescription, EditObjectType eObjectType)
64 : :
65 : ScAccessibleContextBase(rxParent, AccessibleRole::TEXT_FRAME),
66 : mpTextHelper(NULL),
67 : mpEditView(pEditView),
68 : mpWindow(pWin),
69 : meObjectType(eObjectType),
70 0 : mbHasFocus(false)
71 : {
72 0 : CreateTextHelper();
73 0 : SetName(rName);
74 0 : SetDescription(rDescription);
75 0 : if( meObjectType == CellInEditMode)
76 : {
77 0 : const ScAccessibleDocument *pAccDoc = const_cast<ScAccessibleDocument*>(static_cast<ScAccessibleDocument*>(rxParent.get())) ;
78 0 : if (pAccDoc)
79 : {
80 0 : m_pScDoc = pAccDoc->GetDocument();
81 0 : m_curCellAddress =pAccDoc->GetCurCellAddress();
82 : }
83 : else
84 : {
85 0 : m_pScDoc=NULL;
86 : }
87 : }
88 : else
89 0 : m_pScDoc=NULL;
90 0 : }
91 :
92 0 : ScAccessibleEditObject::~ScAccessibleEditObject()
93 : {
94 0 : if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
95 : {
96 : // increment refcount to prevent double call off dtor
97 0 : osl_atomic_increment( &m_refCount );
98 : // call dispose to inform object which have a weak reference to this object
99 0 : dispose();
100 : }
101 0 : }
102 :
103 0 : void SAL_CALL ScAccessibleEditObject::disposing()
104 : {
105 0 : SolarMutexGuard aGuard;
106 0 : if (mpTextHelper)
107 0 : DELETEZ(mpTextHelper);
108 :
109 0 : ScAccessibleContextBase::disposing();
110 0 : }
111 :
112 0 : void ScAccessibleEditObject::LostFocus()
113 : {
114 0 : mbHasFocus = false;
115 0 : if (mpTextHelper)
116 0 : mpTextHelper->SetFocus(false);
117 0 : CommitFocusLost();
118 0 : }
119 :
120 0 : void ScAccessibleEditObject::GotFocus()
121 : {
122 0 : mbHasFocus = true;
123 0 : CommitFocusGained();
124 0 : if (mpTextHelper)
125 0 : mpTextHelper->SetFocus(true);
126 0 : }
127 :
128 : //===== XInterface ==========================================================
129 :
130 : com::sun::star::uno::Any SAL_CALL
131 0 : ScAccessibleEditObject::queryInterface (const com::sun::star::uno::Type & rType)
132 : throw (::com::sun::star::uno::RuntimeException, std::exception)
133 : {
134 0 : ::com::sun::star::uno::Any aReturn = ScAccessibleContextBase::queryInterface (rType);
135 0 : if ( ! aReturn.hasValue())
136 0 : aReturn = ::cppu::queryInterface (rType,
137 : static_cast< ::com::sun::star::accessibility::XAccessibleSelection* >(this)
138 0 : );
139 0 : return aReturn;
140 : }
141 : void SAL_CALL
142 0 : ScAccessibleEditObject::acquire (void)
143 : throw ()
144 : {
145 0 : ScAccessibleContextBase::acquire ();
146 0 : }
147 : void SAL_CALL
148 0 : ScAccessibleEditObject::release (void)
149 : throw ()
150 : {
151 0 : ScAccessibleContextBase::release ();
152 0 : }
153 : //===== XAccessibleComponent ============================================
154 :
155 0 : uno::Reference< XAccessible > SAL_CALL ScAccessibleEditObject::getAccessibleAtPoint(
156 : const awt::Point& rPoint )
157 : throw (uno::RuntimeException, std::exception)
158 : {
159 0 : uno::Reference<XAccessible> xRet;
160 0 : if (containsPoint(rPoint))
161 : {
162 0 : SolarMutexGuard aGuard;
163 0 : IsObjectValid();
164 :
165 0 : if(!mpTextHelper)
166 0 : CreateTextHelper();
167 :
168 0 : xRet = mpTextHelper->GetAt(rPoint);
169 : }
170 :
171 0 : return xRet;
172 : }
173 :
174 0 : Rectangle ScAccessibleEditObject::GetBoundingBoxOnScreen(void) const
175 : throw (uno::RuntimeException, std::exception)
176 : {
177 0 : Rectangle aScreenBounds;
178 :
179 0 : if ( mpWindow )
180 : {
181 0 : if ( meObjectType == CellInEditMode )
182 : {
183 0 : if ( mpEditView && mpEditView->GetEditEngine() )
184 : {
185 0 : MapMode aMapMode( mpEditView->GetEditEngine()->GetRefMapMode() );
186 0 : aScreenBounds = mpWindow->LogicToPixel( mpEditView->GetOutputArea(), aMapMode );
187 0 : Point aCellLoc = aScreenBounds.TopLeft();
188 0 : Rectangle aWindowRect = mpWindow->GetWindowExtentsRelative( NULL );
189 0 : Point aWindowLoc = aWindowRect.TopLeft();
190 0 : Point aPos( aCellLoc.getX() + aWindowLoc.getX(), aCellLoc.getY() + aWindowLoc.getY() );
191 0 : aScreenBounds.SetPos( aPos );
192 : }
193 : }
194 : else
195 : {
196 0 : aScreenBounds = mpWindow->GetWindowExtentsRelative( NULL );
197 : }
198 : }
199 :
200 0 : return aScreenBounds;
201 : }
202 :
203 0 : Rectangle ScAccessibleEditObject::GetBoundingBox(void) const
204 : throw (uno::RuntimeException, std::exception)
205 : {
206 0 : Rectangle aBounds( GetBoundingBoxOnScreen() );
207 :
208 0 : if ( mpWindow )
209 : {
210 0 : uno::Reference< XAccessible > xThis( mpWindow->GetAccessible() );
211 0 : if ( xThis.is() )
212 : {
213 0 : uno::Reference< XAccessibleContext > xContext( xThis->getAccessibleContext() );
214 0 : if ( xContext.is() )
215 : {
216 0 : uno::Reference< XAccessible > xParent( xContext->getAccessibleParent() );
217 0 : if ( xParent.is() )
218 : {
219 0 : uno::Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), uno::UNO_QUERY );
220 0 : if ( xParentComponent.is() )
221 : {
222 0 : Point aScreenLoc = aBounds.TopLeft();
223 0 : awt::Point aParentScreenLoc = xParentComponent->getLocationOnScreen();
224 0 : Point aPos( aScreenLoc.getX() - aParentScreenLoc.X, aScreenLoc.getY() - aParentScreenLoc.Y );
225 0 : aBounds.SetPos( aPos );
226 0 : }
227 0 : }
228 0 : }
229 0 : }
230 : }
231 :
232 0 : return aBounds;
233 : }
234 :
235 : //===== XAccessibleContext ==============================================
236 :
237 : sal_Int32 SAL_CALL
238 0 : ScAccessibleEditObject::getAccessibleChildCount(void)
239 : throw (uno::RuntimeException, std::exception)
240 : {
241 0 : SolarMutexGuard aGuard;
242 0 : IsObjectValid();
243 0 : if (!mpTextHelper)
244 0 : CreateTextHelper();
245 0 : return mpTextHelper->GetChildCount();
246 : }
247 :
248 : uno::Reference< XAccessible > SAL_CALL
249 0 : ScAccessibleEditObject::getAccessibleChild(sal_Int32 nIndex)
250 : throw (uno::RuntimeException,
251 : lang::IndexOutOfBoundsException, std::exception)
252 : {
253 0 : SolarMutexGuard aGuard;
254 0 : IsObjectValid();
255 0 : if (!mpTextHelper)
256 0 : CreateTextHelper();
257 0 : return mpTextHelper->GetChild(nIndex);
258 : }
259 :
260 : uno::Reference<XAccessibleStateSet> SAL_CALL
261 0 : ScAccessibleEditObject::getAccessibleStateSet(void)
262 : throw (uno::RuntimeException, std::exception)
263 : {
264 0 : SolarMutexGuard aGuard;
265 0 : uno::Reference<XAccessibleStateSet> xParentStates;
266 0 : if (getAccessibleParent().is())
267 : {
268 0 : uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
269 0 : xParentStates = xParentContext->getAccessibleStateSet();
270 : }
271 0 : utl::AccessibleStateSetHelper* pStateSet = new utl::AccessibleStateSetHelper();
272 0 : if (IsDefunc(xParentStates))
273 0 : pStateSet->AddState(AccessibleStateType::DEFUNC);
274 : else
275 : {
276 : // all states are const, because this object exists only in one state
277 0 : pStateSet->AddState(AccessibleStateType::EDITABLE);
278 0 : pStateSet->AddState(AccessibleStateType::ENABLED);
279 0 : pStateSet->AddState(AccessibleStateType::SENSITIVE);
280 0 : pStateSet->AddState(AccessibleStateType::MULTI_LINE);
281 0 : pStateSet->AddState(AccessibleStateType::MULTI_SELECTABLE);
282 0 : pStateSet->AddState(AccessibleStateType::SHOWING);
283 0 : pStateSet->AddState(AccessibleStateType::VISIBLE);
284 : }
285 0 : return pStateSet;
286 : }
287 :
288 : OUString SAL_CALL
289 0 : ScAccessibleEditObject::createAccessibleDescription(void)
290 : throw (uno::RuntimeException)
291 : {
292 : // OSL_FAIL("Should never be called, because is set in the constructor.")
293 0 : return OUString();
294 : }
295 :
296 : OUString SAL_CALL
297 0 : ScAccessibleEditObject::createAccessibleName(void)
298 : throw (uno::RuntimeException, std::exception)
299 : {
300 : OSL_FAIL("Should never be called, because is set in the constructor.");
301 0 : return OUString();
302 : }
303 :
304 : ///===== XAccessibleEventBroadcaster =====================================
305 :
306 : void SAL_CALL
307 0 : ScAccessibleEditObject::addAccessibleEventListener(const uno::Reference<XAccessibleEventListener>& xListener)
308 : throw (uno::RuntimeException, std::exception)
309 : {
310 0 : if (!mpTextHelper)
311 0 : CreateTextHelper();
312 :
313 0 : mpTextHelper->AddEventListener(xListener);
314 :
315 0 : ScAccessibleContextBase::addAccessibleEventListener(xListener);
316 0 : }
317 :
318 : void SAL_CALL
319 0 : ScAccessibleEditObject::removeAccessibleEventListener(const uno::Reference<XAccessibleEventListener>& xListener)
320 : throw (uno::RuntimeException, std::exception)
321 : {
322 0 : if (!mpTextHelper)
323 0 : CreateTextHelper();
324 :
325 0 : mpTextHelper->RemoveEventListener(xListener);
326 :
327 0 : ScAccessibleContextBase::removeAccessibleEventListener(xListener);
328 0 : }
329 :
330 : //===== XServiceInfo ====================================================
331 :
332 0 : OUString SAL_CALL ScAccessibleEditObject::getImplementationName(void)
333 : throw (uno::RuntimeException, std::exception)
334 : {
335 0 : return OUString("ScAccessibleEditObject");
336 : }
337 :
338 : //===== XTypeProvider =======================================================
339 :
340 : uno::Sequence<sal_Int8> SAL_CALL
341 0 : ScAccessibleEditObject::getImplementationId(void)
342 : throw (uno::RuntimeException, std::exception)
343 : {
344 0 : return css::uno::Sequence<sal_Int8>();
345 : }
346 :
347 : //==== internal =========================================================
348 :
349 0 : bool ScAccessibleEditObject::IsDefunc(
350 : const uno::Reference<XAccessibleStateSet>& rxParentStates)
351 : {
352 0 : return ScAccessibleContextBase::IsDefunc() || !getAccessibleParent().is() ||
353 0 : (rxParentStates.is() && rxParentStates->contains(AccessibleStateType::DEFUNC));
354 : }
355 :
356 0 : void ScAccessibleEditObject::CreateTextHelper()
357 : {
358 0 : if (!mpTextHelper)
359 : {
360 0 : ::std::unique_ptr < ScAccessibleTextData > pAccessibleTextData;
361 0 : if (meObjectType == CellInEditMode || meObjectType == EditControl)
362 : {
363 : pAccessibleTextData.reset
364 0 : (new ScAccessibleEditObjectTextData(mpEditView, mpWindow));
365 : }
366 : else
367 : {
368 : pAccessibleTextData.reset
369 0 : (new ScAccessibleEditLineTextData(NULL, mpWindow));
370 : }
371 :
372 0 : ::std::unique_ptr< SvxEditSource > pEditSource (new ScAccessibilityEditSource(std::move(pAccessibleTextData)));
373 0 : mpTextHelper = new ::accessibility::AccessibleTextHelper(std::move(pEditSource));
374 0 : mpTextHelper->SetEventSource(this);
375 0 : mpTextHelper->SetFocus(mbHasFocus);
376 :
377 : // #i54814# activate cell in edit mode
378 0 : if( meObjectType == CellInEditMode )
379 : {
380 : // do not activate cell object, if top edit line is active
381 0 : const ScInputHandler* pInputHdl = SC_MOD()->GetInputHdl();
382 0 : if( pInputHdl && !pInputHdl->IsTopMode() )
383 : {
384 0 : SdrHint aHint( HINT_BEGEDIT );
385 0 : mpTextHelper->GetEditSource().GetBroadcaster().Broadcast( aHint );
386 : }
387 0 : }
388 : }
389 0 : }
390 :
391 0 : sal_Int32 SAL_CALL ScAccessibleEditObject::getForeground( )
392 : throw (::com::sun::star::uno::RuntimeException, std::exception)
393 : {
394 0 : return GetFgBgColor(OUString(SC_UNONAME_CCOLOR));
395 : }
396 :
397 0 : sal_Int32 SAL_CALL ScAccessibleEditObject::getBackground( )
398 : throw (::com::sun::star::uno::RuntimeException, std::exception)
399 : {
400 0 : return GetFgBgColor(OUString(SC_UNONAME_CELLBACK));
401 : }
402 :
403 0 : sal_Int32 ScAccessibleEditObject::GetFgBgColor( const OUString &strPropColor)
404 : {
405 0 : SolarMutexGuard aGuard;
406 0 : sal_Int32 nColor(0);
407 0 : if (m_pScDoc)
408 : {
409 0 : SfxObjectShell* pObjSh = m_pScDoc->GetDocumentShell();
410 0 : if ( pObjSh )
411 : {
412 0 : uno::Reference <sheet::XSpreadsheetDocument> xSpreadDoc( pObjSh->GetModel(), uno::UNO_QUERY );
413 0 : if ( xSpreadDoc.is() )
414 : {
415 0 : uno::Reference<sheet::XSpreadsheets> xSheets = xSpreadDoc->getSheets();
416 0 : uno::Reference<container::XIndexAccess> xIndex( xSheets, uno::UNO_QUERY );
417 0 : if ( xIndex.is() )
418 : {
419 0 : uno::Any aTable = xIndex->getByIndex(m_curCellAddress.Tab());
420 0 : uno::Reference<sheet::XSpreadsheet> xTable;
421 0 : if (aTable>>=xTable)
422 : {
423 0 : uno::Reference<table::XCell> xCell = xTable->getCellByPosition(m_curCellAddress.Col(), m_curCellAddress.Row());
424 0 : if (xCell.is())
425 : {
426 0 : uno::Reference<beans::XPropertySet> xCellProps(xCell, uno::UNO_QUERY);
427 0 : if (xCellProps.is())
428 : {
429 0 : uno::Any aAny = xCellProps->getPropertyValue(strPropColor);
430 0 : aAny >>= nColor;
431 0 : }
432 0 : }
433 0 : }
434 0 : }
435 0 : }
436 : }
437 : }
438 0 : return nColor;
439 : }
440 : //===== XAccessibleSelection ============================================
441 :
442 0 : void SAL_CALL ScAccessibleEditObject::selectAccessibleChild( sal_Int32 )
443 : throw ( IndexOutOfBoundsException, RuntimeException, std::exception )
444 : {
445 0 : }
446 :
447 0 : sal_Bool SAL_CALL ScAccessibleEditObject::isAccessibleChildSelected( sal_Int32 nChildIndex )
448 : throw ( IndexOutOfBoundsException,
449 : RuntimeException, std::exception )
450 : {
451 0 : uno::Reference<XAccessible> xAcc = getAccessibleChild( nChildIndex );
452 0 : uno::Reference<XAccessibleContext> xContext;
453 0 : if( xAcc.is() )
454 0 : xContext = xAcc->getAccessibleContext();
455 0 : if( xContext.is() )
456 : {
457 0 : if( xContext->getAccessibleRole() == AccessibleRole::PARAGRAPH )
458 : {
459 : uno::Reference< ::com::sun::star::accessibility::XAccessibleText >
460 0 : xText(xAcc, uno::UNO_QUERY);
461 0 : if( xText.is() )
462 : {
463 0 : if( xText->getSelectionStart() >= 0 ) return sal_True;
464 0 : }
465 : }
466 : }
467 0 : return sal_False;
468 : }
469 :
470 0 : void SAL_CALL ScAccessibleEditObject::clearAccessibleSelection( )
471 : throw ( RuntimeException, std::exception )
472 : {
473 0 : }
474 :
475 0 : void SAL_CALL ScAccessibleEditObject::selectAllAccessibleChildren( )
476 : throw ( RuntimeException, std::exception )
477 : {
478 0 : }
479 :
480 0 : sal_Int32 SAL_CALL ScAccessibleEditObject::getSelectedAccessibleChildCount()
481 : throw ( RuntimeException, std::exception )
482 : {
483 0 : sal_Int32 nCount = 0;
484 0 : sal_Int32 TotalCount = getAccessibleChildCount();
485 0 : for( sal_Int32 i = 0; i < TotalCount; i++ )
486 0 : if( isAccessibleChildSelected(i) ) nCount++;
487 0 : return nCount;
488 : }
489 :
490 0 : uno::Reference<XAccessible> SAL_CALL ScAccessibleEditObject::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex )
491 : throw ( IndexOutOfBoundsException, RuntimeException, std::exception)
492 : {
493 0 : if ( nSelectedChildIndex > getSelectedAccessibleChildCount() )
494 0 : throw IndexOutOfBoundsException();
495 : sal_Int32 i1, i2;
496 0 : for( i1 = 0, i2 = 0; i1 < getAccessibleChildCount(); i1++ )
497 0 : if( isAccessibleChildSelected(i1) )
498 : {
499 0 : if( i2 == nSelectedChildIndex )
500 0 : return getAccessibleChild( i1 );
501 0 : i2++;
502 : }
503 0 : return uno::Reference<XAccessible>();
504 : }
505 :
506 0 : void SAL_CALL ScAccessibleEditObject::deselectAccessibleChild(
507 : sal_Int32 )
508 : throw ( IndexOutOfBoundsException,
509 : RuntimeException, std::exception )
510 : {
511 0 : }
512 :
513 0 : uno::Reference< XAccessibleRelationSet > ScAccessibleEditObject::getAccessibleRelationSet( )
514 : throw (uno::RuntimeException, std::exception)
515 : {
516 0 : SolarMutexGuard aGuard;
517 0 : vcl::Window* pWindow = mpWindow;
518 0 : utl::AccessibleRelationSetHelper* rRelationSet = new utl::AccessibleRelationSetHelper;
519 0 : uno::Reference< XAccessibleRelationSet > rSet = rRelationSet;
520 0 : if ( pWindow )
521 : {
522 0 : vcl::Window *pLabeledBy = pWindow->GetAccessibleRelationLabeledBy();
523 0 : if ( pLabeledBy && pLabeledBy != pWindow )
524 : {
525 0 : uno::Sequence< uno::Reference< uno::XInterface > > aSequence(1);
526 0 : aSequence[0] = pLabeledBy->GetAccessible();
527 0 : rRelationSet->AddRelation( AccessibleRelation( AccessibleRelationType::LABELED_BY, aSequence ) );
528 : }
529 0 : vcl::Window* pMemberOf = pWindow->GetAccessibleRelationMemberOf();
530 0 : if ( pMemberOf && pMemberOf != pWindow )
531 : {
532 0 : uno::Sequence< uno::Reference< uno::XInterface > > aSequence(1);
533 0 : aSequence[0] = pMemberOf->GetAccessible();
534 0 : rRelationSet->AddRelation( AccessibleRelation( AccessibleRelationType::MEMBER_OF, aSequence ) );
535 : }
536 0 : return rSet;
537 : }
538 0 : return uno::Reference< XAccessibleRelationSet >();
539 228 : }
540 :
541 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
