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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SUBMISSION_HXX
#define _SUBMISSION_HXX
// includes for parent classes
#include <cppuhelper/implbase2.hxx>
#include <propertysetbase.hxx>
#include <com/sun/star/util/XModifyBroadcaster.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/xml/dom/events/XEventListener.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <com/sun/star/xml/dom/XNode.hpp>
#include <com/sun/star/xml/dom/XDocument.hpp>
#include <com/sun/star/xml/dom/XDocumentFragment.hpp>
#include <com/sun/star/xml/xpath/XXPathObject.hpp>
#include <com/sun/star/xforms/XSubmission.hpp>
// includes for member variables
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <computedexpression.hxx>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
// forward declaractions
namespace com { namespace sun { namespace star {
namespace xforms { class XModel; }
namespace uno { class Any; }
namespace beans { class UnknownPropertyException;
class PropertyVetoException; }
namespace lang { class IllegalArgumentException;
class WrappedTargetException; }
} } }
namespace xforms { class Model; }
namespace xforms
{
/** An XForms submission.
*
* See http://www.w3.org/TR/xforms/ for more information.
*/
typedef cppu::ImplInheritanceHelper2<
PropertySetBase,
com::sun::star::lang::XUnoTunnel,
com::sun::star::xforms::XSubmission
> Submission_t;
class Submission : public Submission_t
{
// submission properties
rtl::OUString msID;
rtl::OUString msBind;
ComputedExpression maRef;
rtl::OUString msAction;
rtl::OUString msMethod;
rtl::OUString msVersion;
bool mbIndent;
rtl::OUString msMediaType;
rtl::OUString msEncoding;
bool mbOmitXmlDeclaration;
bool mbStandalone;
rtl::OUString msCDataSectionElement;
rtl::OUString msReplace;
rtl::OUString msSeparator;
com::sun::star::uno::Sequence< rtl::OUString > msIncludeNamespacePrefixes;
private:
/// the Model to which this Submission belongs; may be NULL
com::sun::star::uno::Reference<com::sun::star::xforms::XModel> mxModel;
// this will extract the document from the model that will be submitted
com::sun::star::uno::Reference< com::sun::star::xml::dom::XDocumentFragment >
createSubmissionDocument(const com::sun::star::uno::Reference< com::sun::star::xml::xpath::XXPathObject >& aObject,
sal_Bool bRemoveWSNodes = sal_False);
com::sun::star::uno::Reference< com::sun::star::xml::dom::XDocument >
getInstanceDocument(const com::sun::star::uno::Reference< com::sun::star::xml::xpath::XXPathObject >& aObject);
com::sun::star::uno::Reference<com::sun::star::lang::XMultiServiceFactory > m_aFactory;
public:
Submission();
virtual ~Submission() throw();
//
// property methods: get/set value
//
/// get XForms model
com::sun::star::uno::Reference<com::sun::star::xforms::XModel>
getModel() const;
/// set XForms model
void setModel(
const com::sun::star::uno::Reference<com::sun::star::xforms::XModel>& );
rtl::OUString getID() const; /// get ID for this submission
void setID( const rtl::OUString& ); /// set ID for this submission
rtl::OUString getBind() const;
void setBind( const rtl::OUString& );
rtl::OUString getRef() const;
void setRef( const rtl::OUString& );
rtl::OUString getAction() const;
void setAction( const rtl::OUString& );
rtl::OUString getMethod() const;
void setMethod( const rtl::OUString& );
rtl::OUString getVersion() const;
void setVersion( const rtl::OUString& );
bool getIndent() const;
void setIndent( bool );
rtl::OUString getMediaType() const;
void setMediaType( const rtl::OUString& );
rtl::OUString getEncoding() const;
void setEncoding( const rtl::OUString& );
bool getOmitXmlDeclaration() const;
void setOmitXmlDeclaration( bool );
bool getStandalone() const;
void setStandalone( bool );
rtl::OUString getCDataSectionElement() const;
void setCDataSectionElement( const rtl::OUString& );
rtl::OUString getReplace() const;
void setReplace( const rtl::OUString& );
rtl::OUString getSeparator() const;
void setSeparator( const rtl::OUString& );
com::sun::star::uno::Sequence< rtl::OUString > getIncludeNamespacePrefixes() const;
void setIncludeNamespacePrefixes( const com::sun::star::uno::Sequence< rtl::OUString >& );
/** perform the submission
* @returns if submission was successful */
bool doSubmit( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler );
/// release the model (note: Binding is unusable without model)
void releaseModel();
// helpers for UNO tunnel
static com::sun::star::uno::Sequence<sal_Int8> getUnoTunnelID();
static Submission* getSubmission( const com::sun::star::uno::Reference<com::sun::star::beans::XPropertySet>& );
private:
/// check whether object is live, and throw suitable exception if not
/// (to be used be API methods before acting on the object)
void liveCheck()
throw( com::sun::star::uno::RuntimeException );
/// get the model implementation
xforms::Model* getModelImpl() const;
xforms::Model* getModelImpl( const com::sun::star::uno::Reference<com::sun::star::xforms::XModel>& xModel ) const;
protected:
//
// XPropertySet & friends:
// implement abstract methods from PropertySetHelper
//
virtual sal_Bool SAL_CALL convertFastPropertyValue(
com::sun::star::uno::Any& rConvertedValue,
com::sun::star::uno::Any& rOldValue,
sal_Int32 nHandle,
const com::sun::star::uno::Any& rValue )
throw ( com::sun::star::lang::IllegalArgumentException );
private:
void initializePropertySet();
public:
//
// XNamed:
// get/set name
//
virtual rtl::OUString SAL_CALL getName()
throw( com::sun::star::uno::RuntimeException );
virtual void SAL_CALL setName( const rtl::OUString& )
throw( com::sun::star::uno::RuntimeException );
//
// XUnoTunnel
//
virtual sal_Int64 SAL_CALL getSomething(
const com::sun::star::uno::Sequence<sal_Int8>& )
throw( com::sun::star::uno::RuntimeException );
//
// XSubmission
//
virtual void SAL_CALL submit( )
throw ( com::sun::star::util::VetoException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL submitWithInteraction(
const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler )
throw ( com::sun::star::util::VetoException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL addSubmissionVetoListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener )
throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeSubmissionVetoListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener )
throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
//
// XPropertySet
// (need to disambiguate this)
virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo( ) throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setPropertyValue( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Any& aValue ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue( const ::rtl::OUString& PropertyName ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addPropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& xListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removePropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
};
} // namespace xforms
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|