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
|
/* -*- 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_DBACCESS_SOURCE_UI_INC_BRWCTRLR_HXX
#define INCLUDED_DBACCESS_SOURCE_UI_INC_BRWCTRLR_HXX
#include <dbaccess/genericcontroller.hxx>
#include "moduledbu.hxx"
#include "brwview.hxx"
#include "sbagrid.hxx"
#include <com/sun/star/form/XLoadable.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/sdb/XSQLErrorListener.hpp>
#include <com/sun/star/sdbc/XRowSet.hpp>
#include <com/sun/star/form/XResetListener.hpp>
#include <com/sun/star/form/XDatabaseParameterListener.hpp>
#include <com/sun/star/form/XConfirmDeleteListener.hpp>
#include <com/sun/star/form/XFormComponent.hpp>
#include <com/sun/star/awt/XFocusListener.hpp>
#include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
#include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp>
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/frame/XModule.hpp>
#include <vcl/timer.hxx>
#include <svtools/transfer.hxx>
#include <osl/mutex.hxx>
#include <osl/thread.hxx>
#include <cppuhelper/implbase.hxx>
#include <svtools/cliplistener.hxx>
struct FmFoundRecordInformation;
struct FmSearchContext;
namespace dbtools
{
class SQLExceptionInfo;
}
namespace dbaui
{
typedef ::cppu::ImplInheritanceHelper < OGenericUnoController
, css::sdb::XSQLErrorListener
, css::form::XDatabaseParameterListener
, css::form::XConfirmDeleteListener
, css::form::XLoadListener
, css::form::XResetListener
, css::awt::XFocusListener
, css::container::XContainerListener
, css::beans::XPropertyChangeListener
, css::frame::XModule
> SbaXDataBrowserController_Base;
class SbaXDataBrowserController :public SbaXDataBrowserController_Base
,public SbaGridListener
{
// attributes
private:
// for implementing the XFormController
class FormControllerImpl;
friend class FormControllerImpl;
OModuleClient m_aModuleClient;
css::uno::Reference< css::sdbc::XRowSet > m_xRowSet; // our rowset
css::uno::Reference< css::sdbcx::XColumnsSupplier > m_xColumnsSupplier; // queried from the rowset member
css::uno::Reference< css::form::XLoadable > m_xLoadable; // queried from the rowset member as well
css::uno::Reference< css::form::XFormComponent > m_xGridModel; // the model of our grid
css::uno::Reference< css::util::XNumberFormatter > m_xFormatter; // a number formatter working with the connection's NumberFormatsSupplier
css::uno::Reference< css::uno::XAggregation > m_xFormControllerImpl;
mutable css::uno::Reference< css::sdb::XSingleSelectQueryComposer >
m_xParser; // for sorting 'n filtering
sal_Int32 m_nRowSetPrivileges; // cached Privileges property of m_xRowSet
AutoTimer m_aInvalidateClipboard; // for testing the state of the CUT/COPY/PASTE-slots
TransferableDataHelper m_aSystemClipboard; // content of the clipboard
TransferableClipboardListener*
m_pClipbordNotifier; // notifier for changes in the clipboard
OAsynchronousLink m_aAsyncGetCellFocus;
OAsynchronousLink m_aAsyncDisplayError;
::dbtools::SQLExceptionInfo m_aCurrentError;
OUString m_sStateSaveRecord;
OUString m_sStateUndoRecord;
OUString m_sModuleIdentifier;
// members for asynchronous load operations
FormControllerImpl* m_pFormControllerImpl; // implementing the XFormController
sal_uInt16 m_nFormActionNestingLevel; // see enter-/leaveFormAction
bool m_bLoadCanceled : 1; // the load was canceled somehow
bool m_bCannotSelectUnfiltered : 1; // received an DATA_CANNOT_SELECT_UNFILTERED error
protected:
class FormErrorHelper
{
SbaXDataBrowserController* m_pOwner;
public:
FormErrorHelper(SbaXDataBrowserController* pOwner) : m_pOwner(pOwner) { m_pOwner->enterFormAction(); }
virtual ~FormErrorHelper() { m_pOwner->leaveFormAction(); }
};
friend class FormErrorHelper;
// attribute access
protected:
css::uno::Reference< css::sdbc::XRowSet > getRowSet() const { return m_xRowSet; }
css::uno::Reference< css::sdbcx::XColumnsSupplier > getColumnsSupplier()const { return m_xColumnsSupplier; }
css::uno::Reference< css::form::XLoadable > getLoadable() const { return m_xLoadable; }
css::uno::Reference< css::form::XFormComponent > getFormComponent() const { return m_xGridModel; }
css::uno::Reference< css::awt::XControlModel > getControlModel() const { return css::uno::Reference< css::awt::XControlModel > (m_xGridModel, css::uno::UNO_QUERY); }
css::uno::Reference< css::util::XNumberFormatter > getNumberFormatter()const { return m_xFormatter; }
bool isValid() const { return m_xRowSet.is() && m_xGridModel.is(); }
bool isValidCursor() const; // checks the css::data::XDatabaseCursor-interface of m_xRowSet
bool isLoaded() const;
bool loadingCancelled() const { return m_bLoadCanceled; }
void onStartLoading( const css::uno::Reference< css::form::XLoadable >& _rxLoadable );
void setLoadingCancelled() { m_bLoadCanceled = true; }
public:
SbaXDataBrowserController(const css::uno::Reference< css::uno::XComponentContext >& _rM);
UnoDataBrowserView* getBrowserView() const { return static_cast< UnoDataBrowserView*>(getView()); }
// late construction
virtual bool Construct(vcl::Window* pParent) SAL_OVERRIDE;
// UNO
virtual css::uno::Any SAL_CALL queryInterface(const css::uno::Type& _rType) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XTypeProvider
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId( ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::lang::XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& Source) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::util::XModifyListener
virtual void SAL_CALL modified(const css::lang::EventObject& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::container::XContainerListener
virtual void SAL_CALL elementInserted(const css::container::ContainerEvent& Event) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL elementRemoved(const css::container::ContainerEvent& Event) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL elementReplaced(const css::container::ContainerEvent& Event) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XPropertyChangeListener
virtual void SAL_CALL propertyChange( const css::beans::PropertyChangeEvent& evt ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XModule
virtual void SAL_CALL setIdentifier( const OUString& Identifier ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual OUString SAL_CALL getIdentifier( ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::awt::XFocusListener
virtual void SAL_CALL focusGained(const css::awt::FocusEvent& e) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL focusLost(const css::awt::FocusEvent& e) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::frame::XController
virtual sal_Bool SAL_CALL suspend(sal_Bool bSuspend) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::lang::XComponent
virtual void SAL_CALL disposing() SAL_OVERRIDE;
// css::frame::XFrameActionListener
virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::sdb::XSQLErrorListener
virtual void SAL_CALL errorOccured(const css::sdb::SQLErrorEvent& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::form::XDatabaseParameterListener
virtual sal_Bool SAL_CALL approveParameter(const css::form::DatabaseParameterEvent& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::form::XConfirmDeleteListener
virtual sal_Bool SAL_CALL confirmDelete(const css::sdb::RowChangeEvent& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::form::XLoadListener
virtual void SAL_CALL loaded(const css::lang::EventObject& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL unloading(const css::lang::EventObject& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL unloaded(const css::lang::EventObject& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL reloading(const css::lang::EventObject& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL reloaded(const css::lang::EventObject& aEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// css::form::XResetListener
virtual sal_Bool SAL_CALL approveReset(const css::lang::EventObject& rEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL resetted(const css::lang::EventObject& rEvent) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// SbaGridListener
virtual void RowChanged() SAL_OVERRIDE;
virtual void ColumnChanged() SAL_OVERRIDE;
virtual void SelectionChanged() SAL_OVERRIDE;
virtual void CellActivated() SAL_OVERRIDE;
virtual void CellDeactivated() SAL_OVERRIDE;
virtual void BeforeDrop() SAL_OVERRIDE;
virtual void AfterDrop() SAL_OVERRIDE;
public:
protected:
virtual ~SbaXDataBrowserController();
// all the features which should be handled by this class
virtual void describeSupportedFeatures() SAL_OVERRIDE;
// state of a feature. 'feature' may be the handle of a css::util::URL somebody requested a dispatch interface for OR a toolbar slot.
virtual FeatureState GetState(sal_uInt16 nId) const SAL_OVERRIDE;
// execute a feature
virtual void Execute(sal_uInt16 nId, const css::uno::Sequence< css::beans::PropertyValue>& aArgs) SAL_OVERRIDE;
virtual void startFrameListening( const css::uno::Reference< css::frame::XFrame >& _rxFrame ) SAL_OVERRIDE;
virtual void stopFrameListening( const css::uno::Reference< css::frame::XFrame >& _rxFrame ) SAL_OVERRIDE;
virtual css::uno::Reference< css::sdbc::XRowSet > CreateForm();
// our default implementation simply instantiates a stardiv.one.form.component.Form service
// (probably this needs not to be overridden, but you may return anything you want as long as it
// supports the css::form::DatabaseForm service. For instance you may want to create an adapter here which
// is synchronized with a foreign css::form::DatabaseForm you got elsewhere)
virtual bool InitializeForm(
const css::uno::Reference< css::beans::XPropertySet >& i_formProperties ) = 0;
// called immediately after a successful CreateForm
// do any initialization (data source etc.) here. the form should be fully functional after that.
// return sal_False if you didn't succeed (don't throw exceptions, they won't be caught)
virtual bool InitializeGridModel(const css::uno::Reference< css::form::XFormComponent > & xGrid);
css::uno::Reference< css::form::XFormComponent > CreateGridModel();
// our default implementation simply instantiates a stardiv.one.form.component.Grid service
// you most probably don't want to override this behavior
// the default implementation of disposing distributes the events to the following disposingXXX functions
void disposingGridControl(const css::lang::EventObject& Source); // calls removeControlListeners
void disposingGridModel(const css::lang::EventObject& Source); // calls removeModelListeners
void disposingFormModel(const css::lang::EventObject& Source);
void disposingColumnModel(const css::lang::EventObject& Source);
// want to be a listener to the grid control ? use this !
void addControlListeners(const css::uno::Reference< css::awt::XControl > & _xGridControl);
void removeControlListeners(const css::uno::Reference< css::awt::XControl > & _xGridControl);
// want to be a listener to the grid model ? use this !
virtual void addModelListeners(const css::uno::Reference< css::awt::XControlModel > & _xGridControlModel);
virtual void removeModelListeners(const css::uno::Reference< css::awt::XControlModel > & _xGridControlModel);
// want to be a listener grid columns ? use this !
virtual void AddColumnListener(const css::uno::Reference< css::beans::XPropertySet > & xCol);
virtual void RemoveColumnListener(const css::uno::Reference< css::beans::XPropertySet > & xCol);
// call after "major changes" (e.g. the completion of the async load).
// invalidates all toolbox slots and all supported features.
virtual bool LoadForm();
// load the form
// the default implementation does an direct load or starts a load thread, depending on the multithread capabilities
// of the data source.
// the default implementation also calls LoadFinished after a synchronous load, so be sure to do the same if you override
// this method and don't call the base class' method
virtual void LoadFinished(bool bWasSynch);
// called if the loading (the _complete_ loading process) is done (no matter if synchron or asynchron).
virtual void criticalFail();
// called whenever a reload operation on the rowset failed
// (a "operation" is not only a simple reload: If the user sets a filter, an reloading the form
// after setting this filter fails, the filter is reset and the form is reloaded, again. Only the
// whole process (_both_ XLoadable::reload calls _together_) form the "reload operation"
// empty the frame where our view resides
bool CommitCurrent();
// commit the current column (i.e. cell)
bool SaveModified(bool bAskFor = true);
// save the modified record
css::uno::Reference< css::beans::XPropertySet > getBoundField(sal_uInt16 nViewPos = (sal_uInt16)-1) const;
// a PropertySet corresponding to the cursor field a column is bound to
// if nViewPos is (sal_uInt16)-1 (the default) then the field for the current column will be retrieved
void enterFormAction();
void leaveFormAction();
// init the formatter if form changes
void initFormatter();
/// loads or reloads the form
bool reloadForm(const css::uno::Reference< css::form::XLoadable >& _rxLoadable);
virtual bool preReloadForm(){ return false; }
virtual void postReloadForm(){}
css::uno::Reference< css::sdb::XSingleSelectQueryComposer >
createParser_nothrow();
private:
void setCurrentModified( bool _bSet );
// execute the filter or sort slot
void ExecuteFilterSortCrit(bool bFilter);
// execute the search slot
void ExecuteSearch();
void initializeParser() const; // changes the mutable member m_xParser
void applyParserFilter(const OUString& _rOldFilter, bool _bOldFilterApplied,const ::OUString& _sOldHaving,const css::uno::Reference< css::sdb::XSingleSelectQueryComposer >& _xParser);
void applyParserOrder(const OUString& _rOldOrder,const css::uno::Reference< css::sdb::XSingleSelectQueryComposer >& _xParser);
sal_Int16 getCurrentColumnPosition();
void setCurrentColumnPosition( sal_Int16 _nPos );
void addColumnListeners(const css::uno::Reference< css::awt::XControlModel > & _xGridControlModel);
void impl_checkForCannotSelectUnfiltered( const ::dbtools::SQLExceptionInfo& _rError );
// time to check the CUT/COPY/PASTE-slot-states
DECL_LINK_TYPED( OnInvalidateClipboard, Timer*, void );
DECL_LINK( OnClipboardChanged, void* );
// search callbacks
DECL_LINK(OnSearchContextRequest, FmSearchContext*);
DECL_LINK(OnFoundData, FmFoundRecordInformation*);
DECL_LINK(OnCanceledNotFound, FmFoundRecordInformation*);
DECL_LINK(OnAsyncGetCellFocus, void*);
DECL_LINK( OnAsyncDisplayError, void* );
};
}
#endif // INCLUDED_DBACCESS_SOURCE_UI_INC_BRWCTRLR_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
