1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_sc.hxx"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski
28*b1cdbd2cSJim Jagielski #include "AccessibleContextBase.hxx"
29*b1cdbd2cSJim Jagielski #include "unoguard.hxx"
30*b1cdbd2cSJim Jagielski #include <com/sun/star/accessibility/AccessibleRole.hpp>
31*b1cdbd2cSJim Jagielski #include <com/sun/star/accessibility/AccessibleEventId.hpp>
32*b1cdbd2cSJim Jagielski #ifndef _COM_SUN_STAR_ACCESSIBILITY_XACCESSIBLESTATETYPE_HPP_
33*b1cdbd2cSJim Jagielski #include <com/sun/star/accessibility/AccessibleStateType.hpp>
34*b1cdbd2cSJim Jagielski #endif
35*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/PropertyChangeEvent.hpp>
36*b1cdbd2cSJim Jagielski #include <rtl/uuid.h>
37*b1cdbd2cSJim Jagielski #include <tools/debug.hxx>
38*b1cdbd2cSJim Jagielski #include <tools/gen.hxx>
39*b1cdbd2cSJim Jagielski #ifndef _UTL_ACCESSIBLESTATESETHELPER_HXX
40*b1cdbd2cSJim Jagielski #include <unotools/accessiblestatesethelper.hxx>
41*b1cdbd2cSJim Jagielski #endif
42*b1cdbd2cSJim Jagielski #include <toolkit/helper/convert.hxx>
43*b1cdbd2cSJim Jagielski #include <svl/smplhint.hxx>
44*b1cdbd2cSJim Jagielski #include <comphelper/sequence.hxx>
45*b1cdbd2cSJim Jagielski #include <unotools/accessiblerelationsethelper.hxx>
46*b1cdbd2cSJim Jagielski #include <vcl/unohelp.hxx>
47*b1cdbd2cSJim Jagielski #include <tools/color.hxx>
48*b1cdbd2cSJim Jagielski #include <comphelper/accessibleeventnotifier.hxx>
49*b1cdbd2cSJim Jagielski
50*b1cdbd2cSJim Jagielski using namespace ::rtl;
51*b1cdbd2cSJim Jagielski using namespace ::com::sun::star;
52*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::accessibility;
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski //===== internal ============================================================
55*b1cdbd2cSJim Jagielski
DBG_NAME(ScAccessibleContextBase)56*b1cdbd2cSJim Jagielski DBG_NAME(ScAccessibleContextBase)
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski ScAccessibleContextBase::ScAccessibleContextBase(
59*b1cdbd2cSJim Jagielski const uno::Reference<XAccessible>& rxParent,
60*b1cdbd2cSJim Jagielski const sal_Int16 aRole)
61*b1cdbd2cSJim Jagielski :
62*b1cdbd2cSJim Jagielski ScAccessibleContextBaseWeakImpl(m_aMutex),
63*b1cdbd2cSJim Jagielski mxParent(rxParent),
64*b1cdbd2cSJim Jagielski mnClientId(0),
65*b1cdbd2cSJim Jagielski maRole(aRole)
66*b1cdbd2cSJim Jagielski {
67*b1cdbd2cSJim Jagielski DBG_CTOR(ScAccessibleContextBase, NULL);
68*b1cdbd2cSJim Jagielski }
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski
~ScAccessibleContextBase(void)71*b1cdbd2cSJim Jagielski ScAccessibleContextBase::~ScAccessibleContextBase(void)
72*b1cdbd2cSJim Jagielski {
73*b1cdbd2cSJim Jagielski DBG_DTOR(ScAccessibleContextBase, NULL);
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski if (!IsDefunc() && !rBHelper.bInDispose)
76*b1cdbd2cSJim Jagielski {
77*b1cdbd2cSJim Jagielski // increment refcount to prevent double call off dtor
78*b1cdbd2cSJim Jagielski osl_incrementInterlockedCount( &m_refCount );
79*b1cdbd2cSJim Jagielski // call dispose to inform object wich have a weak reference to this object
80*b1cdbd2cSJim Jagielski dispose();
81*b1cdbd2cSJim Jagielski }
82*b1cdbd2cSJim Jagielski }
83*b1cdbd2cSJim Jagielski
Init()84*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::Init()
85*b1cdbd2cSJim Jagielski {
86*b1cdbd2cSJim Jagielski // hold reference to make sure that the destructor is not called
87*b1cdbd2cSJim Jagielski uno::Reference< XAccessibleContext > xOwnContext(this);
88*b1cdbd2cSJim Jagielski
89*b1cdbd2cSJim Jagielski if (mxParent.is())
90*b1cdbd2cSJim Jagielski {
91*b1cdbd2cSJim Jagielski uno::Reference< XAccessibleEventBroadcaster > xBroadcaster (mxParent->getAccessibleContext(), uno::UNO_QUERY);
92*b1cdbd2cSJim Jagielski if (xBroadcaster.is())
93*b1cdbd2cSJim Jagielski xBroadcaster->addEventListener(this);
94*b1cdbd2cSJim Jagielski }
95*b1cdbd2cSJim Jagielski msName = createAccessibleName();
96*b1cdbd2cSJim Jagielski msDescription = createAccessibleDescription();
97*b1cdbd2cSJim Jagielski }
98*b1cdbd2cSJim Jagielski
disposing()99*b1cdbd2cSJim Jagielski void SAL_CALL ScAccessibleContextBase::disposing()
100*b1cdbd2cSJim Jagielski {
101*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
102*b1cdbd2cSJim Jagielski // CommitDefunc(); not necessary and should not be send, because it cost a lot of time
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski // hold reference to make sure that the destructor is not called
105*b1cdbd2cSJim Jagielski uno::Reference< XAccessibleContext > xOwnContext(this);
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski if ( mnClientId )
108*b1cdbd2cSJim Jagielski {
109*b1cdbd2cSJim Jagielski sal_Int32 nTemClientId(mnClientId);
110*b1cdbd2cSJim Jagielski mnClientId = 0;
111*b1cdbd2cSJim Jagielski comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing( nTemClientId, *this );
112*b1cdbd2cSJim Jagielski }
113*b1cdbd2cSJim Jagielski
114*b1cdbd2cSJim Jagielski if (mxParent.is())
115*b1cdbd2cSJim Jagielski {
116*b1cdbd2cSJim Jagielski uno::Reference< XAccessibleEventBroadcaster > xBroadcaster (mxParent->getAccessibleContext(), uno::UNO_QUERY);
117*b1cdbd2cSJim Jagielski if (xBroadcaster.is())
118*b1cdbd2cSJim Jagielski xBroadcaster->removeEventListener(this);
119*b1cdbd2cSJim Jagielski mxParent = NULL;
120*b1cdbd2cSJim Jagielski }
121*b1cdbd2cSJim Jagielski
122*b1cdbd2cSJim Jagielski ScAccessibleContextBaseWeakImpl::disposing();
123*b1cdbd2cSJim Jagielski }
124*b1cdbd2cSJim Jagielski
125*b1cdbd2cSJim Jagielski //===== XInterface =====================================================
126*b1cdbd2cSJim Jagielski
queryInterface(uno::Type const & rType)127*b1cdbd2cSJim Jagielski uno::Any SAL_CALL ScAccessibleContextBase::queryInterface( uno::Type const & rType )
128*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
129*b1cdbd2cSJim Jagielski {
130*b1cdbd2cSJim Jagielski uno::Any aAny (ScAccessibleContextBaseWeakImpl::queryInterface(rType));
131*b1cdbd2cSJim Jagielski return aAny.hasValue() ? aAny : ScAccessibleContextBaseImplEvent::queryInterface(rType);
132*b1cdbd2cSJim Jagielski }
133*b1cdbd2cSJim Jagielski
acquire()134*b1cdbd2cSJim Jagielski void SAL_CALL ScAccessibleContextBase::acquire()
135*b1cdbd2cSJim Jagielski throw ()
136*b1cdbd2cSJim Jagielski {
137*b1cdbd2cSJim Jagielski ScAccessibleContextBaseWeakImpl::acquire();
138*b1cdbd2cSJim Jagielski }
139*b1cdbd2cSJim Jagielski
release()140*b1cdbd2cSJim Jagielski void SAL_CALL ScAccessibleContextBase::release()
141*b1cdbd2cSJim Jagielski throw ()
142*b1cdbd2cSJim Jagielski {
143*b1cdbd2cSJim Jagielski ScAccessibleContextBaseWeakImpl::release();
144*b1cdbd2cSJim Jagielski }
145*b1cdbd2cSJim Jagielski
146*b1cdbd2cSJim Jagielski //===== SfxListener =====================================================
147*b1cdbd2cSJim Jagielski
Notify(SfxBroadcaster &,const SfxHint & rHint)148*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::Notify( SfxBroadcaster&, const SfxHint& rHint )
149*b1cdbd2cSJim Jagielski {
150*b1cdbd2cSJim Jagielski if (rHint.ISA( SfxSimpleHint ) )
151*b1cdbd2cSJim Jagielski {
152*b1cdbd2cSJim Jagielski const SfxSimpleHint& rRef = (const SfxSimpleHint&)rHint;
153*b1cdbd2cSJim Jagielski if (rRef.GetId() == SFX_HINT_DYING)
154*b1cdbd2cSJim Jagielski {
155*b1cdbd2cSJim Jagielski // it seems the Broadcaster is dying, since the view is dying
156*b1cdbd2cSJim Jagielski dispose();
157*b1cdbd2cSJim Jagielski }
158*b1cdbd2cSJim Jagielski }
159*b1cdbd2cSJim Jagielski }
160*b1cdbd2cSJim Jagielski
161*b1cdbd2cSJim Jagielski //===== XAccessible =========================================================
162*b1cdbd2cSJim Jagielski
163*b1cdbd2cSJim Jagielski uno::Reference< XAccessibleContext> SAL_CALL
getAccessibleContext(void)164*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleContext(void)
165*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
166*b1cdbd2cSJim Jagielski {
167*b1cdbd2cSJim Jagielski return this;
168*b1cdbd2cSJim Jagielski }
169*b1cdbd2cSJim Jagielski
170*b1cdbd2cSJim Jagielski //===== XAccessibleComponent ================================================
171*b1cdbd2cSJim Jagielski
containsPoint(const awt::Point & rPoint)172*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL ScAccessibleContextBase::containsPoint(const awt::Point& rPoint )
173*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
174*b1cdbd2cSJim Jagielski {
175*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
176*b1cdbd2cSJim Jagielski IsObjectValid();
177*b1cdbd2cSJim Jagielski return Rectangle (Point(), GetBoundingBox().GetSize()).IsInside(VCLPoint(rPoint));
178*b1cdbd2cSJim Jagielski }
179*b1cdbd2cSJim Jagielski
getAccessibleAtPoint(const awt::Point &)180*b1cdbd2cSJim Jagielski uno::Reference< XAccessible > SAL_CALL ScAccessibleContextBase::getAccessibleAtPoint(
181*b1cdbd2cSJim Jagielski const awt::Point& /* rPoint */ )
182*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
183*b1cdbd2cSJim Jagielski {
184*b1cdbd2cSJim Jagielski DBG_ERROR("not implemented");
185*b1cdbd2cSJim Jagielski return uno::Reference<XAccessible>();
186*b1cdbd2cSJim Jagielski }
187*b1cdbd2cSJim Jagielski
getBounds()188*b1cdbd2cSJim Jagielski awt::Rectangle SAL_CALL ScAccessibleContextBase::getBounds( )
189*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
190*b1cdbd2cSJim Jagielski {
191*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
192*b1cdbd2cSJim Jagielski IsObjectValid();
193*b1cdbd2cSJim Jagielski return AWTRectangle(GetBoundingBox());
194*b1cdbd2cSJim Jagielski }
195*b1cdbd2cSJim Jagielski
getLocation()196*b1cdbd2cSJim Jagielski awt::Point SAL_CALL ScAccessibleContextBase::getLocation( )
197*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
198*b1cdbd2cSJim Jagielski {
199*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
200*b1cdbd2cSJim Jagielski IsObjectValid();
201*b1cdbd2cSJim Jagielski return AWTPoint(GetBoundingBox().TopLeft());
202*b1cdbd2cSJim Jagielski }
203*b1cdbd2cSJim Jagielski
getLocationOnScreen()204*b1cdbd2cSJim Jagielski awt::Point SAL_CALL ScAccessibleContextBase::getLocationOnScreen( )
205*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
206*b1cdbd2cSJim Jagielski {
207*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
208*b1cdbd2cSJim Jagielski IsObjectValid();
209*b1cdbd2cSJim Jagielski return AWTPoint(GetBoundingBoxOnScreen().TopLeft());
210*b1cdbd2cSJim Jagielski }
211*b1cdbd2cSJim Jagielski
getSize()212*b1cdbd2cSJim Jagielski awt::Size SAL_CALL ScAccessibleContextBase::getSize( )
213*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
214*b1cdbd2cSJim Jagielski {
215*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
216*b1cdbd2cSJim Jagielski IsObjectValid();
217*b1cdbd2cSJim Jagielski return AWTSize(GetBoundingBox().GetSize());
218*b1cdbd2cSJim Jagielski }
219*b1cdbd2cSJim Jagielski
isShowing()220*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL ScAccessibleContextBase::isShowing( )
221*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
222*b1cdbd2cSJim Jagielski {
223*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
224*b1cdbd2cSJim Jagielski IsObjectValid();
225*b1cdbd2cSJim Jagielski sal_Bool bShowing(sal_False);
226*b1cdbd2cSJim Jagielski if (mxParent.is())
227*b1cdbd2cSJim Jagielski {
228*b1cdbd2cSJim Jagielski uno::Reference<XAccessibleComponent> xParentComponent (mxParent->getAccessibleContext(), uno::UNO_QUERY);
229*b1cdbd2cSJim Jagielski if (xParentComponent.is())
230*b1cdbd2cSJim Jagielski {
231*b1cdbd2cSJim Jagielski Rectangle aParentBounds(VCLRectangle(xParentComponent->getBounds()));
232*b1cdbd2cSJim Jagielski Rectangle aBounds(VCLRectangle(getBounds()));
233*b1cdbd2cSJim Jagielski bShowing = aBounds.IsOver(aParentBounds);
234*b1cdbd2cSJim Jagielski }
235*b1cdbd2cSJim Jagielski }
236*b1cdbd2cSJim Jagielski return bShowing;
237*b1cdbd2cSJim Jagielski }
238*b1cdbd2cSJim Jagielski
isVisible()239*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL ScAccessibleContextBase::isVisible( )
240*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
241*b1cdbd2cSJim Jagielski {
242*b1cdbd2cSJim Jagielski return sal_True;
243*b1cdbd2cSJim Jagielski }
244*b1cdbd2cSJim Jagielski
grabFocus()245*b1cdbd2cSJim Jagielski void SAL_CALL ScAccessibleContextBase::grabFocus( )
246*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
247*b1cdbd2cSJim Jagielski {
248*b1cdbd2cSJim Jagielski DBG_ERROR("not implemented");
249*b1cdbd2cSJim Jagielski }
250*b1cdbd2cSJim Jagielski
getForeground()251*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL ScAccessibleContextBase::getForeground( )
252*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
253*b1cdbd2cSJim Jagielski {
254*b1cdbd2cSJim Jagielski return COL_BLACK;
255*b1cdbd2cSJim Jagielski }
256*b1cdbd2cSJim Jagielski
getBackground()257*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL ScAccessibleContextBase::getBackground( )
258*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
259*b1cdbd2cSJim Jagielski {
260*b1cdbd2cSJim Jagielski return COL_WHITE;
261*b1cdbd2cSJim Jagielski }
262*b1cdbd2cSJim Jagielski
263*b1cdbd2cSJim Jagielski //===== XAccessibleContext ==================================================
264*b1cdbd2cSJim Jagielski
265*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL
getAccessibleChildCount(void)266*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleChildCount(void)
267*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
268*b1cdbd2cSJim Jagielski {
269*b1cdbd2cSJim Jagielski DBG_ERROR("should be implemented in the abrevated class");
270*b1cdbd2cSJim Jagielski return 0;
271*b1cdbd2cSJim Jagielski }
272*b1cdbd2cSJim Jagielski
273*b1cdbd2cSJim Jagielski uno::Reference<XAccessible> SAL_CALL
getAccessibleChild(sal_Int32)274*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleChild(sal_Int32 /* nIndex */)
275*b1cdbd2cSJim Jagielski throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
276*b1cdbd2cSJim Jagielski {
277*b1cdbd2cSJim Jagielski DBG_ERROR("should be implemented in the abrevated class");
278*b1cdbd2cSJim Jagielski return uno::Reference<XAccessible>();
279*b1cdbd2cSJim Jagielski }
280*b1cdbd2cSJim Jagielski
281*b1cdbd2cSJim Jagielski uno::Reference<XAccessible> SAL_CALL
getAccessibleParent(void)282*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleParent(void)
283*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
284*b1cdbd2cSJim Jagielski {
285*b1cdbd2cSJim Jagielski return mxParent;
286*b1cdbd2cSJim Jagielski }
287*b1cdbd2cSJim Jagielski
288*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL
getAccessibleIndexInParent(void)289*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleIndexInParent(void)
290*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
291*b1cdbd2cSJim Jagielski {
292*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
293*b1cdbd2cSJim Jagielski IsObjectValid();
294*b1cdbd2cSJim Jagielski // Use a simple but slow solution for now. Optimize later.
295*b1cdbd2cSJim Jagielski // Return -1 to indicate that this object's parent does not know about the
296*b1cdbd2cSJim Jagielski // object.
297*b1cdbd2cSJim Jagielski sal_Int32 nIndex(-1);
298*b1cdbd2cSJim Jagielski
299*b1cdbd2cSJim Jagielski // Iterate over all the parent's children and search for this object.
300*b1cdbd2cSJim Jagielski if (mxParent.is())
301*b1cdbd2cSJim Jagielski {
302*b1cdbd2cSJim Jagielski uno::Reference<XAccessibleContext> xParentContext (
303*b1cdbd2cSJim Jagielski mxParent->getAccessibleContext());
304*b1cdbd2cSJim Jagielski if (xParentContext.is())
305*b1cdbd2cSJim Jagielski {
306*b1cdbd2cSJim Jagielski sal_Int32 nChildCount = xParentContext->getAccessibleChildCount();
307*b1cdbd2cSJim Jagielski for (sal_Int32 i=0; i<nChildCount; ++i)
308*b1cdbd2cSJim Jagielski {
309*b1cdbd2cSJim Jagielski uno::Reference<XAccessible> xChild (xParentContext->getAccessibleChild (i));
310*b1cdbd2cSJim Jagielski if (xChild.is())
311*b1cdbd2cSJim Jagielski {
312*b1cdbd2cSJim Jagielski if (xChild.get() == this)
313*b1cdbd2cSJim Jagielski nIndex = i;
314*b1cdbd2cSJim Jagielski }
315*b1cdbd2cSJim Jagielski }
316*b1cdbd2cSJim Jagielski }
317*b1cdbd2cSJim Jagielski }
318*b1cdbd2cSJim Jagielski
319*b1cdbd2cSJim Jagielski return nIndex;
320*b1cdbd2cSJim Jagielski }
321*b1cdbd2cSJim Jagielski
322*b1cdbd2cSJim Jagielski sal_Int16 SAL_CALL
getAccessibleRole(void)323*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleRole(void)
324*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
325*b1cdbd2cSJim Jagielski {
326*b1cdbd2cSJim Jagielski return maRole;
327*b1cdbd2cSJim Jagielski }
328*b1cdbd2cSJim Jagielski
329*b1cdbd2cSJim Jagielski ::rtl::OUString SAL_CALL
getAccessibleDescription(void)330*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleDescription(void)
331*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
332*b1cdbd2cSJim Jagielski {
333*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
334*b1cdbd2cSJim Jagielski IsObjectValid();
335*b1cdbd2cSJim Jagielski if (!msDescription.getLength())
336*b1cdbd2cSJim Jagielski {
337*b1cdbd2cSJim Jagielski OUString sDescription(createAccessibleDescription());
338*b1cdbd2cSJim Jagielski // DBG_ASSERT(sDescription.getLength(), "We should give always a descripition.");
339*b1cdbd2cSJim Jagielski
340*b1cdbd2cSJim Jagielski if (msDescription != sDescription)
341*b1cdbd2cSJim Jagielski {
342*b1cdbd2cSJim Jagielski AccessibleEventObject aEvent;
343*b1cdbd2cSJim Jagielski aEvent.EventId = AccessibleEventId::DESCRIPTION_CHANGED;
344*b1cdbd2cSJim Jagielski aEvent.Source = uno::Reference< XAccessibleContext >(this);
345*b1cdbd2cSJim Jagielski aEvent.OldValue <<= msDescription;
346*b1cdbd2cSJim Jagielski aEvent.NewValue <<= sDescription;
347*b1cdbd2cSJim Jagielski
348*b1cdbd2cSJim Jagielski msDescription = sDescription;
349*b1cdbd2cSJim Jagielski
350*b1cdbd2cSJim Jagielski CommitChange(aEvent);
351*b1cdbd2cSJim Jagielski }
352*b1cdbd2cSJim Jagielski }
353*b1cdbd2cSJim Jagielski return msDescription;
354*b1cdbd2cSJim Jagielski }
355*b1cdbd2cSJim Jagielski
356*b1cdbd2cSJim Jagielski OUString SAL_CALL
getAccessibleName(void)357*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleName(void)
358*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
359*b1cdbd2cSJim Jagielski {
360*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
361*b1cdbd2cSJim Jagielski IsObjectValid();
362*b1cdbd2cSJim Jagielski if (!msName.getLength())
363*b1cdbd2cSJim Jagielski {
364*b1cdbd2cSJim Jagielski OUString sName(createAccessibleName());
365*b1cdbd2cSJim Jagielski DBG_ASSERT(sName.getLength(), "We should give always a name.");
366*b1cdbd2cSJim Jagielski
367*b1cdbd2cSJim Jagielski if (msName != sName)
368*b1cdbd2cSJim Jagielski {
369*b1cdbd2cSJim Jagielski AccessibleEventObject aEvent;
370*b1cdbd2cSJim Jagielski aEvent.EventId = AccessibleEventId::NAME_CHANGED;
371*b1cdbd2cSJim Jagielski aEvent.Source = uno::Reference< XAccessibleContext >(this);
372*b1cdbd2cSJim Jagielski aEvent.OldValue <<= msName;
373*b1cdbd2cSJim Jagielski aEvent.NewValue <<= sName;
374*b1cdbd2cSJim Jagielski
375*b1cdbd2cSJim Jagielski msName = sName;
376*b1cdbd2cSJim Jagielski
377*b1cdbd2cSJim Jagielski CommitChange(aEvent);
378*b1cdbd2cSJim Jagielski }
379*b1cdbd2cSJim Jagielski }
380*b1cdbd2cSJim Jagielski return msName;
381*b1cdbd2cSJim Jagielski }
382*b1cdbd2cSJim Jagielski
383*b1cdbd2cSJim Jagielski uno::Reference<XAccessibleRelationSet> SAL_CALL
getAccessibleRelationSet(void)384*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleRelationSet(void)
385*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
386*b1cdbd2cSJim Jagielski {
387*b1cdbd2cSJim Jagielski return new utl::AccessibleRelationSetHelper();
388*b1cdbd2cSJim Jagielski }
389*b1cdbd2cSJim Jagielski
390*b1cdbd2cSJim Jagielski uno::Reference<XAccessibleStateSet> SAL_CALL
getAccessibleStateSet(void)391*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getAccessibleStateSet(void)
392*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
393*b1cdbd2cSJim Jagielski {
394*b1cdbd2cSJim Jagielski return uno::Reference<XAccessibleStateSet>();
395*b1cdbd2cSJim Jagielski }
396*b1cdbd2cSJim Jagielski
397*b1cdbd2cSJim Jagielski lang::Locale SAL_CALL
getLocale(void)398*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getLocale(void)
399*b1cdbd2cSJim Jagielski throw (IllegalAccessibleComponentStateException,
400*b1cdbd2cSJim Jagielski uno::RuntimeException)
401*b1cdbd2cSJim Jagielski {
402*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
403*b1cdbd2cSJim Jagielski IsObjectValid();
404*b1cdbd2cSJim Jagielski if (mxParent.is())
405*b1cdbd2cSJim Jagielski {
406*b1cdbd2cSJim Jagielski uno::Reference<XAccessibleContext> xParentContext (
407*b1cdbd2cSJim Jagielski mxParent->getAccessibleContext());
408*b1cdbd2cSJim Jagielski if (xParentContext.is())
409*b1cdbd2cSJim Jagielski return xParentContext->getLocale ();
410*b1cdbd2cSJim Jagielski }
411*b1cdbd2cSJim Jagielski
412*b1cdbd2cSJim Jagielski // No locale and no parent. Therefore throw exception to indicate this
413*b1cdbd2cSJim Jagielski // cluelessness.
414*b1cdbd2cSJim Jagielski throw IllegalAccessibleComponentStateException ();
415*b1cdbd2cSJim Jagielski }
416*b1cdbd2cSJim Jagielski
417*b1cdbd2cSJim Jagielski //===== XAccessibleEventBroadcaster =====================================
418*b1cdbd2cSJim Jagielski
419*b1cdbd2cSJim Jagielski void SAL_CALL
addEventListener(const uno::Reference<XAccessibleEventListener> & xListener)420*b1cdbd2cSJim Jagielski ScAccessibleContextBase::addEventListener(
421*b1cdbd2cSJim Jagielski const uno::Reference<XAccessibleEventListener>& xListener)
422*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
423*b1cdbd2cSJim Jagielski {
424*b1cdbd2cSJim Jagielski if (xListener.is())
425*b1cdbd2cSJim Jagielski {
426*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
427*b1cdbd2cSJim Jagielski IsObjectValid();
428*b1cdbd2cSJim Jagielski if (!IsDefunc())
429*b1cdbd2cSJim Jagielski {
430*b1cdbd2cSJim Jagielski if (!mnClientId)
431*b1cdbd2cSJim Jagielski mnClientId = comphelper::AccessibleEventNotifier::registerClient( );
432*b1cdbd2cSJim Jagielski comphelper::AccessibleEventNotifier::addEventListener( mnClientId, xListener );
433*b1cdbd2cSJim Jagielski }
434*b1cdbd2cSJim Jagielski }
435*b1cdbd2cSJim Jagielski }
436*b1cdbd2cSJim Jagielski
437*b1cdbd2cSJim Jagielski void SAL_CALL
removeEventListener(const uno::Reference<XAccessibleEventListener> & xListener)438*b1cdbd2cSJim Jagielski ScAccessibleContextBase::removeEventListener(
439*b1cdbd2cSJim Jagielski const uno::Reference<XAccessibleEventListener>& xListener)
440*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
441*b1cdbd2cSJim Jagielski {
442*b1cdbd2cSJim Jagielski if (xListener.is())
443*b1cdbd2cSJim Jagielski {
444*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
445*b1cdbd2cSJim Jagielski if (!IsDefunc() && mnClientId)
446*b1cdbd2cSJim Jagielski {
447*b1cdbd2cSJim Jagielski sal_Int32 nListenerCount = comphelper::AccessibleEventNotifier::removeEventListener( mnClientId, xListener );
448*b1cdbd2cSJim Jagielski if ( !nListenerCount )
449*b1cdbd2cSJim Jagielski {
450*b1cdbd2cSJim Jagielski // no listeners anymore
451*b1cdbd2cSJim Jagielski // -> revoke ourself. This may lead to the notifier thread dying (if we were the last client),
452*b1cdbd2cSJim Jagielski // and at least to us not firing any events anymore, in case somebody calls
453*b1cdbd2cSJim Jagielski // NotifyAccessibleEvent, again
454*b1cdbd2cSJim Jagielski comphelper::AccessibleEventNotifier::revokeClient( mnClientId );
455*b1cdbd2cSJim Jagielski mnClientId = 0;
456*b1cdbd2cSJim Jagielski }
457*b1cdbd2cSJim Jagielski }
458*b1cdbd2cSJim Jagielski }
459*b1cdbd2cSJim Jagielski }
460*b1cdbd2cSJim Jagielski
461*b1cdbd2cSJim Jagielski //===== XAccessibleEventListener ========================================
462*b1cdbd2cSJim Jagielski
disposing(const lang::EventObject & rSource)463*b1cdbd2cSJim Jagielski void SAL_CALL ScAccessibleContextBase::disposing(
464*b1cdbd2cSJim Jagielski const lang::EventObject& rSource )
465*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
466*b1cdbd2cSJim Jagielski {
467*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
468*b1cdbd2cSJim Jagielski if (rSource.Source == mxParent)
469*b1cdbd2cSJim Jagielski dispose();
470*b1cdbd2cSJim Jagielski }
471*b1cdbd2cSJim Jagielski
notifyEvent(const AccessibleEventObject &)472*b1cdbd2cSJim Jagielski void SAL_CALL ScAccessibleContextBase::notifyEvent(
473*b1cdbd2cSJim Jagielski const AccessibleEventObject& /* aEvent */ )
474*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
475*b1cdbd2cSJim Jagielski {
476*b1cdbd2cSJim Jagielski }
477*b1cdbd2cSJim Jagielski
478*b1cdbd2cSJim Jagielski //===== XServiceInfo ========================================================
479*b1cdbd2cSJim Jagielski
480*b1cdbd2cSJim Jagielski ::rtl::OUString SAL_CALL
getImplementationName(void)481*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getImplementationName(void)
482*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
483*b1cdbd2cSJim Jagielski {
484*b1cdbd2cSJim Jagielski return OUString(RTL_CONSTASCII_USTRINGPARAM ("ScAccessibleContextBase"));
485*b1cdbd2cSJim Jagielski }
486*b1cdbd2cSJim Jagielski
487*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL
supportsService(const OUString & sServiceName)488*b1cdbd2cSJim Jagielski ScAccessibleContextBase::supportsService(const OUString& sServiceName)
489*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
490*b1cdbd2cSJim Jagielski {
491*b1cdbd2cSJim Jagielski // Iterate over all supported service names and return true if on of them
492*b1cdbd2cSJim Jagielski // matches the given name.
493*b1cdbd2cSJim Jagielski uno::Sequence< ::rtl::OUString> aSupportedServices (
494*b1cdbd2cSJim Jagielski getSupportedServiceNames ());
495*b1cdbd2cSJim Jagielski sal_Int32 nLength(aSupportedServices.getLength());
496*b1cdbd2cSJim Jagielski const OUString* pServiceNames = aSupportedServices.getConstArray();
497*b1cdbd2cSJim Jagielski for (int i=0; i<nLength; ++i, ++pServiceNames)
498*b1cdbd2cSJim Jagielski if (sServiceName == *pServiceNames)
499*b1cdbd2cSJim Jagielski return sal_True;
500*b1cdbd2cSJim Jagielski return sal_False;
501*b1cdbd2cSJim Jagielski }
502*b1cdbd2cSJim Jagielski
503*b1cdbd2cSJim Jagielski uno::Sequence< ::rtl::OUString> SAL_CALL
getSupportedServiceNames(void)504*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getSupportedServiceNames(void)
505*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
506*b1cdbd2cSJim Jagielski {
507*b1cdbd2cSJim Jagielski uno::Sequence<OUString> aServiceNames(2);
508*b1cdbd2cSJim Jagielski OUString* pServiceNames = aServiceNames.getArray();
509*b1cdbd2cSJim Jagielski if (pServiceNames)
510*b1cdbd2cSJim Jagielski {
511*b1cdbd2cSJim Jagielski pServiceNames[0] = OUString(RTL_CONSTASCII_USTRINGPARAM ("com.sun.star.accessibility.Accessible"));
512*b1cdbd2cSJim Jagielski pServiceNames[1] = OUString(RTL_CONSTASCII_USTRINGPARAM ("com.sun.star.accessibility.AccessibleContext"));
513*b1cdbd2cSJim Jagielski }
514*b1cdbd2cSJim Jagielski
515*b1cdbd2cSJim Jagielski return aServiceNames;
516*b1cdbd2cSJim Jagielski }
517*b1cdbd2cSJim Jagielski
518*b1cdbd2cSJim Jagielski //===== XTypeProvider =======================================================
519*b1cdbd2cSJim Jagielski
getTypes()520*b1cdbd2cSJim Jagielski uno::Sequence< uno::Type > SAL_CALL ScAccessibleContextBase::getTypes()
521*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
522*b1cdbd2cSJim Jagielski {
523*b1cdbd2cSJim Jagielski return comphelper::concatSequences(ScAccessibleContextBaseWeakImpl::getTypes(), ScAccessibleContextBaseImplEvent::getTypes());
524*b1cdbd2cSJim Jagielski }
525*b1cdbd2cSJim Jagielski
526*b1cdbd2cSJim Jagielski uno::Sequence<sal_Int8> SAL_CALL
getImplementationId(void)527*b1cdbd2cSJim Jagielski ScAccessibleContextBase::getImplementationId(void)
528*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
529*b1cdbd2cSJim Jagielski {
530*b1cdbd2cSJim Jagielski ScUnoGuard aGuard;
531*b1cdbd2cSJim Jagielski IsObjectValid();
532*b1cdbd2cSJim Jagielski static uno::Sequence<sal_Int8> aId;
533*b1cdbd2cSJim Jagielski if (aId.getLength() == 0)
534*b1cdbd2cSJim Jagielski {
535*b1cdbd2cSJim Jagielski aId.realloc (16);
536*b1cdbd2cSJim Jagielski rtl_createUuid (reinterpret_cast<sal_uInt8 *>(aId.getArray()), 0, sal_True);
537*b1cdbd2cSJim Jagielski }
538*b1cdbd2cSJim Jagielski return aId;
539*b1cdbd2cSJim Jagielski }
540*b1cdbd2cSJim Jagielski
541*b1cdbd2cSJim Jagielski //===== internal ============================================================
542*b1cdbd2cSJim Jagielski
543*b1cdbd2cSJim Jagielski ::rtl::OUString SAL_CALL
createAccessibleDescription(void)544*b1cdbd2cSJim Jagielski ScAccessibleContextBase::createAccessibleDescription(void)
545*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
546*b1cdbd2cSJim Jagielski {
547*b1cdbd2cSJim Jagielski DBG_ERROR("should be implemented in the abrevated class");
548*b1cdbd2cSJim Jagielski return rtl::OUString();
549*b1cdbd2cSJim Jagielski }
550*b1cdbd2cSJim Jagielski
551*b1cdbd2cSJim Jagielski ::rtl::OUString SAL_CALL
createAccessibleName(void)552*b1cdbd2cSJim Jagielski ScAccessibleContextBase::createAccessibleName(void)
553*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
554*b1cdbd2cSJim Jagielski {
555*b1cdbd2cSJim Jagielski DBG_ERROR("should be implemented in the abrevated class");
556*b1cdbd2cSJim Jagielski return rtl::OUString();
557*b1cdbd2cSJim Jagielski }
558*b1cdbd2cSJim Jagielski
CommitChange(const AccessibleEventObject & rEvent) const559*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::CommitChange(const AccessibleEventObject& rEvent) const
560*b1cdbd2cSJim Jagielski {
561*b1cdbd2cSJim Jagielski if (mnClientId)
562*b1cdbd2cSJim Jagielski comphelper::AccessibleEventNotifier::addEvent( mnClientId, rEvent );
563*b1cdbd2cSJim Jagielski }
564*b1cdbd2cSJim Jagielski
ChangeName()565*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::ChangeName()
566*b1cdbd2cSJim Jagielski {
567*b1cdbd2cSJim Jagielski AccessibleEventObject aEvent;
568*b1cdbd2cSJim Jagielski aEvent.EventId = AccessibleEventId::NAME_CHANGED;
569*b1cdbd2cSJim Jagielski aEvent.Source = uno::Reference< XAccessibleContext >(const_cast<ScAccessibleContextBase*>(this));
570*b1cdbd2cSJim Jagielski aEvent.OldValue <<= msName;
571*b1cdbd2cSJim Jagielski
572*b1cdbd2cSJim Jagielski msName = rtl::OUString(); // reset the name so it will be hold again
573*b1cdbd2cSJim Jagielski getAccessibleName(); // create the new name
574*b1cdbd2cSJim Jagielski
575*b1cdbd2cSJim Jagielski aEvent.NewValue <<= msName;
576*b1cdbd2cSJim Jagielski
577*b1cdbd2cSJim Jagielski CommitChange(aEvent);
578*b1cdbd2cSJim Jagielski }
579*b1cdbd2cSJim Jagielski
CommitFocusGained() const580*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::CommitFocusGained() const
581*b1cdbd2cSJim Jagielski {
582*b1cdbd2cSJim Jagielski AccessibleEventObject aEvent;
583*b1cdbd2cSJim Jagielski aEvent.EventId = AccessibleEventId::STATE_CHANGED;
584*b1cdbd2cSJim Jagielski aEvent.Source = uno::Reference< XAccessibleContext >(const_cast<ScAccessibleContextBase*>(this));
585*b1cdbd2cSJim Jagielski aEvent.NewValue <<= AccessibleStateType::FOCUSED;
586*b1cdbd2cSJim Jagielski
587*b1cdbd2cSJim Jagielski CommitChange(aEvent);
588*b1cdbd2cSJim Jagielski
589*b1cdbd2cSJim Jagielski ::vcl::unohelper::NotifyAccessibleStateEventGlobally(aEvent);
590*b1cdbd2cSJim Jagielski }
591*b1cdbd2cSJim Jagielski
CommitFocusLost() const592*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::CommitFocusLost() const
593*b1cdbd2cSJim Jagielski {
594*b1cdbd2cSJim Jagielski AccessibleEventObject aEvent;
595*b1cdbd2cSJim Jagielski aEvent.EventId = AccessibleEventId::STATE_CHANGED;
596*b1cdbd2cSJim Jagielski aEvent.Source = uno::Reference< XAccessibleContext >(const_cast<ScAccessibleContextBase*>(this));
597*b1cdbd2cSJim Jagielski aEvent.OldValue <<= AccessibleStateType::FOCUSED;
598*b1cdbd2cSJim Jagielski
599*b1cdbd2cSJim Jagielski CommitChange(aEvent);
600*b1cdbd2cSJim Jagielski
601*b1cdbd2cSJim Jagielski vcl::unohelper::NotifyAccessibleStateEventGlobally(aEvent);
602*b1cdbd2cSJim Jagielski }
603*b1cdbd2cSJim Jagielski
GetBoundingBoxOnScreen(void) const604*b1cdbd2cSJim Jagielski Rectangle ScAccessibleContextBase::GetBoundingBoxOnScreen(void) const
605*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
606*b1cdbd2cSJim Jagielski {
607*b1cdbd2cSJim Jagielski DBG_ERROR("not implemented");
608*b1cdbd2cSJim Jagielski return Rectangle();
609*b1cdbd2cSJim Jagielski }
610*b1cdbd2cSJim Jagielski
GetBoundingBox(void) const611*b1cdbd2cSJim Jagielski Rectangle ScAccessibleContextBase::GetBoundingBox(void) const
612*b1cdbd2cSJim Jagielski throw (uno::RuntimeException)
613*b1cdbd2cSJim Jagielski {
614*b1cdbd2cSJim Jagielski DBG_ERROR("not implemented");
615*b1cdbd2cSJim Jagielski return Rectangle();
616*b1cdbd2cSJim Jagielski }
617*b1cdbd2cSJim Jagielski
IsObjectValid() const618*b1cdbd2cSJim Jagielski void ScAccessibleContextBase::IsObjectValid() const
619*b1cdbd2cSJim Jagielski throw (lang::DisposedException)
620*b1cdbd2cSJim Jagielski {
621*b1cdbd2cSJim Jagielski if (rBHelper.bDisposed || rBHelper.bInDispose)
622*b1cdbd2cSJim Jagielski throw lang::DisposedException();
623*b1cdbd2cSJim Jagielski }
624*b1cdbd2cSJim Jagielski
625