1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVX_ACCESSIBLECONTROLSHAPE_HXX
#define INCLUDED_SVX_ACCESSIBLECONTROLSHAPE_HXX
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/lang/EventObject.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/util/XModeChangeListener.hpp>
#include <comphelper/uno3.hxx>
#include <cppuhelper/implbase4.hxx>
#include <cppuhelper/weakref.hxx>
#include <rtl/ref.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <svx/AccessibleShape.hxx>
namespace com::sun::star {
namespace accessibility { class XAccessible; }
namespace accessibility { class XAccessibleContext; }
namespace accessibility { struct AccessibleEventObject; }
namespace accessibility { class XAccessibleRelationSet; }
namespace awt { class XControl; }
namespace beans { class XPropertySet; }
namespace beans { class XPropertySetInfo; }
namespace beans { struct PropertyChangeEvent; }
namespace container { struct ContainerEvent; }
namespace lang { class XComponent; }
namespace lang { class XTypeProvider; }
namespace uno { class XAggregation; }
namespace util { struct ModeChangeEvent; }
}
namespace comphelper
{
class OWrappedAccessibleChildrenManager;
}
namespace accessibility {
class AccessibleShapeInfo;
class AccessibleShapeTreeInfo;
typedef ::cppu::ImplHelper4 < css::beans::XPropertyChangeListener
, css::util::XModeChangeListener
, css::container::XContainerListener
, css::accessibility::XAccessibleEventListener
> AccessibleControlShape_Base;
/** @descr
*/
class SAL_DLLPUBLIC_RTTI AccessibleControlShape final
:public AccessibleShape
,public AccessibleControlShape_Base
{
public:
//===== internal ========================================================
AccessibleControlShape(
const AccessibleShapeInfo& rShapeInfo,
const AccessibleShapeTreeInfo& rShapeTreeInfo);
virtual ~AccessibleControlShape( ) override;
const css::uno::Reference< css::beans::XPropertySet >& GetControlModel( ) const { return m_xControlModel;}
AccessibleControlShape* GetLabeledByControlShape();
private:
//--- XAccessibleComponent -------------------------------
/// forward the focus to the contained control(in alive mode)
virtual void SAL_CALL grabFocus( ) override;
//--- XAccessibleContext ---------------------------------
virtual sal_Int32 SAL_CALL getAccessibleChildCount( ) override;
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) override;
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet( ) override;
//--- XServiceInfo ---------------------------------------
virtual OUString SAL_CALL getImplementationName( ) override;
//--- XInterface -----------------------------------------
DECLARE_XINTERFACE( )
//--- XTypeProvider --------------------------------------
DECLARE_XTYPEPROVIDER( )
//--- XPropertyChangeListener ----------------------------
virtual void SAL_CALL propertyChange( const css::beans::PropertyChangeEvent& _rEvent ) override;
//--- XComponent -----------------------------------------
virtual void SAL_CALL disposing( ) override;
//--- XEventListener -------------------------------------
virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
//--- XModeChangeListener --------------------------------
virtual void SAL_CALL modeChanged( const css::util::ModeChangeEvent& _rSource ) override;
//--- XAccessibleEventListener ----------------------------
virtual void SAL_CALL notifyEvent( const css::accessibility::AccessibleEventObject& aEvent ) override;
// XVclContainerListener
virtual void SAL_CALL elementInserted( const css::container::ContainerEvent& Event ) override;
virtual void SAL_CALL elementRemoved( const css::container::ContainerEvent& Event ) override;
virtual void SAL_CALL elementReplaced( const css::container::ContainerEvent& Event ) override;
/** Initialize a new shape. See the documentation of the base' constructor
for the reason of this method's existence.
*/
virtual void Init( ) override;
/// Create a name string that contains the accessible name.
virtual OUString
CreateAccessibleBaseName( ) override;
/** Create a unique name string that contains the accessible name. The
name consists of the base name and the index.
*/
virtual OUString
CreateAccessibleName( ) override;
/// Create a description string that contains the accessible description.
OUString CreateAccessibleDescription();
#ifdef DBG_UTIL
/// Set the specified state
virtual bool SetState( sal_Int16 _nState ) override;
#endif // DBG_UTIL
/// (safely) reads the given property from the model of the UNO control
OUString getControlModelStringProperty( const OUString& _rPropertyName ) const;
/// ensure that our control model exists(will be retrieved upon need only)
bool ensureControlModelAccess( );
/// ensures that we're listening for the given property if(and only if!) necessary
bool ensureListeningState( const bool _bCurrentlyListening, const bool _bNeedNewListening,
const OUString& _rPropertyName );
/// starts multiplexing the state changes of our aggregate context
void startStateMultiplexing( );
/// stops multiplexing the state changes of our aggregate context
void stopStateMultiplexing( );
/** adjusts our AccessibleRole, depending on the control type we're working for
<p>Only to be called during initialization</p>
*/
void adjustAccessibleRole( );
/** initializes composed states of the context
<p>Some of the states of our inner context need to be propagated to the "composed context", too
(such as "checked" for check boxes). At lifetime, this is done by multiplexing state changes,
at initialization time, this method is used.</p>
*/
void initializeComposedState( );
AccessibleControlShape(const AccessibleControlShape&) = delete;
AccessibleControlShape& operator= (const AccessibleControlShape&) = delete;
css::uno::Reference< css::beans::XPropertySet >
m_xControlModel;
css::uno::Reference< css::beans::XPropertySetInfo >
m_xModelPropsMeta; // cache this for performance reasons
css::uno::Reference< css::awt::XControl >
m_xUnoControl; // our UNO control
css::uno::WeakReference< css::accessibility::XAccessibleContext >
m_aControlContext; // the AccessibleContext of the control
css::uno::Reference< css::uno::XAggregation >
m_xControlContextProxy; // the proxy for "aggregating" the AccessibleContext of the control
css::uno::Reference< css::lang::XTypeProvider >
m_xControlContextTypeAccess; // cached interface of our aggregate
css::uno::Reference< css::lang::XComponent >
m_xControlContextComponent; // cached interface of our aggregate
rtl::Reference<::comphelper::OWrappedAccessibleChildrenManager>
m_pChildManager;
bool m_bListeningForName : 1; // are we currently listening for changes of the "Name" property?
bool m_bListeningForDesc : 1; // are we currently listening for changes of the "HelpText" property?
bool m_bMultiplexingStates : 1; // are we currently multiplexing state changes of the native context?
bool m_bDisposeNativeContext : 1; // do we need to dispose mxNativeContextComponent?
bool m_bWaitingForControl : 1; // if we are created before our control exists, we need to wait for it to appear ...
};
} // end of namespace accessibility
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
