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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526 | /* -*- 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_APP_APPCONTROLLER_HXX
#define INCLUDED_DBACCESS_SOURCE_UI_APP_APPCONTROLLER_HXX
#include <AppElementType.hxx>
#include <callbacks.hxx>
#include <commontypes.hxx>
#include <dsntypes.hxx>
#include <dbaccess/genericcontroller.hxx>
#include <linkeddocuments.hxx>
#include <TableCopyHelper.hxx>
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/sdb/application/XDatabaseDocumentUI.hpp>
#include <com/sun/star/ui/XContextMenuInterception.hpp>
#include <comphelper/namedvaluecollection.hxx>
#include <comphelper/uno3.hxx>
#include <cppuhelper/implbase5.hxx>
#include <comphelper/interfacecontainer2.hxx>
#include <vcl/transfer.hxx>
#include <svx/dataaccessdescriptor.hxx>
#include <memory>
class SvTreeListEntry;
class SvTreeListBox;
class TransferableHelper;
class TransferableClipboardListener;
namespace com::sun::star {
namespace container {
class XNameContainer;
class XContainer;
}
namespace ucb {
class XContent;
}
}
namespace dbaui
{
class SubComponentManager;
class OApplicationController;
class OApplicationView;
class OLinkedDocumentsAccess;
class SelectionNotifier;
typedef ::cppu::ImplHelper5 < css::container::XContainerListener
, css::beans::XPropertyChangeListener
, css::sdb::application::XDatabaseDocumentUI
, css::ui::XContextMenuInterception
, css::view::XSelectionSupplier
> OApplicationController_Base;
class OApplicationController
:public OGenericUnoController
,public OApplicationController_Base
,public IControlActionListener
,public IContextMenuProvider
{
public:
typedef std::vector< css::uno::Reference< css::container::XContainer > > TContainerVector;
private:
OTableCopyHelper::DropDescriptor m_aAsyncDrop;
SharedConnection m_xDataSourceConnection;
css::uno::Reference< css::sdbc::XDatabaseMetaData >
m_xMetaData;
TransferableDataHelper m_aSystemClipboard; // content of the clipboard
css::uno::Reference< css::beans::XPropertySet >
m_xDataSource;
css::uno::Reference< css::frame::XModel >
m_xModel;
::comphelper::OInterfaceContainerHelper2
m_aContextMenuInterceptors;
TContainerVector m_aCurrentContainers; // the containers where we are listener on
::rtl::Reference< SubComponentManager >
m_pSubComponentManager;
::dbaccess::ODsnTypeCollection
m_aTypeCollection;
OTableCopyHelper m_aTableCopyHelper;
rtl::Reference<TransferableClipboardListener>
m_pClipboardNotifier; // notifier for changes in the clipboard
ImplSVEvent * m_nAsyncDrop;
OAsynchronousLink m_aSelectContainerEvent;
PreviewMode m_ePreviewMode; // the mode of the preview
ElementType m_eCurrentType;
bool m_bNeedToReconnect; // true when the settings of the data source were modified and the connection is no longer up to date
bool m_bSuspended; // is true when the controller was already suspended
std::unique_ptr< SelectionNotifier >
m_pSelectionNotifier;
typedef std::map< ElementType, std::vector< OUString > > SelectionByElementType;
SelectionByElementType m_aPendingSelection;
private:
OApplicationView* getContainer() const;
/** returns the database name
@return
the database name
*/
OUString getDatabaseName() const;
/** returns the stripped database name.
@return
The stripped database name either the registered name or if it is a file url the last segment.
*/
OUString getStrippedDatabaseName() const;
/** return the element type for given container
@param _xContainer The container where the element type has to be found
@return the element type corresponding to the given container
*/
static ElementType getElementType(const css::uno::Reference< css::container::XContainer >& _xContainer);
/** opens a new sub frame with a table/query/form/report/view, passing additional arguments
*/
css::uno::Reference< css::lang::XComponent > openElementWithArguments(
const OUString& _sName,
ElementType _eType,
ElementOpenMode _eOpenMode,
sal_uInt16 _nInstigatorCommand,
const ::comphelper::NamedValueCollection& _rAdditionalArguments
);
/** opens a new frame for creation or auto pilot
@param _eType
Defines the type to open
@param i_rAdditionalArguments
Additional arguments to pass when creating the component
*/
css::uno::Reference< css::lang::XComponent >
newElement(
ElementType _eType,
const ::comphelper::NamedValueCollection& i_rAdditionalArguments,
css::uno::Reference< css::lang::XComponent >& o_rDocumentDefinition
);
/** creates a new database object, using an auto pilot
@param _eType
Defines the type of the object to create
@precond
Our mutex must not be locked.
@since #i39203#
*/
void newElementWithPilot( ElementType _eType );
/** converts the query to a view
@param _sName
The name of the query.
*/
void convertToView(const OUString& _sName);
/** checks if the connection for the selected data source is read only. If the connection doesn't exist, <TRUE/> will be returned.
@return
<TRUE/> if read only or doesn't exist, otherwise <FALSE/>
*/
bool isConnectionReadOnly() const;
/// fills the list with the selected entries.
void getSelectionElementNames( std::vector< OUString>& _rNames ) const;
/// deletes the entries selected.
void deleteEntries();
/// renames the selected entry in the detail page
void renameEntry();
/** deletes queries, forms, or reports
@param _eType
the type of the objects
@param _rList
The names of the elements to delete
@param _bConfirm
determines whether the user must confirm the deletion
*/
void deleteObjects( ElementType _eType,
const std::vector< OUString>& _rList,
bool _bConfirm );
/** deletes tables.
@param _rList
The list of tables.
*/
void deleteTables(const std::vector< OUString>& _rList);
/// copies the current object into clipboard
TransferableHelper* copyObject();
/// returns the nameaccess
css::uno::Reference< css::container::XNameAccess > getElements(ElementType _eType);
/** returns the document access for the specific type
@param _eType
the type
@return std::unique_ptr<OLinkedDocumentsAccess>
*/
std::unique_ptr<OLinkedDocumentsAccess> getDocumentsAccess(ElementType _eType);
/// returns the query definitions of the active data source.
css::uno::Reference< css::container::XNameContainer> getQueryDefinitions() const;
/** pastes a special format from the system clipboard to the currently selected object types
@param _nFormatId
The format to be copied.
*/
void pasteFormat(SotClipboardFormatId _nFormatId);
/** pastes a query, form or report into the data source
@param _eType
The type of the object to paste.
@param _rPasteData
The data descriptor.
@param _sParentFolder
The name of the parent folder if it exists.
@param _bMove
if <TRUE/> the name of the content must be inserted without any change, otherwise not.
@return
<TRUE/> if the paste operations was successful, otherwise <FALSE/>.
*/
bool paste( ElementType _eType, const svx::ODataAccessDescriptor& _rPasteData, const OUString& _sParentFolder = OUString(), bool _bMove = false);
/// returns the system clipboard.
const TransferableDataHelper& getViewClipboard() const { return m_aSystemClipboard; }
/// returns <TRUE/> if the clipboard supports a table format, otherwise <FALSE/>.
bool isTableFormat() const;
/** fills the vector with all supported formats
@param _eType
The type for which we need the formats
@param _rFormatIds
The vector to be filled up.
*/
static void getSupportedFormats(ElementType _eType,std::vector<SotClipboardFormatId>& _rFormatIds);
/** adds a listener to the current name access.
@param _xCollection
The collection where we want to listen on.
*/
void addContainerListener(const css::uno::Reference< css::container::XNameAccess>& _xCollection);
/** opens a uno dialog with the currently selected data source as initialize argument
@param _sServiceName
The service name of the dialog to be executed.
*/
void openDialog(const OUString& _sServiceName);
/** when the settings of the data source changed,
it opens a dialog which ask to close all depending documents, then recreate the connection.
The SolarMutex has to be locked before calling this.
*/
void askToReconnect();
/** remember a newly opened sub document for later access
*/
void onDocumentOpened(
const OUString& _rName,
const sal_Int32 _nType,
const ElementOpenMode _eMode,
const css::uno::Reference< css::lang::XComponent >& _xDocument,
const css::uno::Reference< css::lang::XComponent >& _xDefinition
);
/** Inserts a new object into the hierarchy given be the type.
@param _eType
Where to insert the new item.
@param _sParentFolder
The name of the parent folder if it exists.
@param _xContent
The content to insert.
@param _bMove
if <TRUE/> the name of the content must be inserted without any change, otherwise not.
@return
<TRUE/> if the insert operations was successful, otherwise <FALSE/>.
*/
bool insertHierachyElement( ElementType _eType
,const OUString& _sParentFolder
,bool _bCollection = true
,const css::uno::Reference< css::ucb::XContent>& _xContent = css::uno::Reference< css::ucb::XContent>()
,bool _bMove = false);
/** checks if delete command or rename command is allowed
@param _eType
The element type.
@param _bDelete
If <TRUE> then the delete command should be checked.
@return
<TRUE> if the command is allowed
*/
bool isRenameDeleteAllowed(ElementType _eType, bool _bDelete) const;
/** all selected entries will be opened, or edited, or converted to a view
@param _nId
The slot which should be executed.
@param _eOpenMode
Defines the mode of opening. @see ElementOpenMode
*/
void doAction(sal_uInt16 _nId, ElementOpenMode _eOpenMode);
/** returns the currently selected table or query name.
*
* \return the name of the currently table or query. If the tables or query container is selected otherwise an empty string will be returned.
*/
OUString getCurrentlySelectedName(sal_Int32& _rnCommandType) const;
/** shows the preview for the given entry
*/
void showPreviewFor( const ElementType _eType,const OUString& _sName );
/** called we were attached to a frame
In particular, this is called *after* the controller has been announced to the model
(XModel::connectController)
*/
void onAttachedFrame();
/// determines whether the given table name denotes a view which can be altered
bool impl_isAlterableView_nothrow( const OUString& _rTableOrViewName ) const;
/** verifies the object type denotes a valid DatabaseObject, and the object name denotes an existing
object of this type. Throws if not.
*/
void impl_validateObjectTypeAndName_throw( const sal_Int32 _nObjectType, const ::std::optional< OUString >& i_rObjectName );
protected:
// initializing members
// 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 override;
// execute a feature
virtual void Execute(sal_uInt16 nId, const css::uno::Sequence< css::beans::PropertyValue>& aArgs) override;
// OGenericUnoController
virtual void onLoadedMenu( const css::uno::Reference< css::frame::XLayoutManager >& _xLayoutManager ) override;
virtual css::uno::Reference< css::frame::XModel > getPrivateModel() const override
{
return m_xModel;
}
virtual ~OApplicationController() override;
public:
explicit OApplicationController(const css::uno::Reference< css::uno::XComponentContext >& _rxORB);
DECLARE_XINTERFACE( )<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.<--- There is an unknown macro here somewhere. Configuration is required. If DECLARE_XINTERFACE is a macro then please configure it.
DECLARE_XTYPEPROVIDER( )
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual css::uno::Sequence< OUString> SAL_CALL getSupportedServiceNames() override;
// need by registration
/// @throws css::uno::RuntimeException
static OUString getImplementationName_Static();
/// @throws css::uno::RuntimeException
static css::uno::Sequence< OUString > getSupportedServiceNames_Static();
static css::uno::Reference< css::uno::XInterface >
Create(const css::uno::Reference< css::lang::XMultiServiceFactory >&);
// css::frame::XController
virtual void SAL_CALL attachFrame(const css::uno::Reference< css::frame::XFrame > & xFrame) override;
virtual sal_Bool SAL_CALL suspend(sal_Bool bSuspend) override;
virtual sal_Bool SAL_CALL attachModel(const css::uno::Reference< css::frame::XModel > & xModel) override;
virtual css::uno::Reference< css::frame::XModel > SAL_CALL getModel() override;
// css::container::XContainerListener
virtual void SAL_CALL elementInserted(const css::container::ContainerEvent& Event) override;
virtual void SAL_CALL elementRemoved(const css::container::ContainerEvent& Event) override;
virtual void SAL_CALL elementReplaced(const css::container::ContainerEvent& Event) override;
// XPropertyChangeListener
virtual void SAL_CALL propertyChange( const css::beans::PropertyChangeEvent& evt ) override;
// XDatabaseDocumentUI
virtual css::uno::Reference< css::sdbc::XDataSource > SAL_CALL getDataSource() override;
virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getApplicationMainWindow() override;
virtual css::uno::Reference< css::sdbc::XConnection > SAL_CALL getActiveConnection() override;
virtual css::uno::Sequence< css::uno::Reference< css::lang::XComponent > > SAL_CALL getSubComponents() override;
virtual sal_Bool SAL_CALL isConnected( ) override;
// DO NOT CALL with getMutex() held!!
virtual void SAL_CALL connect( ) override;
virtual css::beans::Pair< ::sal_Int32, OUString > SAL_CALL identifySubComponent( const css::uno::Reference< css::lang::XComponent >& SubComponent ) override;
virtual sal_Bool SAL_CALL closeSubComponents( ) override;
virtual css::uno::Reference< css::lang::XComponent > SAL_CALL loadComponent( ::sal_Int32 ObjectType, const OUString& ObjectName, sal_Bool ForEditing ) override;
virtual css::uno::Reference< css::lang::XComponent > SAL_CALL loadComponentWithArguments( ::sal_Int32 ObjectType, const OUString& ObjectName, sal_Bool ForEditing, const css::uno::Sequence< css::beans::PropertyValue >& Arguments ) override;
virtual css::uno::Reference< css::lang::XComponent > SAL_CALL createComponent( ::sal_Int32 ObjectType, css::uno::Reference< css::lang::XComponent >& o_DocumentDefinition ) override;
virtual css::uno::Reference< css::lang::XComponent > SAL_CALL createComponentWithArguments( ::sal_Int32 ObjectType, const css::uno::Sequence< css::beans::PropertyValue >& Arguments, css::uno::Reference< css::lang::XComponent >& o_DocumentDefinition ) override;
// XContextMenuInterception
virtual void SAL_CALL registerContextMenuInterceptor( const css::uno::Reference< css::ui::XContextMenuInterceptor >& Interceptor ) override;
virtual void SAL_CALL releaseContextMenuInterceptor( const css::uno::Reference< css::ui::XContextMenuInterceptor >& Interceptor ) override;
// XSelectionSupplier
virtual sal_Bool SAL_CALL select( const css::uno::Any& xSelection ) override;
virtual css::uno::Any SAL_CALL getSelection( ) override;
virtual void SAL_CALL addSelectionChangeListener( const css::uno::Reference< css::view::XSelectionChangeListener >& xListener ) override;
virtual void SAL_CALL removeSelectionChangeListener( const css::uno::Reference< css::view::XSelectionChangeListener >& xListener ) override;
/** retrieves the current connection, creates it if necessary
If an error occurs, then this is either stored in the location pointed to by <arg>_pErrorInfo</arg>,
or, if <code>_pErrorInfo</code> is <NULL/>, then the error is displayed to the user.
DO NOT CALL with getMutex() held!!
*/
const SharedConnection& ensureConnection( ::dbtools::SQLExceptionInfo* _pErrorInfo = nullptr );
/** retrieves the current connection
*/
const SharedConnection& getConnection() const { return m_xDataSourceConnection; }
/// determines whether we're currently connected to the database
bool isConnected() const { return m_xDataSourceConnection.is(); }
/** refreshes the tables
*/
void refreshTables();
/** called when an entry in a tree list box has been double-clicked
@param _rTree
The tree list box.
@return
<TRUE/> if the double click event has been handled by the called, and should not
be processed further.
*/
bool onEntryDoubleClick(SvTreeListBox const & _rTree);
/** called when a container (category) in the application view has been selected
@param _pTree
The tree list box.
@return
<TRUE/> if the container could be changed otherwise <FALSE/>
*/
bool onContainerSelect(ElementType _eType);
/** called when an entry in a tree view has been selected
@param _pEntry
the selected entry
*/
void onSelectionChanged();
/** called when a "Copy" command is executed in a tree view
*/
void onCopyEntry();
/** called when a "Paste" command is executed in a tree view
*/
void onPasteEntry();
/** called when a "Delete" command is executed in a tree view
*/
void onDeleteEntry();
/// called when the preview mode was changed
void previewChanged( sal_Int32 _nMode);
/// called when an object container of any kind was found during enumerating tree view elements
void containerFound( const css::uno::Reference< css::container::XContainer >& _xContainer);
// IController
virtual bool isDataSourceReadOnly() const override;
// IControlActionListener overridables
virtual bool requestQuickHelp( const SvTreeListEntry* _pEntry, OUString& _rText ) const override;
virtual bool requestDrag( const Point& _rPosPixel ) override;
virtual sal_Int8 queryDrop( const AcceptDropEvent& _rEvt, const DataFlavorExVector& _rFlavors ) override;
virtual sal_Int8 executeDrop( const ExecuteDropEvent& _rEvt ) override;
// IContextMenuProvider
virtual OUString getContextMenuResourceName( Control& _rControl ) const override;
virtual IController& getCommandController() override;
virtual ::comphelper::OInterfaceContainerHelper2*
getContextMenuInterceptors() override;
virtual css::uno::Any
getCurrentSelection( Control& _rControl ) const override;
void OnInvalidateClipboard();
DECL_LINK( OnClipboardChanged, TransferableDataHelper*, void );
DECL_LINK( OnAsyncDrop, void*, void );
DECL_LINK( OnCreateWithPilot, void*, void );
DECL_LINK( OnSelectContainer, void*, void );
void OnFirstControllerConnected();
protected:
using OGenericUnoController::connect;
/** disconnects from our XConnection, and cleans up this connection
*/
void disconnect();
// late construction
virtual bool Construct(vcl::Window* pParent) override;
virtual void describeSupportedFeatures() override;
protected:
// XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
// OComponentHelper
virtual void SAL_CALL disposing() override;
};
} // namespace dbaui
#endif // INCLUDED_DBACCESS_SOURCE_UI_APP_APPCONTROLLER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|