LibreOffice Module xmloff (master) 1
officeforms.cxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include "officeforms.hxx"
21
23
24#include <xmloff/xmltoken.hxx>
26#include <xmloff/xmlexp.hxx>
27#include <xmloff/xmlimp.hxx>
29#include <com/sun/star/frame/XModel.hpp>
32#include "strings.hxx"
33
34namespace xmloff
35{
36
37 using namespace ::com::sun::star::uno;
38 using namespace ::com::sun::star::beans;
39 using namespace ::com::sun::star::xml;
41 using ::com::sun::star::xml::sax::XFastAttributeList;
42
43 //= OFormsRootImport
44 OFormsRootImport::OFormsRootImport( SvXMLImport& rImport )
45 :SvXMLImportContext(rImport)
46 {
47 }
48
50 {
51 }
52
53 css::uno::Reference< css::xml::sax::XFastContextHandler > OFormsRootImport::createFastChildContext(
54 sal_Int32 _nElement,
55 const css::uno::Reference< css::xml::sax::XFastAttributeList>& xAttrList )
56 {
57 SvXMLImportContext* pRet = nullptr;
58 try
59 {
60 pRet = GetImport().GetFormImport()->createContext( _nElement, xAttrList );
61 } catch (const Exception&)
62 {
63 DBG_UNHANDLED_EXCEPTION("xmloff.forms");
64 }
65 return pRet;
66 }
67
68 void OFormsRootImport::implImportBool(const Reference< XFastAttributeList >& _rxAttributes, OfficeFormsAttributes _eAttribute,
69 const Reference< XPropertySet >& _rxProps, const Reference< XPropertySetInfo >& _rxPropInfo,
70 const OUString& _rPropName, bool _bDefault)
71 {
72 // the complete attribute name to look for
73 sal_Int32 nCompleteAttributeName = XML_ELEMENT(
74 FORM,
76
77 // get and convert the value
78 OUString sAttributeValue = _rxAttributes->getOptionalValue(nCompleteAttributeName);
79 bool bValue = _bDefault;
80 (void)::sax::Converter::convertBool(bValue, sAttributeValue);
81
82 // set the property
83 if (_rxPropInfo->hasPropertyByName(_rPropName))
84 {
85 _rxProps->setPropertyValue(_rPropName, Any(bValue));
86 }
87 }
88
89 void OFormsRootImport::startFastElement( sal_Int32 /*nElement*/, const Reference< XFastAttributeList >& _rxAttrList )
90 {
91 ENTER_LOG_CONTEXT( "xmloff::OFormsRootImport - importing the complete tree" );
92
93 try
94 {
95 Reference< XPropertySet > xDocProperties(GetImport().GetModel(), UNO_QUERY);
96 if ( xDocProperties.is() )
97 { // an empty model is allowed: when doing a copy'n'paste from e.g. Writer to Calc,
98 // this is done via streaming the controls as XML.
99 Reference< XPropertySetInfo > xDocPropInfo;
100 if (xDocProperties.is())
101 xDocPropInfo = xDocProperties->getPropertySetInfo();
102
103 implImportBool(_rxAttrList, ofaAutomaticFocus, xDocProperties, xDocPropInfo, PROPERTY_AUTOCONTROLFOCUS, false);
104 implImportBool(_rxAttrList, ofaApplyDesignMode, xDocProperties, xDocPropInfo, PROPERTY_APPLYDESIGNMODE, true);
105 }
106 }
107 catch(Exception&)
108 {
109 TOOLS_WARN_EXCEPTION("xmloff.forms",
110 "caught an exception while setting the document properties!");
111 }
112 }
113
115 {
117 }
118
119 //= OFormsRootExport
121 {
122 addModelAttributes(_rExp);
123
124 m_pImplElement.reset( new SvXMLElementExport(_rExp, XML_NAMESPACE_OFFICE, XML_FORMS, true, true) );
125 }
126
128 {
129 }
130
132 const Reference< XPropertySet >& _rxProps, const Reference< XPropertySetInfo >& _rxPropInfo,
133 const OUString& _rPropName, bool _bDefault)
134 {
135 // retrieve the property value
136 bool bValue = _bDefault;
137 if (_rxPropInfo->hasPropertyByName(_rPropName))
138 bValue = ::cppu::any2bool(_rxProps->getPropertyValue(_rPropName));
139
140 // convert into a string
141 OUStringBuffer aValue;
142 ::sax::Converter::convertBool(aValue, bValue);
143
144 // add the attribute
145 _rExp.AddAttribute(
148 aValue.makeStringAndClear());
149 }
150
152 {
153 try
154 {
155 Reference< XPropertySet > xDocProperties(_rExp.GetModel(), UNO_QUERY);
156 if ( xDocProperties.is() )
157 { // an empty model is allowed: when doing a copy'n'paste from e.g. Writer to Calc,
158 // this is done via streaming the controls as XML.
159 Reference< XPropertySetInfo > xDocPropInfo;
160 if (xDocProperties.is())
161 xDocPropInfo = xDocProperties->getPropertySetInfo();
162
163 implExportBool(_rExp, ofaAutomaticFocus, xDocProperties, xDocPropInfo, PROPERTY_AUTOCONTROLFOCUS, false);
164 implExportBool(_rExp, ofaApplyDesignMode, xDocProperties, xDocPropInfo, PROPERTY_APPLYDESIGNMODE, true);
165 }
166 }
167 catch(Exception&)
168 {
169 TOOLS_WARN_EXCEPTION("xmloff.forms",
170 "caught an exception while retrieving the document properties!");
171 }
172 }
173
174} // namespace xmloff
175
176/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void AddAttribute(sal_uInt16 nPrefix, const OUString &rName, const OUString &rValue)
Definition: xmlexp.cxx:907
const css::uno::Reference< css::frame::XModel > & GetModel() const
Definition: xmlexp.hxx:411
This class deliberately does not support XWeak, to improve performance when loading large documents.
Definition: xmlictxt.hxx:48
SvXMLImport & GetImport()
Definition: xmlictxt.hxx:60
static bool convertBool(bool &rBool, std::u16string_view rString)
static xmloff::token::XMLTokenEnum getOfficeFormsAttributeToken(OfficeFormsAttributes _eAttrib)
static OUString getOfficeFormsAttributeName(OfficeFormsAttributes _eAttrib)
calculates the xml attribute representation of an attribute of the office:forms element
static sal_uInt16 getOfficeFormsAttributeNamespace()
calculates the xml namedspace key of an attribute of the office:forms element
std::unique_ptr< SvXMLElementExport > m_pImplElement
Definition: officeforms.hxx:68
static void implExportBool(SvXMLExport &_rExp, OfficeFormsAttributes _eAttribute, const css::uno::Reference< css::beans::XPropertySet > &_rxProps, const css::uno::Reference< css::beans::XPropertySetInfo > &_rxPropInfo, const OUString &_rPropName, bool _bDefault)
static void addModelAttributes(SvXMLExport &_rExp)
OFormsRootExport(SvXMLExport &_rExp)
static void implImportBool(const css::uno::Reference< css::xml::sax::XFastAttributeList > &_rxAttributes, OfficeFormsAttributes _eAttribute, const css::uno::Reference< css::beans::XPropertySet > &_rxProps, const css::uno::Reference< css::beans::XPropertySetInfo > &_rxPropInfo, const OUString &_rPropName, bool _bDefault)
Definition: officeforms.cxx:68
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext(sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
Definition: officeforms.cxx:53
virtual void SAL_CALL startFastElement(sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &xAttrList) override
Definition: officeforms.cxx:89
OFormsRootImport(SvXMLImport &_rImport)
Definition: officeforms.cxx:44
virtual ~OFormsRootImport() override
Definition: officeforms.cxx:49
virtual void SAL_CALL endFastElement(sal_Int32 nElement) override
endFastElement is called before a context will be destructed, but after an elements context has been ...
#define TOOLS_WARN_EXCEPTION(area, stream)
#define DBG_UNHANDLED_EXCEPTION(...)
#define LEAVE_LOG_CONTEXT()
Definition: logging.hxx:53
#define ENTER_LOG_CONTEXT(name)
Definition: logging.hxx:52
@ Exception
FORM
@ ofaApplyDesignMode
constexpr OUStringLiteral PROPERTY_AUTOCONTROLFOCUS
Definition: strings.hxx:110
constexpr OUStringLiteral PROPERTY_APPLYDESIGNMODE
Definition: strings.hxx:111
#define XML_ELEMENT(prefix, name)
Definition: xmlimp.hxx:97
constexpr sal_uInt16 XML_NAMESPACE_OFFICE