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
|
/* -*- 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_DBAEXCHANGE_HXX
#define INCLUDED_SVX_DBAEXCHANGE_HXX
#include <sal/config.h>
#include <o3tl/typed_flags_set.hxx>
#include <vcl/transfer.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <svx/dataaccessdescriptor.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <svx/svxdllapi.h>
namespace com::sun::star::sdbc { class XConnection; }
namespace com::sun::star::beans { class XPropertySet; }
// column transfer formats
enum class ColumnTransferFormatFlags
{
FIELD_DESCRIPTOR = 0x01, // the field descriptor format
CONTROL_EXCHANGE = 0x02, // the control exchange format
COLUMN_DESCRIPTOR = 0x04, // data access descriptor for a column
};
namespace o3tl
{
template<> struct typed_flags<ColumnTransferFormatFlags> : is_typed_flags<ColumnTransferFormatFlags, 0x07> {};
}
namespace svx
{
//= OColumnTransferable
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC OColumnTransferable final : public TransferDataContainer
{
public:
OColumnTransferable(ColumnTransferFormatFlags nFormats);
/** construct the transferable from a data access descriptor
Note that some of the aspects, in particular all which cannot be represented
as string, can only be transported via the CTF_COLUMN_DESCRIPTOR format.
@param rDescriptor
The descriptor for the column. It must contain at least
<ul><li>information sufficient to create a connection, that is, either one of DataSource, DatabaseLocation,
ConnectionResource, and DataAccessDescriptorProperty::Connection</li>
<li>a Command</li>
<li>a CommandType</li>
<li>a ColumnName or ColumnObject</li>
</ul>
*/
void setDescriptor(const ODataAccessDescriptor& rDescriptor);
/** construct the transferable from a DatabaseForm component and a field name
@param _rxForm
the form which is bound to the data source which's field is to be dragged
@param _rFieldName
the name of the field to be dragged
@param _rxColumn
the column object. Won't be used if <arg>_nFormats</arg> does not include the CTF_COLUMN_DESCRIPTOR
flag.<br/>
May be <NULL/>.
@param _rxConnection
the connection the column belongs to. Won't be used if <arg>_nFormats</arg> does not include the CTF_COLUMN_DESCRIPTOR
flag.<br/>
May be <NULL/>.
@param _nFormats
supported formats. Must be a combination of the CTF_XXX flags
*/
OColumnTransferable(
const css::uno::Reference< css::beans::XPropertySet >& _rxForm,
const OUString& _rFieldName,
const css::uno::Reference< css::beans::XPropertySet >& _rxColumn,
const css::uno::Reference< css::sdbc::XConnection >& _rxConnection,
ColumnTransferFormatFlags _nFormats
);
/** checks whether or not a column descriptor can be extracted from the data flavor vector given
@param _rFlavors
available flavors
@param _nFormats
formats to accept
*/
static bool canExtractColumnDescriptor(const DataFlavorExVector& _rFlavors, ColumnTransferFormatFlags _nFormats);
/** extracts a column descriptor from the transferable given
*/
static bool extractColumnDescriptor(
const TransferableDataHelper& _rData
,OUString& _rDatasource
,OUString& _rDatabaseLocation
,OUString& _rConnectionResource
,sal_Int32& _nCommandType
,OUString& _rCommand
,OUString& _rFieldName
);
/** extracts a column descriptor from the transferable given
*/
static ODataAccessDescriptor
extractColumnDescriptor(const TransferableDataHelper& _rData);
private:
// TransferableHelper overridables
virtual void AddSupportedFormats() override;
virtual bool GetData( const css::datatransfer::DataFlavor& rFlavor, const OUString& rDestDoc ) override;
static SotClipboardFormatId getDescriptorFormatId();
SVX_DLLPRIVATE void implConstruct(
const OUString& _rDatasource
,const OUString& _rConnectionResource
,const sal_Int32 _nCommandType
,const OUString& _rCommand
,const OUString& _rFieldName
);
ODataAccessDescriptor m_aDescriptor;
OUString m_sCompatibleFormat;
ColumnTransferFormatFlags m_nFormatFlags;
};
//= ODataAccessObjectTransferable
/** class for transferring data access objects (tables, queries, statements ...)
*/
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC ODataAccessObjectTransferable : public TransferDataContainer
{
ODataAccessDescriptor m_aDescriptor;
OUString m_sCompatibleObjectDescription;
// needed to provide a SotClipboardFormatId::SBA_DATAEXCHANGE format
public:
/** should be used copying and the connection is needed.
@param _rDatasource
The data source name.
@param _nCommandType
The kind of command. @see com.sun.star.sdbc.CommandType
@param _rCommand
The command, either a name of a table or query or a SQL statement.
*/
void Update(
const OUString& _rDatasource,
const sal_Int32 _nCommandType,
const OUString& _rCommand,
const css::uno::Reference< css::sdbc::XConnection >& _rxConnection
);
/** should be used when copying a query object and no connection is available.
@param _rDatasource
The data source name.
@param _nCommandType
The kind of command. @see com.sun.star.sdbc.CommandType
@param _rCommand
The command, either a name of a table or query or a SQL statement.
*/
void Update(
const OUString& _rDatasource,
const sal_Int32 _nCommandType,
const OUString& _rCommand
);
/** with this ctor, only the object descriptor format will be provided
*/
ODataAccessObjectTransferable(
const css::uno::Reference< css::beans::XPropertySet >& _rxLivingForm
);
ODataAccessObjectTransferable();
/** checks whether or not an object descriptor can be extracted from the data flavor vector given
@param _rFlavors
available flavors
@param _nFormats
formats to accept
*/
static bool canExtractObjectDescriptor(const DataFlavorExVector& _rFlavors);
/** extracts an object descriptor from the transferable given
*/
static ODataAccessDescriptor
extractObjectDescriptor(const TransferableDataHelper& _rData);
protected:
virtual void AddSupportedFormats() override;
virtual bool GetData( const css::datatransfer::DataFlavor& rFlavor, const OUString& rDestDoc ) override;
virtual void ObjectReleased() override;
protected:
const ODataAccessDescriptor& getDescriptor() const { return m_aDescriptor; }
ODataAccessDescriptor& getDescriptor() { return m_aDescriptor; }
protected:
void addCompatibleSelectionDescription(
const css::uno::Sequence< css::uno::Any >& _rSelRows
);
// normally, a derived class could simply access getDescriptor[DataAccessDescriptorProperty::Selection] and place the sequence therein
// but unfortunately, we have this damned compatible format, and this can't be accessed in
// derived classes (our class is the only one which should be contaminated with this)
private:
SVX_DLLPRIVATE void construct( const OUString& _rDatasourceOrLocation
,const OUString& _rConnectionResource
,const sal_Int32 _nCommandType
,const OUString& _rCommand
,const css::uno::Reference< css::sdbc::XConnection >& _rxConnection
,bool _bAddCommand
,const OUString& _sActiveCommand);
};
//= OMultiColumnTransferable
/** class for transferring multiple columns
*/
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC OMultiColumnTransferable final : public TransferDataContainer
{
public:
OMultiColumnTransferable();
void setDescriptors(const css::uno::Sequence< css::beans::PropertyValue >& rDescriptors);
/** checks whether or not an object descriptor can be extracted from the data flavor vector given
@param _rFlavors
available flavors
@param _nFormats
formats to accept
*/
static bool canExtractDescriptor(const DataFlavorExVector& _rFlavors);
/** extracts an object descriptor from the transferable given
*/
static css::uno::Sequence< css::beans::PropertyValue > extractDescriptor(const TransferableDataHelper& _rData);
private:
virtual void AddSupportedFormats() override;
virtual bool GetData( const css::datatransfer::DataFlavor& rFlavor, const OUString& rDestDoc ) override;
virtual void ObjectReleased() override;
static SotClipboardFormatId getDescriptorFormatId();
css::uno::Sequence< css::beans::PropertyValue > m_aDescriptors;
};
}
#endif // INCLUDED_SVX_DBAEXCHANGE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
