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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVX_SOURCE_INC_FORMCONTROLLING_HXX
#define INCLUDED_SVX_SOURCE_INC_FORMCONTROLLING_HXX
#include <com/sun/star/form/runtime/XFormController.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/implbase.hxx>
#include <rtl/ref.hxx>
#include <vector>
namespace svx
{
class FeatureSlotTranslation
{
public:
/// retrieves the feature id for a given feature URL
static sal_Int32 getControllerFeatureSlotIdForURL( const 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 );
};
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;
protected:
~IControllerFeatureInvalidation() {}
};
class FormControllerHelper;
/** easier access to a FormControllerHelper instance
*/
class ControllerFeatures final
{
IControllerFeatureInvalidation* m_pInvalidationCallback; // necessary as long as m_pImpl is not yet constructed
rtl::Reference<FormControllerHelper> m_pImpl;
public:
/** standard ctor
The instance is not functional until <method>assign</method> is used.
@param _pInvalidationCallback
the callback for invalidating feature states
*/
ControllerFeatures(
IControllerFeatureInvalidation* _pInvalidationCallback
);
/** constructs the instance from a <type scope="css::form::runtime">XFormController<type> instance
@param _rxController
The form controller which the helper should be responsible for. Must not
be <NULL/>, and must have a valid model (form).
*/
ControllerFeatures(
const css::uno::Reference< css::form::runtime::XFormController >& _rxController
);
/// dtor
~ControllerFeatures();
/// checks whether the instance is properly assigned to a form and/or controller
bool isAssigned( ) const { return m_pImpl != nullptr; }
/** assign to a controller
*/
void assign(
const css::uno::Reference< css::form::runtime::XFormController >& _rxController
);
/// 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
const FormControllerHelper* operator->() const { return m_pImpl.get(); }
FormControllerHelper* operator->() { return m_pImpl.get(); }
};
//= FormControllerHelper
typedef ::cppu::WeakImplHelper < css::form::runtime::XFeatureInvalidation
, css::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 final : public FormControllerHelper_Base
{
IControllerFeatureInvalidation* m_pInvalidationCallback;
css::uno::Reference< css::form::runtime::XFormOperations >
m_xFormOperations;
css::uno::Any m_aOperationError;
public:
/** constructs the helper from a <type scope="css::form::runtime">XFormController<type> instance
@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 css::uno::Reference< css::form::runtime::XFormController >& _rxController,
IControllerFeatureInvalidation* _pInvalidationCallback
);
// forwards to the XFormOperations implementation
css::uno::Reference< css::sdbc::XRowSet >
getCursor() const;
void getState(
sal_Int32 _nSlotId,
css::form::runtime::FeatureState& _out_rState
) const;
bool isEnabled( sal_Int32 _nSlotId ) const;
void execute( sal_Int32 _nSlotId ) const;
void execute( sal_Int32 _nSlotId, const OUString& _rParamName, const css::uno::Any& _rParamValue ) const;
bool commitCurrentRecord() const;
bool commitCurrentControl( ) const;
bool isInsertionRow() const;
bool isModifiedRow() const;
bool canDoFormFilter() const;
/** disposes this instance.
After this method has been called, the instance is not functional anymore
*/
void dispose();
private:
/// dtor
virtual ~FormControllerHelper() override;
// XFeatureInvalidation
virtual void SAL_CALL invalidateFeatures( const css::uno::Sequence< ::sal_Int16 >& Features ) override;
virtual void SAL_CALL invalidateAllFeatures() override;
// XSQLErrorListener
virtual void SAL_CALL errorOccured( const css::sdb::SQLErrorEvent& Event ) override;
// XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
enum FormOperation { EXECUTE, EXECUTE_ARGS, COMMIT_CONTROL, COMMIT_RECORD };
bool impl_operateForm_nothrow(
const FormOperation _eWhat,
const sal_Int16 _nFeature, /* ignore for COMMIT_* */
const css::uno::Sequence< css::beans::NamedValue >& _rArguments /* ignore except for EXECUTE_ARGS */
) const;
bool impl_operateForm_nothrow( const FormOperation _eWhat ) const
{
return impl_operateForm_nothrow( _eWhat, 0, css::uno::Sequence< css::beans::NamedValue >() );
}
private:
FormControllerHelper( const FormControllerHelper& ) = delete;
FormControllerHelper& operator=( const FormControllerHelper& ) = delete;
};
}
#endif // INCLUDED_SVX_SOURCE_INC_FORMCONTROLLING_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
