LibreOffice Module sc (master) 1
AccessiblePageHeader.cxx
Go to the documentation of this file.
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
22#include <prevwsh.hxx>
23#include <prevloc.hxx>
24#include <document.hxx>
25#include <stlpool.hxx>
26#include <scitems.hxx>
27#include <attrib.hxx>
28#include <scresid.hxx>
29#include <strings.hrc>
30#include <strings.hxx>
31
32#include <com/sun/star/accessibility/AccessibleRole.hpp>
33#include <com/sun/star/accessibility/AccessibleStateType.hpp>
34#include <com/sun/star/accessibility/AccessibleEventId.hpp>
35#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
37
38#include <vcl/window.hxx>
39#include <svl/hint.hxx>
40#include <svl/itemset.hxx>
41#include <vcl/svapp.hxx>
42#include <svl/style.hxx>
43#include <editeng/editobj.hxx>
44
45using namespace ::com::sun::star;
46using namespace ::com::sun::star::accessibility;
47
49
50ScAccessiblePageHeader::ScAccessiblePageHeader( const css::uno::Reference<css::accessibility::XAccessible>& rxParent,
51 ScPreviewShell* pViewShell, bool bHeader, sal_Int32 nIndex ) :
52ScAccessibleContextBase( rxParent, bHeader ? AccessibleRole::HEADER : AccessibleRole::FOOTER ),
53 mpViewShell( pViewShell ),
54 mnIndex( nIndex ),
55 mbHeader( bHeader ),
57 mnChildCount(-1)
58{
59 if (mpViewShell)
61}
62
64{
65 if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
66 {
67 // increment refcount to prevent double call off dtor
68 osl_atomic_increment( &m_refCount );
69 dispose();
70 }
71}
72
74{
75 SolarMutexGuard aGuard;
76 if (mpViewShell)
77 {
79 mpViewShell = nullptr;
80 }
81 for (auto & i : maAreas)
82 {
83 if (i.is())
84 {
85 i->dispose();
86 i.clear();
87 }
88 }
89
91}
92
93//===== SfxListener =====================================================
94
96{
97 // only notify if child exist, otherwise it is not necessary
98 if (rHint.GetId() == SfxHintId::ScDataChanged)
99 {
100 std::vector<rtl::Reference<ScAccessiblePageHeaderArea>> aOldAreas(maAreas);
101 mnChildCount = -1;
103 for (sal_uInt8 i = 0; i < MAX_AREAS; ++i)
104 {
105 if ((aOldAreas[i].is() && maAreas[i].is() && !ScGlobal::EETextObjEqual(aOldAreas[i]->GetEditTextObject(), maAreas[i]->GetEditTextObject())) ||
106 (aOldAreas[i].is() && !maAreas[i].is()) || (!aOldAreas[i].is() && maAreas[i].is()))
107 {
108 if (aOldAreas[i].is() && aOldAreas[i]->GetEditTextObject())
109 {
110 AccessibleEventObject aEvent;
111 aEvent.EventId = AccessibleEventId::CHILD;
112 aEvent.Source = uno::Reference< XAccessibleContext >(this);
113 aEvent.OldValue <<= uno::Reference<XAccessible>(aOldAreas[i]);
114
115 CommitChange(aEvent); // child gone - event
116 aOldAreas[i]->dispose();
117 }
118 if (maAreas[i].is() && maAreas[i]->GetEditTextObject())
119 {
120 AccessibleEventObject aEvent;
121 aEvent.EventId = AccessibleEventId::CHILD;
122 aEvent.Source = uno::Reference< XAccessibleContext >(this);
123 aEvent.NewValue <<= uno::Reference<XAccessible>(maAreas[i]);
124
125 CommitChange(aEvent); // new child - event
126 }
127 }
128 }
129 }
130 else if (rHint.GetId() == SfxHintId::ScAccVisAreaChanged)
131 {
132 AccessibleEventObject aEvent;
133 aEvent.EventId = AccessibleEventId::VISIBLE_DATA_CHANGED;
134 aEvent.Source = uno::Reference< XAccessibleContext >(this);
136 }
137
139}
140
141//===== XAccessibleComponent ============================================
142
143uno::Reference< XAccessible > SAL_CALL ScAccessiblePageHeader::getAccessibleAtPoint( const awt::Point& aPoint )
144{
145 uno::Reference<XAccessible> xRet;
146
147 if (containsPoint(aPoint))
148 {
149 SolarMutexGuard aGuard;
151
152 sal_Int64 nCount(getAccessibleChildCount()); // fill the areas
153
154 if (nCount)
155 {
156 // return the first with content, because they have all the same Bounding Box
157 sal_uInt8 i(0);
158 while(!xRet.is() && i < MAX_AREAS)
159 {
160 if (maAreas[i].is())
161 xRet = maAreas[i].get();
162 else
163 ++i;
164 }
165 }
166 }
167
168 return xRet;
169}
170
172{
173 SolarMutexGuard aGuard;
175 if (getAccessibleParent().is())
176 {
177 uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
178 if (xAccessibleComponent.is())
179 xAccessibleComponent->grabFocus();
180 }
181}
182
183//===== XAccessibleContext ==============================================
184
186{
187 SolarMutexGuard aGuard;
189
190 if((mnChildCount < 0) && mpViewShell)
191 {
192 mnChildCount = 0;
194 // find out how many regions (left,center, right) are with content
195
196 SfxStyleSheetBase* pStyle = rDoc.GetStyleSheetPool()->Find(rDoc.GetPageStyle(mpViewShell->GetLocationData().GetPrintTab()), SfxStyleFamily::Page);
197 if (pStyle)
198 {
199 sal_uInt16 nPageWhichId(0);
200 if (mbHeader)
202 else
204
205 const ScPageHFItem& rPageItem = static_cast<const ScPageHFItem&>(pStyle->GetItemSet().Get(nPageWhichId));
206 AddChild(rPageItem.GetLeftArea(), 0, SvxAdjust::Left);
207 AddChild(rPageItem.GetCenterArea(), 1, SvxAdjust::Center);
208 AddChild(rPageItem.GetRightArea(), 2, SvxAdjust::Right);
209 }
210 }
211
212 return mnChildCount;
213}
214
215uno::Reference< XAccessible > SAL_CALL ScAccessiblePageHeader::getAccessibleChild( sal_Int64 nIndex )
216{
217 SolarMutexGuard aGuard;
219
220 uno::Reference<XAccessible> xRet;
221
222 if(mnChildCount < 0)
224
225 if (nIndex >= 0)
226 for (const auto& rxArea : maAreas)
227 {
228 if (rxArea.is())
229 {
230 if (nIndex == 0)
231 {
232 xRet = rxArea.get();
233 break;
234 }
235 else
236 --nIndex;
237 }
238 }
239
240 if ( !xRet.is() )
241 throw lang::IndexOutOfBoundsException();
242
243 return xRet;
244}
245
247{
248 return mnIndex;
249}
250
252{
253 SolarMutexGuard aGuard;
254 sal_Int64 nParentStates = 0;
255 if (getAccessibleParent().is())
256 {
257 uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
258 nParentStates = xParentContext->getAccessibleStateSet();
259 }
260 sal_Int64 nStateSet = 0;
261 if (IsDefunc(nParentStates))
262 nStateSet |= AccessibleStateType::DEFUNC;
263 else
264 {
265 nStateSet |= AccessibleStateType::ENABLED;
266 nStateSet |= AccessibleStateType::OPAQUE;
267 if (isShowing())
268 nStateSet |= AccessibleStateType::SHOWING;
269 if (isVisible())
270 nStateSet |= AccessibleStateType::VISIBLE;
271 }
272 return nStateSet;
273}
274
275//===== XServiceInfo ====================================================
276
278{
279 return "ScAccessiblePageHeader";
280}
281
282uno::Sequence<OUString> SAL_CALL ScAccessiblePageHeader::getSupportedServiceNames()
283{
284 const css::uno::Sequence<OUString> vals { "com.sun.star.text.AccessibleHeaderFooterView" };
286}
287
288//==== internal =========================================================
289
291{
292 OUString sDesc(mbHeader ? OUString(STR_ACC_HEADER_DESCR) : OUString(STR_ACC_FOOTER_DESCR));
293 return sDesc.replaceFirst("%1", ScResId(SCSTR_UNKNOWN));
294}
295
297{
298 OUString sName(ScResId(mbHeader ? STR_ACC_HEADER_NAME : STR_ACC_FOOTER_NAME));
299 return sName.replaceFirst("%1", ScResId(SCSTR_UNKNOWN));
300}
301
303{
304 tools::Rectangle aCellRect(GetBoundingBox());
305 if (mpViewShell)
306 {
307 vcl::Window* pWindow = mpViewShell->GetWindow();
308 if (pWindow)
309 {
310 tools::Rectangle aRect = pWindow->GetWindowExtentsRelative(nullptr);
311 aCellRect.Move(aRect.Left(), aRect.Top());
312 }
313 }
314 return aCellRect;
315}
316
318{
319 tools::Rectangle aRect;
320 if (mpViewShell)
321 {
323 if ( mbHeader )
324 rData.GetHeaderPosition( aRect );
325 else
326 rData.GetFooterPosition( aRect );
327
328 // the Rectangle could contain negative coordinates so it should be clipped
329 tools::Rectangle aClipRect(Point(0, 0), aRect.GetSize());
330 vcl::Window* pWindow = mpViewShell->GetWindow();
331 if (pWindow)
332 aClipRect = pWindow->GetWindowExtentsRelative(pWindow->GetAccessibleParentWindow());
333 aRect = aClipRect.GetIntersection(aRect);
334 }
335 if (aRect.IsEmpty())
336 aRect.SetSize(Size(-1, -1));
337
338 return aRect;
339}
340
341bool ScAccessiblePageHeader::IsDefunc( sal_Int64 nParentStates )
342{
343 return ScAccessibleContextBase::IsDefunc() || (mpViewShell == nullptr) || !getAccessibleParent().is() ||
344 (nParentStates & AccessibleStateType::DEFUNC);
345}
346
347void ScAccessiblePageHeader::AddChild(const EditTextObject* pArea, sal_uInt32 nIndex, SvxAdjust eAdjust)
348{
349 if (pArea && (!pArea->GetText(0).isEmpty() || (pArea->GetParagraphCount() > 1)))
350 {
351 if (maAreas[nIndex].is())
352 {
353 if (!ScGlobal::EETextObjEqual(maAreas[nIndex]->GetEditTextObject(), pArea))
354 {
355 maAreas[nIndex] = new ScAccessiblePageHeaderArea(this, mpViewShell, pArea, eAdjust);
356 }
357 }
358 else
359 {
360 maAreas[nIndex] = new ScAccessiblePageHeaderArea(this, mpViewShell, pArea, eAdjust);
361 }
362 ++mnChildCount;
363 }
364 else
365 {
366 maAreas[nIndex].clear();
367 }
368}
369
370/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const sal_uInt8 MAX_AREAS
int mnIndex
AnyEventRef aEvent
virtual sal_Int32 GetParagraphCount() const=0
virtual OUString GetText(sal_Int32 nPara) const=0
virtual sal_Bool SAL_CALL containsPoint(const css::awt::Point &rPoint) override
===== XAccessibleComponent ============================================
virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext() override
===== XAccessible =====================================================
virtual void SAL_CALL disposing() override
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
Returns a list of all supported services.
virtual void Notify(SfxBroadcaster &rBC, const SfxHint &rHint) override
===== SfxListener =====================================================
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent() override
Return a reference to the parent.
void CommitChange(const css::accessibility::AccessibleEventObject &rEvent) const
Calls all Listener to tell they the change.
void AddChild(const EditTextObject *pArea, sal_uInt32 nIndex, SvxAdjust eAdjust)
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
Returns a list of all supported services.
virtual OUString SAL_CALL getImplementationName() override
===== XServiceInfo ====================================================
ScAccessiblePageHeader(const css::uno::Reference< css::accessibility::XAccessible > &rxParent, ScPreviewShell *pViewShell, bool bHeader, sal_Int32 nIndex)
virtual void SAL_CALL disposing() override
virtual void Notify(SfxBroadcaster &rBC, const SfxHint &rHint) override
===== SfxListener =====================================================
std::vector< rtl::Reference< ScAccessiblePageHeaderArea > > maAreas
virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override
Return this objects index among the parents children.
virtual tools::Rectangle GetBoundingBox() const override
Return the object's current bounding box relative to the parent object.
virtual sal_Int64 SAL_CALL getAccessibleStateSet() override
Return the set of current states.
virtual tools::Rectangle GetBoundingBoxOnScreen() const override
Return the object's current bounding box relative to the desktop.
virtual void SAL_CALL grabFocus() override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild(sal_Int64 i) override
Return the specified child or NULL if index is invalid.
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint(const css::awt::Point &aPoint) override
virtual OUString createAccessibleDescription() override
Return this object's description.
virtual sal_Int64 SAL_CALL getAccessibleChildCount() override
===== XAccessibleContext ==============================================
virtual ~ScAccessiblePageHeader() override
virtual OUString createAccessibleName() override
Return the object's current name.
SC_DLLPUBLIC OUString GetPageStyle(SCTAB nTab) const
Definition: document.cxx:6302
SC_DLLPUBLIC ScStyleSheetPool * GetStyleSheetPool() const
Definition: document.cxx:6175
static bool EETextObjEqual(const EditTextObject *pObj1, const EditTextObject *pObj2)
Definition: global.cxx:796
const EditTextObject * GetCenterArea() const
Definition: attrib.hxx:186
const EditTextObject * GetLeftArea() const
Definition: attrib.hxx:185
const EditTextObject * GetRightArea() const
Definition: attrib.hxx:187
bool GetHeaderPosition(tools::Rectangle &rHeaderRect) const
Definition: prevloc.cxx:334
bool IsFooterLeft() const
Definition: prevloc.cxx:376
bool IsHeaderLeft() const
Definition: prevloc.cxx:362
bool GetFooterPosition(tools::Rectangle &rFooterRect) const
Definition: prevloc.cxx:348
SCTAB GetPrintTab() const
Definition: prevloc.hxx:117
const ScPreviewLocationData & GetLocationData()
Definition: prevwsh.cxx:1171
void AddAccessibilityObject(SfxListener &rObject)
Definition: prevwsh.cxx:1142
ScDocument & GetDocument()
Definition: prevwsh.cxx:1176
void RemoveAccessibilityObject(SfxListener &rObject)
Definition: prevwsh.cxx:1150
SfxHintId GetId() const
const SfxPoolItem & Get(sal_uInt16 nWhich, bool bSrchInParent=true) const
virtual SfxStyleSheetBase * Find(const OUString &, SfxStyleFamily eFam, SfxStyleSearchBits n=SfxStyleSearchBits::All) const
virtual SfxItemSet & GetItemSet()
vcl::Window * GetWindow() const
tools::Rectangle GetIntersection(const tools::Rectangle &rRect) const
constexpr tools::Long Top() const
void SetSize(const Size &)
constexpr Size GetSize() const
void Move(tools::Long nHorzMoveDelta, tools::Long nVertMoveDelta)
constexpr tools::Long Left() const
constexpr bool IsEmpty() const
vcl::Window * GetAccessibleParentWindow() const
tools::Rectangle GetWindowExtentsRelative(const vcl::Window *pRelativeWindow) const
int nCount
ULONG m_refCount
sal_Int32 nIndex
const char * sName
css::uno::Sequence< T > concatSequences(const css::uno::Sequence< T > &rS1, const Ss &... rSn)
Reference
int i
void dispose()
OUString ScResId(TranslateId aId)
Definition: scdll.cxx:90
constexpr TypedWhichId< ScPageHFItem > ATTR_PAGE_FOOTERLEFT(179)
constexpr TypedWhichId< ScPageHFItem > ATTR_PAGE_HEADERLEFT(178)
constexpr TypedWhichId< ScPageHFItem > ATTR_PAGE_FOOTERRIGHT(181)
constexpr TypedWhichId< ScPageHFItem > ATTR_PAGE_HEADERRIGHT(180)
constexpr OUStringLiteral STR_ACC_HEADER_DESCR
Definition: strings.hxx:25
constexpr OUStringLiteral STR_ACC_FOOTER_DESCR
Definition: strings.hxx:26
SvxAdjust
unsigned char sal_uInt8