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
|
/* -*- 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_FMEXCH_HXX
#define INCLUDED_SVX_SOURCE_INC_FMEXCH_HXX
#include <config_options.h>
#include <sal/config.h>
#include <set>
#include <sot/exchange.hxx>
#include <vcl/transfer.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/form/XForms.hpp>
#include <rtl/ref.hxx>
#include <tools/link.hxx>
#include <vcl/window.hxx>
#include <svx/svxdllapi.h>
class SvTreeListEntry;
class SvTreeListBox;
namespace svxform
{
typedef ::std::set< SvTreeListEntry* > ListBoxEntrySet;
//= OLocalExchange
class UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) OLocalExchange : public TransferableHelper
{
private:
Link<OLocalExchange&,void> m_aClipboardListener;
bool m_bDragging : 1;
bool m_bClipboardOwner : 1;
public:
class GrantAccess
{
friend class OLocalExchangeHelper;
};
public:
OLocalExchange( );
bool isDragging() const { return m_bDragging; }
bool isClipboardOwner() const { return m_bClipboardOwner; }
void startDrag( vcl::Window* pWindow, sal_Int8 nDragSourceActions, const GrantAccess& );
void copyToClipboard( vcl::Window* _pWindow, const GrantAccess& );
void setClipboardListener( const Link<OLocalExchange&,void>& _rListener ) { m_aClipboardListener = _rListener; }
void clear();
static bool hasFormat( const DataFlavorExVector& _rFormats, SotClipboardFormatId _nFormatId );
protected:
// XClipboardOwner
virtual void SAL_CALL lostOwnership( const css::uno::Reference< css::datatransfer::clipboard::XClipboard >& _rxClipboard, const css::uno::Reference< css::datatransfer::XTransferable >& _rxTrans ) override;
// TransferableHelper
virtual void DragFinished( sal_Int8 nDropAction ) override;
virtual bool GetData( const css::datatransfer::DataFlavor& rFlavor, const OUString& rDestDoc ) override;
private:
// don't allow this base class method to be called from outside
using TransferableHelper::StartDrag;
};
//= OLocalExchangeHelper
/// a helper for navigator windows (SvTreeListBox'es) which allow DnD within themself
class UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) OLocalExchangeHelper
{
protected:
VclPtr<vcl::Window> m_pDragSource;
rtl::Reference<OLocalExchange> m_xTransferable;
public:
OLocalExchangeHelper( vcl::Window* _pDragSource );
virtual ~OLocalExchangeHelper();
void prepareDrag( );
void startDrag( sal_Int8 nDragSourceActions );
void copyToClipboard( ) const;
bool isDragSource() const { return m_xTransferable.is() && m_xTransferable->isDragging(); }
bool isClipboardOwner() const { return m_xTransferable.is() && m_xTransferable->isClipboardOwner(); }
bool isDataExchangeActive( ) const { return isDragSource() || isClipboardOwner(); }
void clear() { if ( isDataExchangeActive() ) m_xTransferable->clear(); }
SVX_DLLPRIVATE void setClipboardListener( const Link<OLocalExchange&,void>& _rListener ) { if ( m_xTransferable.is() ) m_xTransferable->setClipboardListener( _rListener ); }
protected:
SVX_DLLPRIVATE virtual OLocalExchange* createExchange() const = 0;
protected:
SVX_DLLPRIVATE void implReset();
};
class OControlTransferData
{
private:
DataFlavorExVector m_aCurrentFormats;
protected:
ListBoxEntrySet m_aSelectedEntries;
css::uno::Sequence< css::uno::Sequence< sal_uInt32 > >
m_aControlPaths;
css::uno::Sequence< css::uno::Reference< css::uno::XInterface > >
m_aHiddenControlModels;
css::uno::Reference< css::form::XForms >
m_xFormsRoot; // the root of the forms collection where the entries we represent reside
// this uniquely identifies the page and the document
SvTreeListEntry* m_pFocusEntry;
protected:
// updates m_aCurrentFormats with all formats we currently could supply
void updateFormats( );
public:
OControlTransferData( );
// ctor to construct the data from an arbitrary Transferable (usually clipboard data)
OControlTransferData(
const css::uno::Reference< css::datatransfer::XTransferable >& _rxTransferable
);
inline const DataFlavorExVector& GetDataFlavorExVector() const;
void addSelectedEntry( SvTreeListEntry* _pEntry );
void setFocusEntry( SvTreeListEntry* _pFocusEntry );
/** notifies the data transfer object that a certain entry has been removed from the owning tree
In case the removed entry is part of the transfer object's selection, the entry is removed from
the selection.
@param _pEntry
@return the number of entries remaining in the selection.
*/
size_t onEntryRemoved( SvTreeListEntry* _pEntry );
void setFormsRoot(
const css::uno::Reference< css::form::XForms >& _rxFormsRoot
) { m_xFormsRoot = _rxFormsRoot; }
void buildPathFormat(SvTreeListBox const * pTreeBox, SvTreeListEntry const * pRoot);
// assembles m_aControlPaths from m_aSelectedEntries
// (it is assumed that the entries are sorted in m_aSelectedEntries with respect to the neighbor relationship)
void buildListFromPath(SvTreeListBox const * pTreeBox, SvTreeListEntry* pRoot);
// The reverse way: throws everything out of m_aSelectedEntries and rebuilds it using m_aControlPaths
void addHiddenControlsFormat(const css::uno::Sequence< css::uno::Reference< css::uno::XInterface > >& seqInterfaces);
// adds an SVX_FML_HIDDEN_CONTROLS format and remembers the passed interfaces for it
// (it is NOT checked whether actually only hidden controls are denominated
// by this - the caller must ensure that)
const ListBoxEntrySet& selected() const { return m_aSelectedEntries; }
const css::uno::Sequence< css::uno::Reference< css::uno::XInterface > >&
hiddenControls() const { return m_aHiddenControlModels; }
const css::uno::Reference< css::form::XForms >&
getFormsRoot() const { return m_xFormsRoot; }
};
inline const DataFlavorExVector& OControlTransferData::GetDataFlavorExVector() const
{
const_cast< OControlTransferData* >( this )->updateFormats( );
return m_aCurrentFormats;
}
class OControlExchange : public OLocalExchange, public OControlTransferData
{
public:
OControlExchange( );
public:
static SotClipboardFormatId getFieldExchangeFormatId( );
static SotClipboardFormatId getControlPathFormatId( );
static SotClipboardFormatId getHiddenControlModelsFormatId( );
inline static bool hasFieldExchangeFormat( const DataFlavorExVector& _rFormats );
inline static bool hasControlPathFormat( const DataFlavorExVector& _rFormats );
inline static bool hasHiddenControlModelsFormat( const DataFlavorExVector& _rFormats );
protected:
virtual bool GetData( const css::datatransfer::DataFlavor& rFlavor, const OUString& rDestDoc ) override;
virtual void AddSupportedFormats() override;
};
class OControlExchangeHelper : public OLocalExchangeHelper
{
public:
OControlExchangeHelper(vcl::Window* _pDragSource) : OLocalExchangeHelper(_pDragSource) { }
OControlExchange* operator->() const { return static_cast< OControlExchange* >( m_xTransferable.get() ); }
OControlExchange& operator*() const { return *static_cast< OControlExchange* >( m_xTransferable.get() ); }
protected:
virtual OLocalExchange* createExchange() const override;
};
inline bool OControlExchange::hasFieldExchangeFormat( const DataFlavorExVector& _rFormats )
{
return hasFormat( _rFormats, getFieldExchangeFormatId() );
}
inline bool OControlExchange::hasControlPathFormat( const DataFlavorExVector& _rFormats )
{
return hasFormat( _rFormats, getControlPathFormatId() );
}
inline bool OControlExchange::hasHiddenControlModelsFormat( const DataFlavorExVector& _rFormats )
{
return hasFormat( _rFormats, getHiddenControlModelsFormatId() );
}
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
