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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SVTOOLS_UNOEVENT_HXX_
#define _SVTOOLS_UNOEVENT_HXX_
#include "svtools/svtdllapi.h"
#include <com/sun/star/container/XNameReplace.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/uno/XInterface.hpp>
#include <cppuhelper/implbase2.hxx>
class SvxMacroTableDtor;
class SvxMacroItem;
class SvxMacro;
/** SvEventDescription: Description of a single event.
mnEvent is the id used by SvxMacroItem
mpEventName is the api name for this event
the last event in an array is indicated by mnEvent && mpEventName == 0
*/
struct SvEventDescription
{
sal_uInt16 mnEvent;
const sal_Char* mpEventName;
};
/**
* SvBaseEventDescriptor: Abstract class that implements the basics
* of an XNameReplace that is delivered by the
* XEventsSupplier::getEvents() method.
*
* The functionality this class provides is:
* 1) Which elements are in the XNameReplace?
* 2) Mapping from Api names to item IDs.
* 3) conversion from SvxMacroItem to Any and vice versa.
*
* All details of how to actually get and set SvxMacroItem(s) have to
* be supplied by the base class.
*/
class SVT_DLLPUBLIC SvBaseEventDescriptor : public cppu::WeakImplHelper2
<
::com::sun::star::container::XNameReplace,
::com::sun::star::lang::XServiceInfo
>
{
const ::rtl::OUString sEventType;
const ::rtl::OUString sMacroName;
const ::rtl::OUString sLibrary;
const ::rtl::OUString sStarBasic;
const ::rtl::OUString sJavaScript;
const ::rtl::OUString sScript;
const ::rtl::OUString sNone;
/// name of own service
const ::rtl::OUString sServiceName;
protected:
const ::rtl::OUString sEmpty;
/// last element is 0, 0
const SvEventDescription* mpSupportedMacroItems;
sal_Int16 mnMacroItems;
public:
SvBaseEventDescriptor(const SvEventDescription* pSupportedMacroItems);
virtual ~SvBaseEventDescriptor();
// XNameReplace
/// calls replaceByName(const sal_uInt16, const SvxMacro&)
virtual void SAL_CALL replaceByName(
const ::rtl::OUString& rName, /// API name of event
const ::com::sun::star::uno::Any& rElement ) /// event (PropertyValues)
throw(
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
// XNameAccess (via XNameReplace)
/// calls getByName(sal_uInt16)
virtual ::com::sun::star::uno::Any SAL_CALL getByName(
const ::rtl::OUString& rName ) /// API name of event
throw(
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
// XNameAxcess (via XNameReplace)
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
getElementNames()
throw(::com::sun::star::uno::RuntimeException);
// XNameAccess (via XNameReplace)
virtual sal_Bool SAL_CALL hasByName(
const ::rtl::OUString& rName )
throw(::com::sun::star::uno::RuntimeException);
// XElementAccess (via XNameReplace)
virtual ::com::sun::star::uno::Type SAL_CALL getElementType()
throw(::com::sun::star::uno::RuntimeException);
// XElementAccess (via XNameReplace)
virtual sal_Bool SAL_CALL hasElements()
throw(::com::sun::star::uno::RuntimeException);
// XServiceInfo
/// must be implemented in subclass
virtual rtl::OUString SAL_CALL getImplementationName(void)
throw( ::com::sun::star::uno::RuntimeException ) = 0;
// XServiceInfo
virtual sal_Bool SAL_CALL supportsService(const rtl::OUString& ServiceName)
throw( ::com::sun::star::uno::RuntimeException );
// XServiceInfo
virtual ::com::sun::star::uno::Sequence< rtl::OUString > SAL_CALL
getSupportedServiceNames(void)
throw( ::com::sun::star::uno::RuntimeException );
protected:
/// Must be implemented in subclass.
virtual void replaceByName(
const sal_uInt16 nEvent, /// item ID of event
const SvxMacro& rMacro) /// event (will be copied)
throw(
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException) = 0;
/// Must be implemented in subclass.
virtual void getByName(
SvxMacro& rMacro,
const sal_uInt16 nEvent )
throw(
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException) = 0;
/// convert an API event name to the event ID as used by SvxMacroItem
sal_uInt16 mapNameToEventID(const ::rtl::OUString& rName) const;
/// convert an event ID to an API event name
::rtl::OUString mapEventIDToName(sal_uInt16 nPoolID) const;
/// get the event ID for the name; return 0 if not supported
sal_uInt16 getMacroID(const ::rtl::OUString& rName) const;
/// create PropertyValues and Any from macro
void getAnyFromMacro(
::com::sun::star::uno::Any& aAny, // Any to be filled by Macro values
const SvxMacro& rMacro);
/// create macro from PropertyValues (in an Any)
void getMacroFromAny(
SvxMacro& aMacro, // reference to be filled by Any
const ::com::sun::star::uno::Any& rAny)
throw (
::com::sun::star::lang::IllegalArgumentException);
};
/**
* SvEventDescriptor: Implement the XNameReplace that is delivered by
* the XEventsSupplier::getEvents() method. The SvEventDescriptor has
* to be subclassed to implement the events for a specific
* objects. The subclass has to
* 1) supply the super class constructor with a list of known events (item IDs)
* 2) supply the super class constructor with a reference of it's parent object
* (to prevent destruction)
* 3) implement getItem() and setItem(...) methods.
*
* If no object is available to which the SvEventDescriptor can attach itself,
* the class SvDetachedEventDescriptor should be used.
*/
class SVT_DLLPUBLIC SvEventDescriptor : public SvBaseEventDescriptor
{
/// keep reference to parent to prevent it from being destroyed
::com::sun::star::uno::Reference<
::com::sun::star::uno::XInterface > xParentRef;
public:
SvEventDescriptor(::com::sun::star::uno::XInterface& rParent,
const SvEventDescription* pSupportedMacroItems);
virtual ~SvEventDescriptor();
protected:
using SvBaseEventDescriptor::replaceByName;
virtual void replaceByName(
const sal_uInt16 nEvent, /// item ID of event
const SvxMacro& rMacro) /// event (will be copied)
throw(
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
using SvBaseEventDescriptor::getByName;
virtual void getByName(
SvxMacro& rMacros, /// macro to be filled with values
const sal_uInt16 nEvent ) /// item ID of event
throw(
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
/// Get the SvxMacroItem from the parent.
/// must be implemented by subclass
virtual const SvxMacroItem& getMacroItem() = 0;
/// Set the SvxMacroItem at the parent.
/// must be implemented by subclass
virtual void setMacroItem(const SvxMacroItem& rItem) = 0;
/// Get the SvxMacroItem Which Id needed for the current application
/// must be implemented by subclass
virtual sal_uInt16 getMacroItemWhich() const = 0;
};
/**
* SvDetachedEventDescriptor:
*/
class SVT_DLLPUBLIC SvDetachedEventDescriptor : public SvBaseEventDescriptor
{
// the macros; aMacros[i] is the value for aSupportedMacroItemIDs[i]
SvxMacro** aMacros;
const ::rtl::OUString sImplName;
public:
SvDetachedEventDescriptor(const SvEventDescription* pSupportedMacroItems);
virtual ~SvDetachedEventDescriptor();
//XServiceInfo
virtual rtl::OUString SAL_CALL getImplementationName(void)
throw( ::com::sun::star::uno::RuntimeException );
protected:
sal_Int16 getIndex(const sal_uInt16 nID) const;
using SvBaseEventDescriptor::replaceByName;
virtual void replaceByName(
const sal_uInt16 nEvent, /// item ID of event
const SvxMacro& rMacro) /// event (will be copied)
throw(
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
using SvBaseEventDescriptor::getByName;
virtual void getByName(
SvxMacro& rMacro, /// macro to be filled
const sal_uInt16 nEvent ) /// item ID of event
throw(
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
/// do we have an event?
/// return sal_True: we have a macro for the event
/// return sal_False: no macro; getByName() will return an empty macro
/// IllegalArgumentException: the event is not supported
using SvBaseEventDescriptor::hasByName;
virtual sal_Bool hasByName(
const sal_uInt16 nEvent ) const /// item ID of event
throw(
::com::sun::star::lang::IllegalArgumentException);
};
class SVT_DLLPUBLIC SvMacroTableEventDescriptor : public SvDetachedEventDescriptor
{
public:
SvMacroTableEventDescriptor(const SvEventDescription* pSupportedMacroItems);
SvMacroTableEventDescriptor(const SvxMacroTableDtor& aFmt,
const SvEventDescription* pSupportedMacroItems);
virtual ~SvMacroTableEventDescriptor();
void copyMacrosFromTable(const SvxMacroTableDtor& aFmt);
void copyMacrosIntoTable(SvxMacroTableDtor& aFmt);
};
#endif
|
