sc/inc/orcusfilters.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
  10 #pragma once
  11
  12 #include <rtl/ustring.hxx>
  13 #include <memory>
  14
  15 class ScDocument;
  16 struct ScOrcusXMLTreeParam;
  17 struct ScOrcusImportXMLParam;
  18 class ScOrcusXMLContext;
  19 class SfxMedium;
  20 namespace weld { class TreeView; }
  21
  22 /**
  23  * Collection of orcus filter wrappers.
  24  */
  25 class ScOrcusFilters
  26 {
  27 public:
  28     enum class ImportResult
  29     {
  30         NotSupported,
  31         Success,
  32         Failure
  33     };
  34
  35     virtual ~ScOrcusFilters() {}
  36
  37     virtual ImportResult importByName(
  38         ScDocument& rDoc, SfxMedium& rMedium, const OUString& rFilterName) const = 0;
  39
  40     /**
  41      * Used to import just the styles from an xml file.
  42      */
  43
  44     virtual bool importODS_Styles(ScDocument& rDoc, OUString& aFileName) const = 0;
  45
  46     /**
  47      * Create a context for XML file.  The context object stores session
  48      * information for each unique XML file.  You must create a new context
  49      * for each XML file, and never to re-use the same context for multiple
  50      * XML files.
  51      *
  52      * The caller is responsible for deleting the instance returned from this
  53      * method when it's done.
  54      */
  55     virtual std::unique_ptr<ScOrcusXMLContext> createXMLContext(ScDocument& rDoc, const OUString& rPath) const = 0;
  56 };
  57
  58 class ScOrcusXMLContext
  59 {
  60 public:
  61     virtual ~ScOrcusXMLContext() {}
  62
  63     virtual void loadXMLStructure(weld::TreeView& rTreeCtrl, ScOrcusXMLTreeParam& rParam) = 0;
  64
  65     virtual void importXML(const ScOrcusImportXMLParam& rParam) = 0;
  66 };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */