blob: f5883b89a300bac38f618b60bd585b478bdd4ceb (
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
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
330
331
|
/*************************************************************************
*
* 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: interaction.hxx,v $
* $Revision: 1.7 $
*
* 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_DISPATCH_INTERACTION_HXX_
#define __FRAMEWORK_DISPATCH_INTERACTION_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <com/sun/star/task/XInteractionContinuation.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionApprove.hpp>
#include <com/sun/star/task/XInteractionDisapprove.hpp>
#include <com/sun/star/task/XInteractionRetry.hpp>
#include <com/sun/star/document/XInteractionFilterSelect.hpp>
#include <com/sun/star/document/NoSuchFilterRequest.hpp>
#include <com/sun/star/document/AmbigousFilterRequest.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
//_________________________________________________________________________________________________________________
// includes of other projects
//_________________________________________________________________________________________________________________
#include <rtl/ustring.hxx>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <fwedllapi.h>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// non exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// non exported definitions
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short base for continuation classes
@descr An interaction continuation could be used on XInteractionHandler/XInteractionRequest
to abort or react for it.
Base functionality is everytime the same - handler mark right continuation by calling
interface method "select()". User of interaction can detect it by testing c++ method "isSelected()"!
Superclasses can add additional interfaces or methods to support additional features ...
but selection of it is supported here!
@implements XInterface
XTypeProvider (supported by WeakImplHelper!)
XInteractionContinuation
@base WeakImplHelper1
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
template< class TContinuationType >
class ContinuationBase : public ::cppu::WeakImplHelper1< TContinuationType >
{
// c++ interface
public:
//---------------------------------------------------------------------------------------------------------
// initialize continuation with right start values
//---------------------------------------------------------------------------------------------------------
ContinuationBase()
: m_bSelected( sal_False )
{
}
//---------------------------------------------------------------------------------------------------------
// was continuation selected by handler?
//---------------------------------------------------------------------------------------------------------
sal_Bool isSelected() const
{
return m_bSelected;
}
//---------------------------------------------------------------------------------------------------------
// make using more then once possible
//---------------------------------------------------------------------------------------------------------
void reset()
{
m_bSelected = sal_False;
}
// uno interface
public:
//---------------------------------------------------------------------------------------------------------
// called by handler to mark continuation as the only possible solution for started interaction
//---------------------------------------------------------------------------------------------------------
virtual void SAL_CALL select() throw( ::com::sun::star::uno::RuntimeException )
{
m_bSelected = sal_True;
}
// member
private:
sal_Bool m_bSelected;
}; // class ContinuationBase
//template class FWE_DLLEXPORT ContinuationBase<typename com::sun::star::task::XInteractionApprove>;
/*-************************************************************************************************************//**
@short declaration of some simple continuations
@descr These derived classes implements some simple continuations, which doesnt need and additional
interfaces or methods. Her selected state is the only neccessary feature. User of it can
distinguish by type between different functionality!
@implements -
@base ContinuationBase
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
typedef ContinuationBase< ::com::sun::star::task::XInteractionAbort > ContinuationAbort;
typedef ContinuationBase< ::com::sun::star::task::XInteractionApprove > ContinuationApprove;
typedef ContinuationBase< ::com::sun::star::task::XInteractionDisapprove > ContinuationDisapprove;
typedef ContinuationBase< ::com::sun::star::task::XInteractionRetry > ContinuationRetry;
/*-************************************************************************************************************//**
@short declaration of special continuation for filter selection
@descr Sometimes filter detection during loading document failed. Then we need a possibility
to ask user for his decision. These continuation transport selected filter by user to
code user of interaction.
@attention This implementation could be used one times only. We don't support a resetable continuation yet!
Why? Normaly interaction should show a filter selection dialog and ask user for his decision.
He can select any filter - then instances of these class will be called by handler ... or user
close dialog without any selection. Then another continuation should be slected by handler to
abort continuations ... Retrying isn't very usefull here ... I think.
@implements XInteractionFilterSelect
@base ImplInheritanceHelper1
ContinuationBase
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
class FWE_DLLPUBLIC ContinuationFilterSelect : public ContinuationBase< ::com::sun::star::document::XInteractionFilterSelect >
{
// c++ interface
public:
ContinuationFilterSelect();
// uno interface
public:
virtual void SAL_CALL setFilter( const ::rtl::OUString& sFilter ) throw( ::com::sun::star::uno::RuntimeException );
virtual ::rtl::OUString SAL_CALL getFilter( ) throw( ::com::sun::star::uno::RuntimeException );
// member
private:
::rtl::OUString m_sFilter;
}; // class ContinuationFilterSelect
/*-************************************************************************************************************//**
@short special request for interaction to ask user for right filter
@descr These helper can be used to ask user for right filter, if filter detection failed.
It capsulate communication with any interaction handler and supports an easy
access on interaction results for user of these class.
Use it and forget complex mechanism of interaction ...
@example RequestFilterSelect* pRequest = new RequestFilterSelect;
Reference< XInteractionRequest > xRequest ( pRequest );
xInteractionHandler->handle( xRequest );
if( ! pRequest.isAbort() )
{
OUString sFilter = pRequest->getFilter();
}
@implements XInteractionRequest
@base WeakImplHelper1
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
class FWE_DLLPUBLIC RequestFilterSelect : public ::cppu::WeakImplHelper1< ::com::sun::star::task::XInteractionRequest >
{
// c++ interface
public:
RequestFilterSelect( const ::rtl::OUString& sURL );
sal_Bool isAbort () const;
::rtl::OUString getFilter() const;
// uno interface
public:
virtual ::com::sun::star::uno::Any SAL_CALL getRequest () throw( ::com::sun::star::uno::RuntimeException );
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( ::com::sun::star::uno::RuntimeException );
// member
private:
::com::sun::star::uno::Any m_aRequest ;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > m_lContinuations;
ContinuationAbort* m_pAbort ;
ContinuationFilterSelect* m_pFilter ;
}; // class RequestFilterSelect
/*-************************************************************************************************************//**
@short special request for interaction
@descr User must decide between a preselected and another detected filter.
It capsulate communication with any interaction handler and supports an easy
access on interaction results for user of these class.
@implements XInteractionRequest
@base WeakImplHelper1
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
class FWE_DLLPUBLIC RequestAmbigousFilter : public ::cppu::WeakImplHelper1< ::com::sun::star::task::XInteractionRequest >
{
// c++ interface
public:
RequestAmbigousFilter( const ::rtl::OUString& sURL ,
const ::rtl::OUString& sSelectedFilter ,
const ::rtl::OUString& sDetectedFilter );
sal_Bool isAbort () const;
::rtl::OUString getFilter() const;
// uno interface
public:
virtual ::com::sun::star::uno::Any SAL_CALL getRequest () throw( ::com::sun::star::uno::RuntimeException );
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations() throw( ::com::sun::star::uno::RuntimeException );
// member
private:
::com::sun::star::uno::Any m_aRequest ;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > m_lContinuations;
ContinuationAbort* m_pAbort ;
ContinuationFilterSelect* m_pFilter ;
}; // class RequestFilterSelect
/*-************************************************************************************************************//**
@short special request for interaction
@descr User must decide between a preselected and another detected filter.
It capsulate communication with any interaction handler and supports an easy
access on interaction results for user of these class.
@implements XInteractionRequest
@base WeakImplHelper1
@devstatus ready to use
@threadsafe no (used on once position only!)
*//*-*************************************************************************************************************/
class FWE_DLLPUBLIC InteractionRequest : public ::cppu::WeakImplHelper1< ::com::sun::star::task::XInteractionRequest >
{
// c++ interface
public:
InteractionRequest( const ::com::sun::star::uno::Any& aRequest ,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > lContinuations )
{
m_aRequest = aRequest ;
m_lContinuations = lContinuations;
}
// uno interface
public:
virtual ::com::sun::star::uno::Any SAL_CALL getRequest()
throw( ::com::sun::star::uno::RuntimeException )
{
return m_aRequest;
}
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations()
throw( ::com::sun::star::uno::RuntimeException )
{
return m_lContinuations;
}
// member
private:
::com::sun::star::uno::Any m_aRequest ;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > m_lContinuations;
}; // class RequestFilterSelect
} // namespace framework
#endif // #define __FRAMEWORK_DISPATCH_INTERACTION_HXX_
|
