include/xmloff/formlayerimport.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_FORMLAYERIMPORT_HXX
  21 #define INCLUDED_XMLOFF_FORMLAYERIMPORT_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <salhelper/simplereferenceobject.hxx>
  27 #include <memory>
  28
  29 namespace com { namespace sun { namespace star { namespace beans { class XPropertySet; } } } }
  30 namespace com { namespace sun { namespace star { namespace drawing { class XDrawPage; } } } }
  31 namespace com { namespace sun { namespace star { namespace xml { namespace sax { class XAttributeList; } } } } }
  32
  33 class SvXMLImport;
  34 class SvXMLImportContext;
  35 class SvXMLStylesContext;
  36
  37
  38 namespace xmloff
  39 {
  40
  41
  42     //= OFormLayerXMLImport
  43
  44     class OFormLayerXMLImport_Impl;
  45     /** allows you to import a &lt;form:form&gt; element
  46     */
  47     class XMLOFF_DLLPUBLIC OFormLayerXMLImport
  48                 :public ::salhelper::SimpleReferenceObject
  49     {
  50         std::unique_ptr<OFormLayerXMLImport_Impl>   m_pImpl;
  51
  52     public:
  53         OFormLayerXMLImport(SvXMLImport& _rImporter);
  54         virtual ~OFormLayerXMLImport() override;
  55
  56         /** start importing the forms of the given page
  57
  58             <p>starting the import of a new page (by using this method) invalidates the current page position.</p>
  59
  60             @see endPage
  61         */
  62         void startPage(
  63             const css::uno::Reference< css::drawing::XDrawPage >& _rxDrawPage);
  64
  65         /** creates an import context for the office:forms element
  66         */
  67         static SvXMLImportContext* createOfficeFormsContext(
  68             SvXMLImport& _rImport,
  69             sal_uInt16 _nPrefix,
  70             const OUString& _rLocalName);
  71
  72         /** create an SvXMLImportContext instance which is able to import the &lt;form:form&gt;
  73             element.
  74
  75             <p>You must have called <method>startPage</method> before you can create such an import context.</p>
  76
  77             @see startPage
  78             @see endPage
  79         */
  80         SvXMLImportContext* createContext(
  81             const sal_uInt16 _nPrefix,
  82             const OUString& _rLocalName,
  83             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttribs);
  84
  85         /** lookup a control given by id.
  86
  87             <p>The control must be part of the page which is currently being imported.</p>
  88
  89             <p>(And, of course, the control must have been imported already at the moment you call this.)</p>
  90
  91             @see startPage
  92         */
  93         css::uno::Reference< css::beans::XPropertySet >
  94                 lookupControl(const OUString& _rId);
  95
  96         /** end importing the forms of the current page
  97
  98             <p>You must call this method if you want the import to be finished correctly. Without calling
  99             it, you will lose information.</p>
 100
 101             @see startPage
 102         */
 103         void endPage();
 104
 105         /** announces the auto-style context to the form importer
 106         */
 107         void setAutoStyleContext(SvXMLStylesContext* _pNewContext);
 108
 109         /** sets the given number style on the given control
 110             @param _rxControlModel
 111                 the control model which's style is to be set
 112             @param _rControlNumerStyleName
 113                 the style name for the control's number style
 114         */
 115         void applyControlNumberStyle(
 116             const css::uno::Reference< css::beans::XPropertySet >& _rxControlModel,
 117             const OUString& _rControlNumerStyleName
 118         );
 119
 120         /** to be called when the document has been completely imported
 121
 122             <p>For some documents (currently: only some spreadsheet documents) it's necessary
 123             do to a post processing, since not all information from the file can be processed
 124             if the document is not completed, yet.</p>
 125         */
 126         void documentDone( );
 127     };
 128
 129
 130 }   // namespace xmloff
 131
 132
 133 #endif // INCLUDED_XMLOFF_FORMLAYERIMPORT_HXX
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */