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
|
/*************************************************************************
*
* 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: formcontrolling.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 SVX_FORMCONTROLLING_HXX
#define SVX_FORMCONTROLLING_HXX
#include <com/sun/star/form/XFormController.hpp>
#include <com/sun/star/form/XForm.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/form/runtime/FeatureState.hpp>
#include <com/sun/star/form/runtime/XFormOperations.hpp>
#include <com/sun/star/sdb/XSQLErrorListener.hpp>
#include <cppuhelper/implbase2.hxx>
#include <comphelper/componentcontext.hxx>
#include <vector>
//........................................................................
namespace svx
{
//........................................................................
//====================================================================
//= FeatureSlotTranslation
//====================================================================
class FeatureSlotTranslation
{
public:
/// retrieves the feature id for a given feature URL
static sal_Int32 getControllerFeatureSlotIdForURL( const ::rtl::OUString& _rMainURL );
/// retrieves the feature URL for a given feature id
static ::rtl::OUString getControllerFeatureURLForSlotId( sal_Int32 _nSlotId );
/// determines whether the given URL is a controller feature URL
static sal_Bool isFeatureURL( const ::rtl::OUString& _rMainURL );
/// retrieves the css.form.runtime.FormFeature ID for a given slot ID
static sal_Int16 getFormFeatureForSlotId( sal_Int32 _nSlotId );
/// retrieves the slot id for a given css.form.runtime.FormFeature ID
static sal_Int32 getSlotIdForFormFeature( sal_Int16 _nFormFeature );
};
//====================================================================
//= IControllerFeatureInvalidation
//====================================================================
class IControllerFeatureInvalidation
{
public:
/** invalidates the given features
Invalidation means that any user interface representation (such as toolbox buttons), or
any dispatches associated with the features in question are potentially out-of-date, and
need to be updated
@param _rFeatures
Ids of the features to be invalidated.
*/
virtual void invalidateFeatures( const ::std::vector< sal_Int32 >& _rFeatures ) = 0;
};
//====================================================================
//= ControllerFeatures
//====================================================================
class FormControllerHelper;
/** easier access to an FormControllerHelper instance
*/
class ControllerFeatures
{
protected:
::comphelper::ComponentContext m_aContext;
IControllerFeatureInvalidation* m_pInvalidationCallback; // necessary as long as m_pImpl is not yet constructed
FormControllerHelper* m_pImpl;
public:
/** standard ctor
The instance is not functional until <method>assign</method> is used.
@param _rxORB
a multi service factory for creating various needed components
@param _pInvalidationCallback
the callback for invalidating feature states
*/
ControllerFeatures(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
IControllerFeatureInvalidation* _pInvalidationCallback
);
/** constructs the instance from a <type scope="com::sun::star::form">XFormController<type> instance
@param _rxORB
a multi service factory for creating various needed components
@param _rxController
The form controller which the helper should be responsible for. Must not
be <NULL/>, and must have a valid model (form).
@param _pInvalidationCallback
the callback for invalidating feature states
*/
ControllerFeatures(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
const ::com::sun::star::uno::Reference< ::com::sun::star::form::XFormController >& _rxController,
IControllerFeatureInvalidation* _pInvalidationCallback
);
/** constructs the helper form a <type scope="com::sun::star::form">XForm<type> instance
Any functionality which depends on a controller will not be available.
@param _rxORB
a multi service factory for creating various needed components
@param _rxForm
The form which the helper should be responsible for. Must not be <NULL/>.
@param _pInvalidationCallback
the callback for invalidating feature states
*/
ControllerFeatures(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
const ::com::sun::star::uno::Reference< ::com::sun::star::form::XForm >& _rxForm,
IControllerFeatureInvalidation* _pInvalidationCallback
);
/// dtor
~ControllerFeatures();
/// checks whether the instance is properly assigned to a form and/or controller
inline bool isAssigned( ) const { return m_pImpl != NULL; }
/** assign to a controller
*/
void assign(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::XFormController >& _rxController
);
/** assign to a controller
*/
void assign(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::XForm >& _rxForm
);
/// clears the instance so that it cannot be used afterwards
void dispose();
// access to the instance which implements the functionality. Not to be used when not assigned
inline const FormControllerHelper* operator->() const { return m_pImpl; }
inline FormControllerHelper* operator->() { return m_pImpl; }
inline const FormControllerHelper& operator*() const { return *m_pImpl; }
inline FormControllerHelper& operator*() { return *m_pImpl; }
};
//====================================================================
//= FormControllerHelper
//====================================================================
typedef ::cppu::WeakImplHelper2 < ::com::sun::star::form::runtime::XFeatureInvalidation
, ::com::sun::star::sdb::XSQLErrorListener
> FormControllerHelper_Base;
/** is a helper class which manages form controller functionality (such as moveNext etc.).
<p>The class helps implementing form controller functionality, by providing
methods to determine the state of, and execute, various common form features.<br/>
A <em>feature</em> is for instance moving the form associated with the controller
to a certain position, or reloading the form, and so on.</p>
*/
class FormControllerHelper : public FormControllerHelper_Base
{
protected:
::comphelper::ComponentContext m_aContext;
IControllerFeatureInvalidation* m_pInvalidationCallback;
::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >
m_xFormOperations;
::com::sun::star::uno::Any m_aOperationError;
public:
/** constructs the helper from a <type scope="com::sun::star::form">XFormController<type> instance
@param _rContext
the context the component lives in
@param _rxController
The form controller which the helper should be responsible for. Must not
be <NULL/>, and must have a valid model (form).
@param _pInvalidationCallback
the callback for invalidating feature states
*/
FormControllerHelper(
const ::comphelper::ComponentContext& _rContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::form::XFormController >& _rxController,
IControllerFeatureInvalidation* _pInvalidationCallback
);
/** constructs the helper form a <type scope="com::sun::star::form">XForm<type> instance
Any functionality which depends on a controller will not be available.
@param _rContext
the context the component lives in
@param _rxForm
The form which the helper should be responsible for. Must not be <NULL/>.
@param _pInvalidationCallback
the callback for invalidating feature states
*/
FormControllerHelper(
const ::comphelper::ComponentContext& _rContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::form::XForm >& _rxForm,
IControllerFeatureInvalidation* _pInvalidationCallback
);
// forwards to the XFormOperations implementation
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet >
getCursor() const;
void getState(
sal_Int32 _nSlotId,
::com::sun::star::form::runtime::FeatureState& _out_rState
) const;
sal_Bool isEnabled( sal_Int32 _nSlotId ) const;
void execute( sal_Int32 _nSlotId ) const;
void execute( sal_Int32 _nSlotId, const ::rtl::OUString& _rParamName, const ::com::sun::star::uno::Any& _rParamValue ) const;
sal_Bool commitCurrentRecord() const;
sal_Bool commitCurrentControl( ) const;
sal_Bool isInsertionRow() const;
sal_Bool isModifiedRow() const;
bool moveLeft( ) const;
bool moveRight( ) const;
bool canDoFormFilter() const;
/** disposes this instance.
After this method has been called, the instance is not functional anymore
*/
void dispose();
const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >&
getFormOperations() const { return m_xFormOperations; }
protected:
/// dtor
~FormControllerHelper();
// XFeatureInvalidation
virtual void SAL_CALL invalidateFeatures( const ::com::sun::star::uno::Sequence< ::sal_Int16 >& Features ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL invalidateAllFeatures() throw (::com::sun::star::uno::RuntimeException);
// XSQLErrorListener
virtual void SAL_CALL errorOccured( const ::com::sun::star::sdb::SQLErrorEvent& _Event ) throw (::com::sun::star::uno::RuntimeException);
// XEventListener
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
private:
enum FormOperation { EXECUTE, EXECUTE_ARGS, COMMIT_CONTROL, COMMIT_RECORD };
bool impl_operateForm_nothrow(
const FormOperation _eWhat,
const sal_Int16 _nFeature, /* ignore for COMMIT_* */
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& _rArguments /* ignore except for EXECUTE_ARGS */
) const;
bool impl_operateForm_nothrow( const FormOperation _eWhat ) const
{
return impl_operateForm_nothrow( _eWhat, 0, ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >() );
}
bool impl_operateForm_nothrow( const sal_Int16 _nFeature ) const
{
return impl_operateForm_nothrow( EXECUTE, _nFeature, ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >() );
}
private:
FormControllerHelper(); // never implemented
FormControllerHelper( const FormControllerHelper& ); // never implemented
FormControllerHelper& operator=( const FormControllerHelper& ); // never implemented
};
//........................................................................
} // namespace svx
//........................................................................
#endif // SVX_FORMCONTROLLING_HXX
|
