LibreOffice Module accessibility (master) 1
accessibleeditbrowseboxcell.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
20#include <helper/accresmgr.hxx>
21#include <strings.hrc>
22
25#include <utility>
27
28namespace accessibility
29{
30 using namespace com::sun::star::accessibility;
31 using namespace ::com::sun::star::uno;
32 using namespace ::com::sun::star::lang;
33 using namespace ::com::sun::star::awt;
34 using namespace ::comphelper;
35
37 const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
38 const css::uno::Reference< css::accessibility::XAccessible >& _rxOwningAccessible,
39 const css::uno::Reference< css::accessibility::XAccessibleContext >& _xControlChild,
41 const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
42 sal_Int32 _nRowPos,
43 sal_uInt16 _nColPos)
44 :AccessibleBrowseBoxCell( _rxParent, _rBrowseBox, _xFocusWindow, _nRowPos, _nColPos )
45 ,OAccessibleContextWrapperHelper( ::comphelper::getProcessComponentContext(), rBHelper, _xControlChild, _rxOwningAccessible, _rxParent )
46 {
47 aggregateProxy( m_refCount, *this );
48 }
49
51 {
52 if ( !rBHelper.bDisposed )
53 {
54 acquire(); // to prevent duplicate dtor calls
55 dispose();
56 }
57 }
58
60 {
61 return "com.sun.star.comp.svtools.TableCellProxy";
62 }
63
65
67
68 void EditBrowseBoxTableCell::notifyTranslatedEvent( const AccessibleEventObject& _rEvent )
69 {
70 commitEvent( _rEvent.EventId, _rEvent.NewValue, _rEvent.OldValue );
71 }
72
73 // css::accessibility::XAccessibleComponent
75 {
76 SolarMethodGuard aGuard(getMutex());
78
79 css::uno::Reference< css::accessibility::XAccessibleComponent > xAccComp( m_xInnerContext, UNO_QUERY );
80 if ( xAccComp.is() )
81 return xAccComp->getForeground();
82 return 0;
83 }
84
86 {
87 SolarMethodGuard aGuard(getMutex());
89
90 css::uno::Reference< css::accessibility::XAccessibleComponent > xAccComp( m_xInnerContext, UNO_QUERY );
91 if ( xAccComp.is() )
92 return xAccComp->getBackground();
93 return 0;
94 }
95
96 css::uno::Reference< css::accessibility::XAccessible > SAL_CALL EditBrowseBoxTableCell::getAccessibleParent( )
97 {
99 }
100
102 {
103 SolarMethodGuard aGuard(getMutex());
105
106 return m_xInnerContext->getAccessibleDescription();
107 }
108
110 {
111 SolarMethodGuard aGuard(getMutex());
113
114 return AccResId(RID_STR_ACC_COLUMN_NUM).replaceAll("%COLUMNNUMBER", OUString::number(getColumnPos()-1)) + ", "
115 + AccResId(RID_STR_ACC_ROW_NUM).replaceAll("%ROWNUMBER", OUString::number(getRowPos()));
116 }
117
118 css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL EditBrowseBoxTableCell::getAccessibleRelationSet()
119 {
120 SolarMethodGuard aGuard(getMutex());
122
124 }
125
127 {
128 SolarMethodGuard aGuard(getMutex());
130
131 return m_xInnerContext->getAccessibleStateSet();
132 // TODO: shouldn't we add an ACTIVE here? Isn't the EditBrowseBoxTableCell always ACTIVE?
133 }
134
136 {
137 SolarMethodGuard aGuard(getMutex());
139
141 }
142
143 css::uno::Reference< css::accessibility::XAccessible > SAL_CALL EditBrowseBoxTableCell::getAccessibleChild( sal_Int64 i )
144 {
145 SolarMethodGuard aGuard(getMutex());
147
148 return baseGetAccessibleChild( i );
149 }
150
152 {
153 SolarMethodGuard aGuard(getMutex());
155
156 return m_xInnerContext->getAccessibleRole( );
157 }
158
160 {
161 // simply disambiguate. Note that the OComponentHelper base in AccessibleBrowseBoxCell
162 // will call our "disposing()", which will call "dispose()" on the OAccessibleContextWrapperHelper
163 // so there is no need to do this here.
164 AccessibleBrowseBoxCell::dispose();
165 }
166
167 void SAL_CALL EditBrowseBoxTableCell::disposing( const css::lang::EventObject& _rSource )
168 {
171 }
172
174 {
175 SolarMethodGuard aGuard(getMutex());
176
178 // TODO: do we need to dispose our inner object? The base class does this, but is it a good idea?
180 }
181
182 // EditBrowseBoxTableCell
184 css::uno::Reference< css::accessibility::XAccessible > _xParent, css::uno::Reference< css::accessibility::XAccessible > _xControlAccessible,
185 css::uno::Reference< css::awt::XWindow > _xFocusWindow,
186 ::vcl::IAccessibleTableProvider& _rBrowseBox, sal_Int32 _nRowPos, sal_uInt16 _nColPos )
187 :m_xParent(std::move( _xParent ))
188 ,m_xControlAccessible(std::move( _xControlAccessible ))
189 ,m_xFocusWindow(std::move( _xFocusWindow ))
190 ,m_pBrowseBox( &_rBrowseBox )
191 ,m_nRowPos( _nRowPos )
192 ,m_nColPos( _nColPos )
193 {
194 }
195
197 {
198 }
199
200 css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL EditBrowseBoxTableCellAccess::getAccessibleContext( )
201 {
202 if ( !m_pBrowseBox || !m_xControlAccessible.is() )
203 throw DisposedException();
204 css::uno::Reference< css::accessibility::XAccessibleContext > xMyContext( m_aContext );
205 if ( !xMyContext.is() )
206 {
207 css::uno::Reference< css::accessibility::XAccessibleContext > xInnerContext = m_xControlAccessible->getAccessibleContext();
208 css::uno::Reference< css::accessibility::XAccessible > xMe( this );
209
210 xMyContext = new EditBrowseBoxTableCell( xMe, m_xParent, xInnerContext, *m_pBrowseBox, m_xFocusWindow, m_nRowPos, m_nColPos );
211 m_aContext = xMyContext;
212 }
213 return xMyContext;
214 }
215
216 void EditBrowseBoxTableCellAccess::disposing(std::unique_lock<std::mutex>&)
217 {
218 // dispose our context, if it still alive
219 css::uno::Reference< XComponent > xMyContext( m_aContext.get(), UNO_QUERY );
220 if ( xMyContext.is() )
221 {
222 try
223 {
224 xMyContext->dispose();
225 }
226 catch( const Exception& )
227 {
228 TOOLS_WARN_EXCEPTION( "accessibility", "EditBrowseBoxTableCellAccess::disposing: caught an exception while disposing the context!" );
229 }
230 }
231
232 m_pBrowseBox = nullptr;
233 m_xControlAccessible.clear();
234 m_aContext.clear();
235 // NO dispose of the inner object there: it is the css::accessibility::XAccessible of a window, and disposing
236 // it would delete the respective VCL window
237 }
238} // namespace accessibility
239
240/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
OUString AccResId(TranslateId aId)
Definition: accresmgr.cxx:22
virtual void SAL_CALL disposing() override
Commits DeFunc event to listeners and cleans up members.
common accessibility-functionality for browse box elements which occupy a cell
css::uno::Reference< css::accessibility::XAccessible > m_xControlAccessible
css::uno::Reference< css::accessibility::XAccessible > m_xParent
css::uno::WeakReference< css::accessibility::XAccessibleContext > m_aContext
virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext() override
css::uno::Reference< css::awt::XWindow > m_xFocusWindow
EditBrowseBoxTableCellAccess(css::uno::Reference< css::accessibility::XAccessible > _xParent, css::uno::Reference< css::accessibility::XAccessible > _xControlAccessible, css::uno::Reference< css::awt::XWindow > _xFocusWindow, ::vcl::IAccessibleTableProvider &_rBrowseBox, sal_Int32 _nRowPos, sal_uInt16 _nColPos)
virtual void disposing(std::unique_lock< std::mutex > &) override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild(sal_Int64 i) override
virtual void SAL_CALL disposing() override
Commits DeFunc event to listeners and cleans up members.
virtual sal_Int64 SAL_CALL getAccessibleChildCount() override
EditBrowseBoxTableCell(const css::uno::Reference< css::accessibility::XAccessible > &_rxParent, const css::uno::Reference< css::accessibility::XAccessible > &_rxOwningAccessible, const css::uno::Reference< css::accessibility::XAccessibleContext > &_xControlChild, ::vcl::IAccessibleTableProvider &_rBrowseBox, const css::uno::Reference< css::awt::XWindow > &_xFocusWindow, sal_Int32 _nRowPos, sal_uInt16 _nColPos)
virtual sal_Int32 SAL_CALL getForeground() override
virtual OUString SAL_CALL getAccessibleName() override
virtual void SAL_CALL dispose() final override
virtual sal_Int64 SAL_CALL getAccessibleStateSet() override
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet() override
virtual OUString SAL_CALL getAccessibleDescription() override
virtual OUString SAL_CALL getImplementationName() override
virtual sal_Int32 SAL_CALL getBackground() override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent() override
css::uno::Reference< css::accessibility::XAccessible > m_xParentAccessible
css::uno::Reference< css::accessibility::XAccessible > baseGetAccessibleChild(sal_Int64 i)
virtual void SAL_CALL disposing(const css::lang::EventObject &Source) override
css::uno::Reference< css::accessibility::XAccessibleContext > m_xInnerContext
void aggregateProxy(oslInterlockedCount &_rRefCount, ::cppu::OWeakObject &_rDelegator)
virtual void SAL_CALL dispose() override
css::uno::Reference< css::accessibility::XAccessibleRelationSet > baseGetAccessibleRelationSet()
#define TOOLS_WARN_EXCEPTION(area, stream)
ULONG m_refCount
@ Exception
Reference< XComponentContext > getProcessComponentContext()
int i
IMPLEMENT_FORWARD_XTYPEPROVIDER2(ChildWindowPane, ChildWindowPaneInterfaceBase, Pane)
IMPLEMENT_FORWARD_XINTERFACE2(ChildWindowPane, ChildWindowPaneInterfaceBase, Pane)