blob: ec316f2498bb0d60c20cb839a2f3b1e6c1b3094a (
plain)
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
|
/* -*- 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_ACCESSIBLESHAPETREEINFO_HXX
#define INCLUDED_SVX_ACCESSIBLESHAPETREEINFO_HXX
#include <com/sun/star/accessibility/XAccessibleComponent.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/document/XEventBroadcaster.hpp>
#include <com/sun/star/frame/XController.hpp>
#include <svx/IAccessibleViewForwarder.hxx>
#include <svx/svxdllapi.h>
class SdrView;
namespace vcl { class Window; }
namespace accessibility {
/** This class bundles all information that is passed down the tree of
accessible shapes so that each shape has access to that info.
There are basically four members that can be set and queried:
<ul>
<li>The model broadcaster is used for getting notified about shape
changes. Using this broadcaster makes in unnecessary to register at
each shape separately.</li>
<li>The view forwarder is responsible for transformation between
coordinate systems and for providing the visible area both with respect
to a specific window.</li>
<li>The SdrView is used for creating accessible edit engines.</li>
<li>The Window is used for creating accessible edit engines.</li>
</ul>
*/
class SVX_DLLPUBLIC AccessibleShapeTreeInfo
{
public:
/** Use this constructor to create an empty object that is filled later
with more meaningfull data.
*/
AccessibleShapeTreeInfo (void);
/** Create a copy of the given shape info.
@param rInfo
The shape tree info object to copy.
*/
AccessibleShapeTreeInfo (const AccessibleShapeTreeInfo& rInfo);
~AccessibleShapeTreeInfo (void);
AccessibleShapeTreeInfo& operator= (const AccessibleShapeTreeInfo& rInfo);
/** Deprecated. Don't use this method.
*/
void SetDocumentWindow (const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleComponent>& rxViewWindow);
/** Deprecated. Don't use this method.
*/
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleComponent>
GetDocumentWindow (void) const { return mxDocumentWindow;}
/** Deprecated. Use the correctly named SetModelBroadcaster method
instead.
*/
void SetControllerBroadcaster (const ::com::sun::star::uno::Reference<
::com::sun::star::document::XEventBroadcaster>& rxControllerBroadcaster);
/** Deprecated. Use the correctly named GetModelBroadcaster method
instead.
*/
::com::sun::star::uno::Reference<
::com::sun::star::document::XEventBroadcaster>
GetControllerBroadcaster (void) const { return mxModelBroadcaster;}
/** Set a new broadcaster that sends events indicating shape changes.
The broadcaster usually is or belongs to a document model.
@param rxModelBroadcaster
The new broadcaster. It replaces the current one. An empty
reference may be passed to unset the broadcaster
*/
void SetModelBroadcaster (const ::com::sun::star::uno::Reference<
::com::sun::star::document::XEventBroadcaster>& rxModelBroadcaster);
/** Return the current model broadcaster.
@return
The returned reference may be empty if the broadcaster has not
been set or has been set to an empty reference.
*/
::com::sun::star::uno::Reference<
::com::sun::star::document::XEventBroadcaster>
GetModelBroadcaster (void) const { return mxModelBroadcaster;}
/** Set the view that will be used to construct SvxTextEditSources which
in turn are used to create accessible edit engines.
@param pView
The new SdrView that replaces the current one. A NULL pointer
may be passed to unset the view.
*/
void SetSdrView (SdrView* pView);
/** Return the current SdrView.
@return
The returned value may be NULL.
*/
SdrView* GetSdrView (void) const { return mpView;}
/** Set a new controller. This will usually but not necessarily
correspond to the SdrView.
@param rxController
The new controller that replaces the current one. An empty
reference may be passed to unset the controller.
*/
void SetController (const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XController>& rxController);
/** Return the currently set controller.
@return
The reference to the currently set controller may be empty.
*/
::com::sun::star::uno::Reference<
::com::sun::star::frame::XController>
GetController (void) const { return mxController;}
/** Set the window that is used to construct SvxTextEditSources which in
turn is used to create accessible edit engines.
*/
void SetWindow (vcl::Window* pWindow);
/** Return the current Window.
@return
The returned value may be NULL.
*/
vcl::Window* GetWindow (void) const { return mpWindow;}
/** The view forwarder allows the transformation between internal
and pixel coordinates and can be asked for the visible area.
@param pViewForwarder
This view forwarder replaces the current one.
*/
void SetViewForwarder (const IAccessibleViewForwarder* pViewForwarder);
/** Return the current view forwarder.
@return
The returned pointer may be NULL.
*/
const IAccessibleViewForwarder* GetViewForwarder (void) const { return mpViewForwarder;}
private:
/** Deprecated.
*/
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleComponent> mxDocumentWindow;
/** this broadcaster sends events indicating shape changes.
The broadcaster usually is or belongs to a document model.
This once was named mxControllerBroadcaster.
*/
::com::sun::star::uno::Reference<
::com::sun::star::document::XEventBroadcaster> mxModelBroadcaster;
/** This view is necessary to construct an SvxTextEditSource which in
turn is used to create an accessible edit engine.
*/
SdrView* mpView;
/** The controller is used e.g. for obtaining the selected shapes.
*/
::com::sun::star::uno::Reference<
::com::sun::star::frame::XController> mxController;
/** This window is necessary to construct an SvxTextEditSource which in
turn is used to create an accessible edit engine.
*/
vcl::Window* mpWindow;
/** The view forwarder allows the transformation between internal
and pixel coordinates and can be asked for the visible area.
*/
const IAccessibleViewForwarder* mpViewForwarder;
};
} // end of namespace accessibility
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
