include/xmloff/formlayerexport.hxx

   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 #ifndef INCLUDED_XMLOFF_FORMLAYEREXPORT_HXX
  21 #define INCLUDED_XMLOFF_FORMLAYEREXPORT_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <rtl/ustring.hxx>
  26 #include <salhelper/simplereferenceobject.hxx>
  27 #include <memory>
  28
  29 namespace com { namespace sun { namespace star { namespace awt {
  30     class XControlModel;
  31 } } } }
  32
  33 namespace com { namespace sun { namespace star { namespace drawing { class XDrawPage; } } } }
  34 namespace com { namespace sun { namespace star { namespace beans { class XPropertySet; } } } }
  35 namespace com { namespace sun { namespace star { namespace uno { template <typename > class Reference; } } } }
  36
  37 class SvXMLExport;
  38
  39 namespace xmloff
  40 {
  41
  42
  43     class OFormLayerXMLExport_Impl;
  44     class OFormsRootExport;
  45
  46
  47     //= OFormLayerXMLExport
  48
  49     /** provides functionality for exporting a complete form layer.
  50     */
  51     class XMLOFF_DLLPUBLIC OFormLayerXMLExport
  52                 :public ::salhelper::SimpleReferenceObject
  53     {
  54         // impl class
  55         std::unique_ptr<OFormLayerXMLExport_Impl> m_pImpl;
  56
  57     protected:
  58         virtual ~OFormLayerXMLExport() override;
  59
  60     public:
  61         OFormLayerXMLExport(SvXMLExport& _rContext);
  62
  63         /** initializes some internal structures for fast access to the given page
  64
  65             <p>This method has to be called before you use getControlId for controls on the given page.
  66             This way a performance optimization can be done for faster access to the control ids</p>
  67
  68             @return
  69                 <TRUE/> if the page has been examined before. If <FALSE/> is returned, this is a serious error.
  70
  71             @see getControlId
  72             @see examineForms
  73         */
  74         bool seekPage(
  75             const css::uno::Reference< css::drawing::XDrawPage >& _rxDrawPage);
  76
  77         /** get the id for the given control
  78
  79             <p>The page the control belongs to must have been examined and sought to.</p>
  80
  81             @param _rxControl
  82                 the control which's id should be retrieved. Must not be <NULL/>.
  83
  84             @see examineForms
  85             @see seekPage
  86
  87         */
  88         OUString getControlId(
  89             const css::uno::Reference< css::beans::XPropertySet >& _rxControl);
  90
  91         /** retrieves the style name for the control's number style.
  92
  93             <p>For performance reasons, this method is allowed to be called for any controls, even those which
  94             do not have a number style. In this case, an empty string is returned.</p>
  95
  96             @param _rxControl
  97                 the control which's id should be retrieved. Must not be <NULL/>.
  98
  99             @see examineForms
 100             @see seekPage
 101         */
 102         OUString getControlNumberStyle(
 103             const css::uno::Reference< css::beans::XPropertySet >& _rxControl );
 104
 105         /** examines the forms collection given.
 106
 107             <p>This method will collect all form layer related data of the given draw page</p>
 108
 109             @param _rxDrawPage
 110                 the draw page to examine. The object will be queried for a com.sun.star.form::XFormsSupplier
 111                 interface to obtain the forms container.
 112         */
 113         void examineForms(const css::uno::Reference< css::drawing::XDrawPage >& _rxDrawPage);
 114
 115         /** exports the structure of a form layer
 116
 117             <p>This method does not export styles (e.g. font properties of the controls), or any references
 118             external instances may have to the control models contained in the form layer (e.g. uno control
 119             shapes in the drawing layer may have such references)</p>
 120
 121             <p>No top level element describing the whole collection is inserted. I.e. if within your document, you
 122             expect the forms collection to be stored like
 123                 <listing>
 124                     &lt;Forms&gt;
 125                         ....    // all the forms stuff here
 126                     &lt;/Forms&gt;
 127                 </listing>
 128             you have to start the Forms element yourself.</p>
 129
 130             @param  _rxDrawPage
 131                 the draw page to examine. The object will be queried for a com.sun.star.form::XFormsSupplier
 132                 interface to obtain the forms container.
 133         */
 134         void exportForms(const css::uno::Reference< css::drawing::XDrawPage >& _rxDrawPage);
 135
 136         /** exports the XForms model data
 137         */
 138         void exportXForms() const;
 139
 140         /** determines whether the given page contains logical forms
 141         */
 142         static bool pageContainsForms( const css::uno::Reference< css::drawing::XDrawPage >& _rxDrawPage );
 143
 144         /** determines whether the given page contains XForm instances
 145         */
 146         bool documentContainsXForms() const;
 147
 148         /** exports the automatic controls number styles
 149         */
 150         void exportAutoControlNumberStyles();
 151
 152         /** exports the auto-styles collected during the examineForms calls
 153         */
 154         void exportAutoStyles();
 155
 156         /** exclude the given control (model) from export.
 157
 158             <p>If your document contains form controls which are not to be exported for whatever reason,
 159             you need to announce the models of these controls (can be retrieved from XControlShape::getControl)
 160             to the form layer exporter.<br/>
 161             Of course you have to do this before calling <member>exportForms</member></p>
 162         */
 163         void excludeFromExport( const css::uno::Reference< css::awt::XControlModel >& _rxControl );
 164     };
 165
 166
 167     //= OOfficeFormsExport
 168
 169     /// export helper for the office::forms element
 170     class XMLOFF_DLLPUBLIC OOfficeFormsExport
 171     {
 172     private:
 173         std::unique_ptr<OFormsRootExport>  m_pImpl;
 174
 175     public:
 176         OOfficeFormsExport( SvXMLExport& _rExp );
 177         ~OOfficeFormsExport();
 178     };
 179
 180
 181 }   // namespace xmloff
 182
 183
 184 #endif // INCLUDED_XMLOFF_FORMLAYEREXPORT_HXX
 185
 186 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */