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 "documentfocuslistener.hxx"
21 
22 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
23 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
24 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
26 #include <sal/log.hxx>
27 
28 using namespace ::com::sun::star::accessibility;
29 using namespace ::com::sun::star::lang;
30 using namespace ::com::sun::star::uno;
31 
DocumentFocusListener(AquaA11yFocusTracker & rTracker)32 DocumentFocusListener::DocumentFocusListener(AquaA11yFocusTracker& rTracker) :
33     m_aFocusTracker(rTracker)
34 {
35 }
36 
37 void SAL_CALL
disposing(const EventObject & aEvent)38 DocumentFocusListener::disposing( const EventObject& aEvent )
39 {
40     // Unref the object here, but do not remove as listener since the object
41     // might no longer be in a state that safely allows this.
42     if( aEvent.Source.is() )
43         m_aRefList.erase(aEvent.Source);
44 }
45 
46 void SAL_CALL
notifyEvent(const AccessibleEventObject & aEvent)47 DocumentFocusListener::notifyEvent( const AccessibleEventObject& aEvent )
48 {
49     try {
50         switch( aEvent.EventId )
51         {
52             case AccessibleEventId::STATE_CHANGED:
53             {
54                 sal_Int16 nState = AccessibleStateType::INVALID;
55                 aEvent.NewValue >>= nState;
56 
57                 if( AccessibleStateType::FOCUSED == nState )
58                     m_aFocusTracker.setFocusedObject( getAccessible(aEvent) );
59             }
60             break;
61 
62             case AccessibleEventId::CHILD:
63             {
64                 Reference< XAccessible > xChild;
65                 if( (aEvent.OldValue >>= xChild) && xChild.is() )
66                     detachRecursive(xChild);
67 
68                 if( (aEvent.NewValue >>= xChild) && xChild.is() )
69                     attachRecursive(xChild);
70             }
71             break;
72 
73             case AccessibleEventId::INVALIDATE_ALL_CHILDREN:
74             {
75                 Reference< XAccessible > xAccessible( getAccessible(aEvent) );
76                 detachRecursive(xAccessible);
77                 attachRecursive(xAccessible);
78                 SAL_INFO("vcl", "Invalidate all children called" );
79             }
80             break;
81 
82             default:
83                 break;
84         }
85     }
86     catch (const IndexOutOfBoundsException&)
87     {
88         SAL_WARN("vcl", "Focused object has invalid index in parent");
89     }
90 }
91 
getAccessible(const EventObject & aEvent)92 Reference< XAccessible > DocumentFocusListener::getAccessible(const EventObject& aEvent )
93 {
94     Reference< XAccessible > xAccessible(aEvent.Source, UNO_QUERY);
95 
96     if( xAccessible.is() )
97         return xAccessible;
98 
99     Reference< XAccessibleContext > xContext(aEvent.Source, UNO_QUERY);
100 
101     if( xContext.is() )
102     {
103         Reference< XAccessible > xParent( xContext->getAccessibleParent() );
104         if( xParent.is() )
105         {
106             Reference< XAccessibleContext > xParentContext( xParent->getAccessibleContext() );
107             if( xParentContext.is() )
108             {
109                 return xParentContext->getAccessibleChild( xContext->getAccessibleIndexInParent() );
110             }
111         }
112     }
113 
114     return Reference< XAccessible >();
115 }
116 
attachRecursive(const Reference<XAccessible> & xAccessible)117 void DocumentFocusListener::attachRecursive(const Reference< XAccessible >& xAccessible)
118 {
119     Reference< XAccessibleContext > xContext = xAccessible->getAccessibleContext();
120 
121     if( xContext.is() )
122         attachRecursive(xAccessible, xContext);
123 }
124 
attachRecursive(const Reference<XAccessible> & xAccessible,const Reference<XAccessibleContext> & xContext)125 void DocumentFocusListener::attachRecursive(
126     const Reference< XAccessible >& xAccessible,
127     const Reference< XAccessibleContext >& xContext
128 )
129 {
130     if( xContext.is() )
131     {
132         Reference< XAccessibleStateSet > xStateSet = xContext->getAccessibleStateSet();
133 
134         if( xStateSet.is() )
135             attachRecursive(xAccessible, xContext, xStateSet);
136     }
137 }
138 
attachRecursive(const Reference<XAccessible> & xAccessible,const Reference<XAccessibleContext> & xContext,const Reference<XAccessibleStateSet> & xStateSet)139 void DocumentFocusListener::attachRecursive(
140     const Reference< XAccessible >& xAccessible,
141     const Reference< XAccessibleContext >& xContext,
142     const Reference< XAccessibleStateSet >& xStateSet
143 )
144 {
145     if( xStateSet->contains(AccessibleStateType::FOCUSED ) )
146         m_aFocusTracker.setFocusedObject( xAccessible );
147 
148     Reference< XAccessibleEventBroadcaster > xBroadcaster(xContext, UNO_QUERY);
149 
150     // If not already done, add the broadcaster to the list and attach as listener.
151     if( xBroadcaster.is() && m_aRefList.insert(xBroadcaster).second )
152     {
153         xBroadcaster->addAccessibleEventListener(static_cast< XAccessibleEventListener *>(this));
154 
155         if( ! xStateSet->contains(AccessibleStateType::MANAGES_DESCENDANTS ) )
156         {
157             sal_Int32 n, nmax = xContext->getAccessibleChildCount();
158             for( n = 0; n < nmax; n++ )
159             {
160                 Reference< XAccessible > xChild( xContext->getAccessibleChild( n ) );
161 
162                 if( xChild.is() )
163                     attachRecursive(xChild);
164             }
165         }
166     }
167 }
168 
detachRecursive(const Reference<XAccessible> & xAccessible)169 void DocumentFocusListener::detachRecursive(const Reference< XAccessible >& xAccessible)
170 {
171     Reference< XAccessibleContext > xContext = xAccessible->getAccessibleContext();
172 
173     if( xContext.is() )
174         detachRecursive(xAccessible, xContext);
175 }
176 
detachRecursive(const Reference<XAccessible> & xAccessible,const Reference<XAccessibleContext> & xContext)177 void DocumentFocusListener::detachRecursive(
178     const Reference< XAccessible >& xAccessible,
179     const Reference< XAccessibleContext >& xContext
180 )
181 {
182     Reference< XAccessibleStateSet > xStateSet = xContext->getAccessibleStateSet();
183 
184     if( xStateSet.is() )
185         detachRecursive(xAccessible, xContext, xStateSet);
186 }
187 
detachRecursive(const Reference<XAccessible> &,const Reference<XAccessibleContext> & xContext,const Reference<XAccessibleStateSet> & xStateSet)188 void DocumentFocusListener::detachRecursive(
189     const Reference< XAccessible >&,
190     const Reference< XAccessibleContext >& xContext,
191     const Reference< XAccessibleStateSet >& xStateSet
192 )
193 {
194     Reference< XAccessibleEventBroadcaster > xBroadcaster(xContext, UNO_QUERY);
195 
196     if( xBroadcaster.is() && 0 < m_aRefList.erase(xBroadcaster) )
197     {
198         xBroadcaster->removeAccessibleEventListener(static_cast< XAccessibleEventListener *>(this));
199 
200         if( ! xStateSet->contains(AccessibleStateType::MANAGES_DESCENDANTS ) )
201         {
202             sal_Int32 n, nmax = xContext->getAccessibleChildCount();
203             for( n = 0; n < nmax; n++ )
204             {
205                 Reference< XAccessible > xChild( xContext->getAccessibleChild( n ) );
206 
207                 if( xChild.is() )
208                     detachRecursive(xChild);
209             }
210         }
211     }
212 }
213 
214 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
215