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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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 FORMS_FORMOPERATIONS_HXX
#define FORMS_FORMOPERATIONS_HXX
/** === begin UNO includes === **/
#include <com/sun/star/form/runtime/XFormOperations.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/form/XForm.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/form/XLoadable.hpp>
#include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp>
#include <com/sun/star/util/XModifyListener.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
/** === end UNO includes === **/
#include <comphelper/componentcontext.hxx>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/compbase6.hxx>
//........................................................................
namespace frm
{
//........................................................................
//====================================================================
//= FormOperations
//====================================================================
typedef ::cppu::WeakComponentImplHelper6 < ::com::sun::star::form::runtime::XFormOperations
, ::com::sun::star::lang::XInitialization
, ::com::sun::star::lang::XServiceInfo
, ::com::sun::star::beans::XPropertyChangeListener
, ::com::sun::star::util::XModifyListener
, ::com::sun::star::sdbc::XRowSetListener
> FormOperations_Base;
class FormOperations :public ::cppu::BaseMutex
,public FormOperations_Base
{
public:
class MethodGuard;
private:
::comphelper::ComponentContext m_aContext;
::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormController > m_xController;
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet > m_xCursor;
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetUpdate > m_xUpdateCursor;
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > m_xCursorProperties;
::com::sun::star::uno::Reference< ::com::sun::star::form::XLoadable > m_xLoadableForm;
::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFeatureInvalidation >
m_xFeatureInvalidation;
mutable ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryComposer >
m_xParser;
bool m_bInitializedParser;
bool m_bActiveControlModified;
bool m_bConstructed;
#ifdef DBG_UTIL
mutable long
m_nMethodNestingLevel;
#endif
public:
FormOperations( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxContext );
// XServiceInfo - static versions
static ::rtl::OUString getImplementationName_Static( ) throw(::com::sun::star::uno::RuntimeException);
static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static( ) throw(::com::sun::star::uno::RuntimeException);
static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL
Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&);
struct MethodAccess { friend class MethodGuard; private: MethodAccess() { } };
inline void enterMethod( MethodAccess ) const
{
m_aMutex.acquire();
impl_checkDisposed_throw();
#ifdef DBG_UTIL
++m_nMethodNestingLevel;
#endif
}
inline void leaveMethod( MethodAccess ) const
{
m_aMutex.release();
#ifdef DBG_UTIL
--m_nMethodNestingLevel;
#endif
}
protected:
virtual ~FormOperations();
// XInitialization
virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
// XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw (::com::sun::star::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames( ) throw (::com::sun::star::uno::RuntimeException);
// XFormOperations
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet > SAL_CALL getCursor() throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetUpdate > SAL_CALL getUpdateCursor() throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormController > SAL_CALL getController() throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFeatureInvalidation > SAL_CALL getFeatureInvalidation() throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setFeatureInvalidation(const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFeatureInvalidation > & the_value) throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::form::runtime::FeatureState SAL_CALL getState(::sal_Int16 Feature) throw (::com::sun::star::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL isEnabled(::sal_Int16 Feature) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL execute(::sal_Int16 Feature) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::sdbc::SQLException, ::com::sun::star::lang::WrappedTargetException);
virtual void SAL_CALL executeWithArguments(::sal_Int16 Feature, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& Arguments) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::sdbc::SQLException, ::com::sun::star::lang::WrappedTargetException);
virtual ::sal_Bool SAL_CALL commitCurrentRecord(::sal_Bool & RecordInserted) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::sdbc::SQLException);
virtual ::sal_Bool SAL_CALL commitCurrentControl() throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::sdbc::SQLException);
virtual ::sal_Bool SAL_CALL isInsertionRow() throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::WrappedTargetException);
virtual ::sal_Bool SAL_CALL isModifiedRow() throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::WrappedTargetException);
// XRowSetListener
virtual void SAL_CALL cursorMoved( const ::com::sun::star::lang::EventObject& event ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL rowChanged( const ::com::sun::star::lang::EventObject& event ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL rowSetChanged( const ::com::sun::star::lang::EventObject& event ) throw (::com::sun::star::uno::RuntimeException);
// XModifyListener
virtual void SAL_CALL modified( const ::com::sun::star::lang::EventObject& _rSource ) throw( ::com::sun::star::uno::RuntimeException );
// XPropertyChangeListener
virtual void SAL_CALL propertyChange( const ::com::sun::star::beans::PropertyChangeEvent& evt ) 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);
// XComponent/OComponentHelper
virtual void SAL_CALL disposing();
private:
// service constructors
void createWithFormController( const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormController >& _rxController );
void createWithForm( const ::com::sun::star::uno::Reference< ::com::sun::star::form::XForm >& _rxForm );
/** determines whether or not we're already disposed
*/
inline bool impl_isDisposed_nothrow() const { return !m_xCursor.is(); }
/** checks whether the instance is already disposed, and throws an exception if so
*/
void impl_checkDisposed_throw() const;
/** initializes the instance after m_xController has been set
@precond
m_xController is not <NULL/>
*/
void impl_initFromController_throw();
/** initializes the instance after m_xCursor has been set
@precond
m_xCursor is not <NULL/>
*/
void impl_initFromForm_throw();
/// invalidate the full palette of features which we know
void impl_invalidateAllSupportedFeatures_nothrow( MethodGuard& _rClearForCallback ) const;
/** invalidate the features which depend on the "modified" state of the current control
of our controller
*/
void impl_invalidateModifyDependentFeatures_nothrow( MethodGuard& _rClearForCallback ) const;
/** ensures that our parse is initialized, or at least that we attempted to do so
@precond
we're not disposed
*/
void impl_ensureInitializedParser_nothrow();
/// disposes our parser, if we have one
void impl_disposeParser_nothrow();
/** determines whether our cursor can be moved left
@precond hasCursor()
*/
bool impl_canMoveLeft_throw() const;
/** determines whether our cursor can be moved right
@precond hasCursor()
*/
bool impl_canMoveRight_throw() const;
/// determines whether we're positioned on the insertion row
bool impl_isInsertionRow_throw() const;
/// retrieves the RowCount property of the form
sal_Int32 impl_getRowCount_throw() const;
/// retrieves the RowCountFinal property of the form
bool impl_isRowCountFinal_throw() const;
/// retrieves the IsModified property of the form
bool impl_isModifiedRow_throw() const;
/// determines whether we can parse the query of our form
bool impl_isParseable_throw() const;
/// determines if we have an active filter or order condition
bool impl_hasFilterOrOrder_throw() const;
/// determines whether our form is in "insert-only" mode
bool impl_isInsertOnlyForm_throw() const;
/** retrieces the column to which the current control of our controller is bound
@precond
m_xController.is()
*/
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
impl_getCurrentBoundField_nothrow( ) const;
/** returns the control model of the current control
If the current control is a grid control, then the returned model is the
model of the current <em>column</em> in the grid.
@precond
m_xController.is()
*/
::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >
impl_getCurrentControlModel_throw() const;
/// determines if we have a valid cursor
inline bool impl_hasCursor_nothrow() const { return m_xCursorProperties.is(); }
/** determines the model position from a grid control column's view position
A grid control can have columns which are currently hidden, so the index of a
column in the view is not necessarily the same as its index in the model.
*/
sal_Int16 impl_gridView2ModelPos_nothrow( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& _rxColumns, sal_Int16 _nViewPos ) const;
/** moves our cursor one position to the left, caring for different possible
cursor states.
Before the movement is done, the current row is saved, if necessary.
@precond
canMoveLeft()
*/
bool impl_moveLeft_throw() const;
/** moves our cursor one position to the right, caring for different possible
cursor states.
Before the movement is done, the current row is saved, if necessary.
@precond
canMoveRight()
*/
bool impl_moveRight_throw( ) const;
/** impl-version of commitCurrentRecord, which can be called without caring for
an output parameter, and within const-contexts
@precond
our mutex is locked
*/
bool impl_commitCurrentRecord_throw( sal_Bool* _pRecordInserted = NULL ) const;
/** impl-version of commitCurrentControl, which can be called in const-contexts
@precond
our mutex is locked
*/
bool impl_commitCurrentControl_throw() const;
/// resets all control models in our own form
void impl_resetAllControls_nothrow() const;
/// executes the "auto sort ascending" and "auto sort descending" features
void impl_executeAutoSort_throw( bool _bUp ) const;
/// executes the "auto filter" feature
void impl_executeAutoFilter_throw( ) const;
/// executes the interactive sort resp. filter feature
void impl_executeFilterOrSort_throw( bool _bFilter ) const;
private:
/// typedef for member method of this class
typedef void (FormOperations::*Action)( const void* ) const;
/** calls a member function, catches SQLExceptions, extends them with additional context information,
and rethrows them
@param _pAction
the member function to call
@param _pParam
the parameters to pass to the member function
@param _nErrorResourceId
the id of the resources string to use as error message
*/
void impl_doActionInSQLContext_throw( Action _pAction, const void* _pParam, sal_uInt16 _nErrorResourceId ) const;
// parameter structure for appendOrderByColumn
struct param_appendOrderByColumn
{
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
xField;
bool bUp;
};
void impl_appendOrderByColumn_throw( const void* _pActionParam ) const;
// parameter structure for appendFilterByColumn
struct param_appendFilterByColumn
{
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
xField;
};
void impl_appendFilterByColumn_throw( const void* _pActionParam ) const;
private:
FormOperations(); // never implemented
FormOperations( const FormOperations& ); // never implemented
FormOperations& operator=( const FormOperations& ); // never implemented
public:
class MethodGuard
{
FormOperations& m_rOwner;
bool m_bCleared;
public:
inline MethodGuard( FormOperations& _rOwner )
:m_rOwner( _rOwner )
,m_bCleared( false )
{
m_rOwner.enterMethod( FormOperations::MethodAccess() );
}
inline ~MethodGuard()
{
clear();
}
inline void clear()
{
if ( !m_bCleared )
m_rOwner.leaveMethod( FormOperations::MethodAccess() );
m_bCleared = true;
}
};
};
//........................................................................
} // namespace frm
//........................................................................
#endif // FORMS_FORMOPERATIONS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
