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
|
/* -*- 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_FORMS_SOURCE_XFORMS_SUBMISSION_HXX
#define INCLUDED_FORMS_SOURCE_XFORMS_SUBMISSION_HXX
#include <cppuhelper/implbase.hxx>
#include "propertysetbase.hxx"
#include <com/sun/star/lang/XUnoTunnel.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>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include "computedexpression.hxx"
// forward declaractions
namespace com::sun::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::ImplInheritanceHelper<
PropertySetBase,
css::lang::XUnoTunnel,
css::xforms::XSubmission
> Submission_t;
class Submission : public Submission_t
{
// submission properties
OUString msID;
OUString msBind;
ComputedExpression maRef;
OUString msAction;
OUString msMethod;
OUString msVersion;
bool mbIndent;
OUString msMediaType;
OUString msEncoding;
bool mbOmitXmlDeclaration;
bool mbStandalone;
OUString msCDataSectionElement;
OUString msReplace;
OUString msSeparator;
css::uno::Sequence< OUString > msIncludeNamespacePrefixes;
private:
/// the Model to which this Submission belongs; may be NULL
css::uno::Reference<css::xforms::XModel> mxModel;
// this will extract the document from the model that will be submitted
css::uno::Reference< css::xml::dom::XDocumentFragment >
createSubmissionDocument(const css::uno::Reference< css::xml::xpath::XXPathObject >& aObject,
bool bRemoveWSNodes);
static css::uno::Reference< css::xml::dom::XDocument >
getInstanceDocument(const css::uno::Reference< css::xml::xpath::XXPathObject >& aObject);
public:
Submission();
virtual ~Submission() throw() override;
// property methods: get/set value
/// get XForms model
css::uno::Reference<css::xforms::XModel>
getModel() const { return mxModel;}
/// set XForms model
void setModel(
const css::uno::Reference<css::xforms::XModel>& );
OUString getID() const { return msID;} /// get ID for this submission
void setID( const OUString& ); /// set ID for this submission
OUString getBind() const { return msBind;}
void setBind( const OUString& );
OUString getRef() const;
void setRef( const OUString& );
OUString getAction() const { return msAction;}
void setAction( const OUString& );
OUString getMethod() const { return msMethod;}
void setMethod( const OUString& );
OUString getVersion() const { return msVersion;}
void setVersion( const OUString& );
bool getIndent() const { return mbIndent;}
void setIndent( bool );
OUString getMediaType() const { return msMediaType;}
void setMediaType( const OUString& );
OUString getEncoding() const { return msEncoding;}
void setEncoding( const OUString& );
bool getOmitXmlDeclaration() const { return mbOmitXmlDeclaration;}
void setOmitXmlDeclaration( bool );
bool getStandalone() const { return mbStandalone;}
void setStandalone( bool );
OUString getCDataSectionElement() const { return msCDataSectionElement;}
void setCDataSectionElement( const OUString& );
OUString getReplace() const { return msReplace;}
void setReplace( const OUString& );
OUString getSeparator() const { return msSeparator;}
void setSeparator( const OUString& );
css::uno::Sequence< OUString > getIncludeNamespacePrefixes() const { return msIncludeNamespacePrefixes;}
void setIncludeNamespacePrefixes( const css::uno::Sequence< OUString >& );
/** perform the submission
* @returns if submission was successful */
bool doSubmit( const css::uno::Reference< css::task::XInteractionHandler >& aHandler );
// helpers for UNO tunnel
static css::uno::Sequence<sal_Int8> getUnoTunnelId();
private:
/// check whether object is live, and throw suitable exception if not
/// (to be used be API methods before acting on the object)
///
/// @throws css::uno::RuntimeException
void liveCheck();
/// get the model implementation
xforms::Model* getModelImpl() const;
protected:
// XPropertySet & friends:
// implement abstract methods from PropertySetHelper
virtual sal_Bool SAL_CALL convertFastPropertyValue(
css::uno::Any& rConvertedValue,
css::uno::Any& rOldValue,
sal_Int32 nHandle,
const css::uno::Any& rValue ) override;
private:
void initializePropertySet();
public:
// XNamed:
// get/set name
virtual OUString SAL_CALL getName() override;
virtual void SAL_CALL setName( const OUString& ) override;
// XUnoTunnel
virtual sal_Int64 SAL_CALL getSomething(
const css::uno::Sequence<sal_Int8>& ) override;
// XSubmission
virtual void SAL_CALL submit( ) override;
virtual void SAL_CALL submitWithInteraction(
const css::uno::Reference< css::task::XInteractionHandler >& aHandler ) override;
virtual void SAL_CALL addSubmissionVetoListener(
const css::uno::Reference< css::form::submission::XSubmissionVetoListener >& listener ) override;
virtual void SAL_CALL removeSubmissionVetoListener(
const css::uno::Reference< css::form::submission::XSubmissionVetoListener >& listener ) override;
// XPropertySet
// (need to disambiguate this)
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo( ) override;
virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
};
} // namespace xforms
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|