blob: 46fa906260f0b341405e60f55efafaefcaf1f4d5 (
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
|
/*************************************************************************
*
* 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: interactionrequest.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 CONFIGMGR_INTERACTIONREQUEST_HXX
#define CONFIGMGR_INTERACTIONREQUEST_HXX
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionRetry.hpp>
#include <com/sun/star/task/XInteractionApprove.hpp>
#include <com/sun/star/task/XInteractionDisapprove.hpp>
#include <cppuhelper/implbase1.hxx>
namespace configmgr {
namespace apihelper {
namespace uno = com::sun::star::uno;
namespace task = com::sun::star::task;
//============================================================================
/**
* This class implements the interface XInteractionRequest. Instances can
* be passed directly to XInteractionHandler::handle(...). Each interaction
* request contains an exception describing the error and a number of
* interaction continuations describing the possible "answers" for the request.
* After the request was passed to XInteractionHandler::handle(...) the method
* getSelection() returns the continuation choosen by the interaction handler.
*
* The typical usage of this class would be:
*
* 1) Create exception object that shall be handled by the interaction handler.
* 2) Create InteractionRequest, supply exception as ctor parameter
* 3) Create continuations needed and add them to a sequence
* 4) Supply the continuations to the InteractionRequest by calling
* setContinuations(...)
*
* This class can also be used as base class for more specialized requests,
* like authentication requests.
*/
class InteractionRequest : public cppu::WeakImplHelper1<com::sun::star::task::XInteractionRequest>
{
struct Impl;
Impl * m_pImpl;
protected:
virtual ~InteractionRequest();
public:
/**
* Constructor.
*
* @param rRequest is the exception describing the error.
*/
InteractionRequest( const com::sun::star::uno::Any & rRequest );
/**
* This method sets the continuations for the request.
*
* @param rContinuations contains the possible continuations.
*/
void setContinuations(
const uno::Sequence< uno::Reference< task::XInteractionContinuation > > &
rContinuations );
// XInteractionRequest
virtual uno::Any SAL_CALL
getRequest()
throw( uno::RuntimeException );
virtual uno::Sequence< uno::Reference< task::XInteractionContinuation > > SAL_CALL
getContinuations()
throw( com::sun::star::uno::RuntimeException );
// Non-interface methods.
/**
* After passing this request to XInteractionHandler::handle, this method
* returns the continuation that was choosen by the interaction handler.
*
* @return the continuation choosen by an interaction handler or an empty
* reference, if the request was not (yet) handled.
*/
uno::Reference< task::XInteractionContinuation > getSelection() const;
/**
* This method sets a continuation for the request. It also can be used
* to reset the continuation set by a previous XInteractionHandler::handle
* call in order to use this request object more then once.
*
* @param rxSelection is the interaction continuation to activate for
* the request or an empty reference in order to reset the
* current selection.
*/
void setSelection(
const uno::Reference< task::XInteractionContinuation > & rxSelection );
};
//============================================================================
/**
* This template class implements a simple standard interaction continuation
* interface provided as template parameter. Classes instantiated from this
* template work together with class InteractionRequest.
* Instances of such a class can be passed along with an interaction request
* to indicate the possiblity to continue the operation that caused the request
* as indicated by the interface.
*/
template <class XThisContinuation >
class InteractionContinuation : public cppu::WeakImplHelper1< XThisContinuation >
{
InteractionRequest * m_pRequest;
public:
InteractionContinuation( InteractionRequest * pRequest )
: m_pRequest( pRequest ) {}
// XInteractionContinuation
/**
* This method marks this continuation as "selected" at the request it
* belongs to.
*
* Derived classes must implement their XInteractionContinuation::select()
* method the way that they call this method.
*/
virtual void SAL_CALL select()
throw( com::sun::star::uno::RuntimeException );
};
//============================================================================
template <class XThisContinuation >
void SAL_CALL InteractionContinuation< XThisContinuation >::select()
throw( com::sun::star::uno::RuntimeException )
{
m_pRequest->setSelection(this);
}
//============================================================================
} // namespace apihelper
} // namespace configmgr
#endif /* !CONFIGMGR_INTERACTIONREQUEST_HXX */
|
