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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: preventduplicateinteraction.hxx,v $
* $Revision: 1.5 $
*
* 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 __FRAMEWORK_INTERACTION_PREVENTDUPLICATEINTERACTION_HXX_
#define __FRAMEWORK_INTERACTION_PREVENTDUPLICATEINTERACTION_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <vector>
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/task/XInteractionHandler.hpp>
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#include <cppuhelper/implbase1.hxx>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
#ifdef css
#error "Conflict during define of namespace alias ..."
#else
#define css ::com::sun::star
#endif
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
/**
@short Prevent us from showing the same interaction more then once during
the same transaction.
@descr Every interaction provided to this helper will be safed ... handled by the internal
used UUIInteractionHandler (!) and never be handled a second time!
On the other side there exists some interactions, which allow a retry.
So this helper allow to set a list of interactions combined with a retry value.
*/
struct ThreadHelpBase2
{
public:
mutable ::osl::Mutex m_aLock;
};
class PreventDuplicateInteraction : private ThreadHelpBase2
,public ::cppu::WeakImplHelper1< css::task::XInteractionHandler >
{
//_____________________________________
// structs, types etcp.
public:
struct InteractionInfo
{
public:
/// describe the interaction.
css::uno::Type m_aInteraction;
/// after max count was reached this interaction will be blocked.
sal_Int32 m_nMaxCount;
/// count how often this interaction was called.
sal_Int32 m_nCallCount;
/** hold the last intercepted request (matching the set interaction type) alive
so it can be used for further checks */
css::uno::Reference< css::task::XInteractionRequest > m_xRequest;
public:
InteractionInfo(const css::uno::Type& aInteraction,
sal_Int32 nMaxCount )
: m_aInteraction(aInteraction)
, m_nMaxCount (nMaxCount )
, m_nCallCount (0 )
{}
InteractionInfo(const InteractionInfo& aCopy)
: m_aInteraction(aCopy.m_aInteraction)
, m_nMaxCount (aCopy.m_nMaxCount )
, m_nCallCount (aCopy.m_nCallCount )
, m_xRequest (aCopy.m_xRequest )
{}
};
typedef ::std::vector< InteractionInfo > InteractionList;
//_____________________________________
// member
private:
/// Used to create needed uno services at runtime.
css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
/** The outside interaction handler, which is used to handle every incoming interaction,
if it's not blocked. */
css::uno::Reference< css::task::XInteractionHandler > m_xHandler;
/** This list describe which and how incoming interactions must be handled.
Further it contains all collected informations after this interaction
object was used.*/
InteractionList m_lInteractionRules;
//_____________________________________
// uno interface
public:
//_________________________________
/**
@interface XInteractionHandler
@short called from outside to handle a problem
@descr We filter the incoming interactions. some of them
will be forwarded to the generic UI interaction handler.
So we must not implement it twice. Some other ones
will be aborted only.
@threadsafe yes
*/
virtual void SAL_CALL handle(const css::uno::Reference< css::task::XInteractionRequest >& xRequest)
throw(css::uno::RuntimeException);
//_____________________________________
// c++ interface
public:
//_________________________________
/**
@short ctor to guarantee right initialized instances of this class
@descr It uses the given uno service manager to create the global
generic UI interaction handler for later internal using.
@param xSMGR
uno service manager for creating services internaly
@threadsafe not neccessary
*/
PreventDuplicateInteraction(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR);
//_________________________________
/**
@short dtor to free used memory.
*/
virtual ~PreventDuplicateInteraction();
//_________________________________
/**
@short set the outside interaction handler, which must be used internaly
if the interaction will not be blocked by the set list of rules.
@note This overwrites the settings of e.g. useDefaultUUIHandler()!
@param xHandler
the new interaction handler
*/
virtual void setHandler(const css::uno::Reference< css::task::XInteractionHandler >& xHandler);
//_________________________________
/**
@short instead of setting an outside interaction handler, this method
make sure the default UUI interaction handler of the office is used.
@note This overwrites the settings of e.g. setHandler()!
*/
virtual void useDefaultUUIHandler();
//_________________________________
/**
@short add a new interaction to the list of interactions, which
must be handled by this helper.
@descr This method must be called immediatly after a new instance of this helper was
created. Without such list of InteractionRules, this instances does nothing!
On the other side there is no possibility to remove rules.
So the same instance cant be used within different transactions.
It's a OneWay-object .-)
@param aInteractionInfo
describe the type of interaction, hos often it can be called etcpp.
@threadsafe yes
*/
virtual void addInteractionRule(const PreventDuplicateInteraction::InteractionInfo& aInteractionInfo);
//_________________________________
/**
@short return the info struct for the specified interaction.
@param aInteraction
specify the interaction.
@param pReturn
provides informations about:
- the count how often this interaction was handled during the
lifetime of this helper.
- the interaction itself, so it can be analyzed further
@return [boolean]
TRUE if the queried interaction could be found.
FALSE otherwise.
@threadsafe yes
*/
virtual sal_Bool getInteractionInfo(const css::uno::Type& aInteraction,
PreventDuplicateInteraction::InteractionInfo* pReturn ) const;
};
#undef css
} // namespace framework
#endif // #ifndef __FRAMEWORK_INTERACTION_PREVENTDUPLICATEINTERACTION_HXX_
|
