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
|
/* -*- 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 EXTENSIONS_SOURCE_PROPCTRLR_EFORMSHELPER_HXX
#define EXTENSIONS_SOURCE_PROPCTRLR_EFORMSHELPER_HXX
#include "pcrcommon.hxx"
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/xforms/XModel.hpp>
#include <com/sun/star/xforms/XFormsSupplier.hpp>
#include <com/sun/star/form/binding/XBindableValue.hpp>
#include <com/sun/star/form/binding/XListEntrySource.hpp>
#include <osl/mutex.hxx>
#include <rtl/ustring.hxx>
#include <comphelper/listenernotification.hxx>
#include <vector>
#include <set>
#include <map>
namespace pcr
{
typedef ::std::map< OUString, ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >, ::std::less< OUString > >
MapStringToPropertySet;
//= EFormsHelper
class EFormsHelper
{
protected:
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
m_xControlModel;
::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XBindableValue >
m_xBindableControl;
::com::sun::star::uno::Reference< ::com::sun::star::xforms::XFormsSupplier >
m_xDocument;
PropertyChangeListeners
m_aPropertyListeners;
MapStringToPropertySet
m_aSubmissionUINames; // only filled upon request
MapStringToPropertySet
m_aBindingUINames; // only filled upon request
public:
EFormsHelper(
::osl::Mutex& _rMutex,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControlModel,
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument
);
/** determines whether the given document is an eForm
If this method returns <FALSE/>, you cannot instantiate a EFormsHelper with
this document, since then no of it's functionality will be available.
*/
static bool
isEForm(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument
) SAL_THROW(());
/** registers a listener to be notified when any aspect of the binding changes.
The listener will be registered at the current binding of the control model. If the binding
changes (see <method>setBinding</method>), the listener will be revoked from the old binding,
registered at the new binding, and for all properties which differ between both bindings,
the listener will be notified.
@see revokeBindingListener
*/
void registerBindingListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxBindingListener
);
/** revokes the binding listener which has previously been registered
@see registerBindingListener
*/
void revokeBindingListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxBindingListener
);
/** checks whether it's possible to bind the control model to a given XSD data type
@param _nDataType
the data type which should be bound. If this is -1, <TRUE/> is returned if the control model
can be bound to <em>any</em> data type.
*/
bool canBindToDataType( sal_Int32 _nDataType = -1 ) const SAL_THROW(());
/** checks whether the control model can be bound to any XSD data type
*/
bool canBindToAnyDataType() const SAL_THROW(()) { return canBindToDataType( -1 ); }
/** checks whether the control model is a source for list entries, as supplied by XML data bindings
*/
bool isListEntrySink() const SAL_THROW(());
/** retrieves the names of all XForms models in the document the control lives in
*/
void getFormModelNames( ::std::vector< OUString >& /* [out] */ _rModelNames ) const SAL_THROW(());
/** retrieves the names of all bindings for a given model
@see getFormModelNames
*/
void getBindingNames( const OUString& _rModelName, ::std::vector< OUString >& /* [out] */ _rBindingNames ) const SAL_THROW(());
/// retrieves the XForms model (within the control model's document) with the given name
::com::sun::star::uno::Reference< ::com::sun::star::xforms::XModel >
getFormModelByName( const OUString& _rModelName ) const SAL_THROW(());
/** retrieves the model which the active binding of the control model belongs to
*/
::com::sun::star::uno::Reference< ::com::sun::star::xforms::XModel >
getCurrentFormModel() const SAL_THROW(());
/** retrieves the name of the model which the active binding of the control model belongs to
*/
OUString
getCurrentFormModelName() const SAL_THROW(());
/** retrieves the binding instance which is currently attached to the control model
*/
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
getCurrentBinding() const SAL_THROW(());
/** retrieves the name of the binding instance which is currently attached to the control model
*/
OUString
getCurrentBindingName() const SAL_THROW(());
/** sets a new binding at the control model
*/
void setBinding( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxBinding ) SAL_THROW(());
/** retrieves the binding instance which is currently used as list source for the control model
@see isListEntrySink
*/
::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >
getCurrentListSourceBinding() const SAL_THROW(());
/** sets a new list source at the control model
@see isListEntrySink
*/
void setListSourceBinding( const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XListEntrySource >& _rxListSource ) SAL_THROW(());
/** retrieves a given binding for a given model, or creates a new one
@param _rTargetModel
the name of the model to create a binding for. Must not be empty
@param _rBindingName
the name of the binding to retrieve. If the model denoted by <arg>_rTargetModel</arg> does not
have a binding with this name, a new binding is created and returned.
*/
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
getOrCreateBindingForModel( const OUString& _rTargetModel, const OUString& _rBindingName ) const SAL_THROW(());
/** types of sub-elements of a model
*/
enum ModelElementType
{
Submission,
Binding
};
/** retrieves the name of a model's sub-element, as to be shown in the UI
@see getModelElementFromUIName
@see getAllElementUINames
*/
OUString
getModelElementUIName(
const ModelElementType _eType,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxElement
) const SAL_THROW(());
/** retrieves the submission object for an UI name
Note that <member>getAllElementUINames</member> must have been called before, for the given element type
@see getModelElementUIName
@see getAllElementUINames
*/
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
getModelElementFromUIName(
const ModelElementType _eType,
const OUString& _rUIName
) const SAL_THROW(());
/** retrieves the UI names of all elements of all models in our document
@param _eType
the type of elements for which the names should be retrieved
@param _rElementNames
the array of element names
@see getModelElementUIName
@see getModelElementFromUIName
*/
void getAllElementUINames(
const ModelElementType _eType,
::std::vector< OUString >& /* [out] */ _rElementNames,
bool _bPrepentEmptyEntry
);
protected:
void firePropertyChanges(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxOldProps,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxNewProps,
::std::set< OUString >& _rFilter
) const;
/** fires a change in a single property, if the property value changed, and if we have a listener
interested in property changes
*/
void firePropertyChange(
const OUString& _rName,
const ::com::sun::star::uno::Any& _rOldValue,
const ::com::sun::star::uno::Any& _rNewValue
) const;
private:
void impl_switchBindingListening_throw( bool _bDoListening, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener );
/// implementation for both <member>getOrCreateBindingForModel</member>
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
implGetOrCreateBinding( const OUString& _rTargetModel, const OUString& _rBindingName ) const SAL_THROW(());
void
impl_toggleBindingPropertyListening_throw( bool _bDoListen, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxConcreteListenerOrNull );
private:
EFormsHelper(); // never implemented
EFormsHelper( const EFormsHelper& ); // never implemented
EFormsHelper& operator=( const EFormsHelper& ); // never implemented
};
} // namespace pcr
#endif // EXTENSIONS_SOURCE_PROPCTRLR_EFORMSHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
