LibreOffice Module sc (master)  1
filter.hxx
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 #ifndef INCLUDED_SC_INC_FILTER_HXX
21 #define INCLUDED_SC_INC_FILTER_HXX
22 
23 #include <rtl/textenc.h>
24 #include <rtl/ustring.hxx>
25 #include <vcl/errcode.hxx>
26 
27 #include "scdllapi.h"
28 #include <memory>
29 
30 class SfxMedium;
31 class SvStream;
32 
33 class ScAddress;
34 class ScDocument;
35 class ScRange;
36 class SvNumberFormatter;
37 class ScOrcusFilters;
38 
39 // for import
41 
42 // for export
44 
45 // These are implemented inside the scfilt library and lazy loaded
46 
48  public:
49  virtual ~ScEEAbsImport() {}
50  virtual ErrCode Read( SvStream& rStream, const OUString& rBaseURL ) = 0;
51  virtual ScRange GetRange() = 0;
52  virtual void WriteToDocument(
53  bool bSizeColsRows = false, double nOutputFactor = 1.0,
54  SvNumberFormatter* pFormatter = nullptr, bool bConvertDate = true ) = 0;
55 };
56 
57 class SAL_DLLPUBLIC_RTTI ScFormatFilterPlugin {
58  public:
59  // various import filters
60  virtual ErrCode ScImportLotus123( SfxMedium&, ScDocument*, rtl_TextEncoding eSrc ) = 0;
61  virtual ErrCode ScImportQuattroPro(SvStream* pStream, ScDocument *pDoc) = 0;
62  virtual ErrCode ScImportExcel( SfxMedium&, ScDocument*, const EXCIMPFORMAT ) = 0;
63  // eFormat == EIF_AUTO -> matching filter is used automatically
64  // eFormat == EIF_BIFF5 -> only Biff5 stream is read successfully (in an Excel97 doc, too)
65  // eFormat == EIF_BIFF8 -> only Biff8 stream is read successfully (only in Excel97 docs)
66  // eFormat == EIF_BIFF_LE4 -> only non storage files _might_ be read successfully
67  virtual ErrCode ScImportDif( SvStream&, ScDocument*, const ScAddress& rInsPos,
68  const rtl_TextEncoding eSrc ) = 0;
69  virtual ErrCode ScImportRTF( SvStream&, const OUString& rBaseURL, ScDocument*, ScRange& rRange ) = 0;
70  virtual ErrCode ScImportHTML( SvStream&, const OUString& rBaseURL, ScDocument*, ScRange& rRange, double nOutputFactor,
71  bool bCalcWidthHeight, SvNumberFormatter* pFormatter, bool bConvertDate ) = 0;
72 
73  // various import helpers
74  virtual std::unique_ptr<ScEEAbsImport> CreateRTFImport( ScDocument* pDoc, const ScRange& rRange ) = 0;
75  virtual std::unique_ptr<ScEEAbsImport> CreateHTMLImport( ScDocument* pDocP, const OUString& rBaseURL, const ScRange& rRange ) = 0;
76  virtual OUString GetHTMLRangeNameList( ScDocument* pDoc, const OUString& rOrigName ) = 0;
77 
78  // various export filters
79  virtual ErrCode ScExportExcel5( SfxMedium&, ScDocument*, ExportFormatExcel eFormat, rtl_TextEncoding eDest ) = 0;
80  virtual void ScExportDif( SvStream&, ScDocument*, const ScAddress& rOutPos, const rtl_TextEncoding eDest ) = 0;
81  virtual void ScExportDif( SvStream&, ScDocument*, const ScRange& rRange, const rtl_TextEncoding eDest ) = 0;
82  virtual void ScExportHTML( SvStream&, const OUString& rBaseURL, ScDocument*, const ScRange& rRange, const rtl_TextEncoding eDest, bool bAll,
83  const OUString& rStreamPath, OUString& rNonConvertibleChars, const OUString& rFilterOptions ) = 0;
84  virtual void ScExportRTF( SvStream&, ScDocument*, const ScRange& rRange, const rtl_TextEncoding eDest ) = 0;
85 
86  virtual ScOrcusFilters* GetOrcusFilters() = 0;
87 
88 protected:
90 };
91 
92 // scfilt plugin symbol
93 extern "C" {
94  SAL_DLLPUBLIC_EXPORT ScFormatFilterPlugin * ScFilterCreate();
95 }
96 
98  public:
100 };
101 
102 struct LotusContext;
103 
104 ErrCode ScImportLotus123old(LotusContext& rContext, SvStream&, ScDocument*, rtl_TextEncoding eSrc);
105 
106 #endif
107 
108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual ScRange GetRange()=0
Collection of orcus filter wrappers.
static SC_DLLPUBLIC ScFormatFilterPlugin & Get()
Definition: impex.cxx:2347
ErrCode ScImportLotus123old(LotusContext &rContext, SvStream &, ScDocument *, rtl_TextEncoding eSrc)
Definition: filter.cxx:185
virtual void WriteToDocument(bool bSizeColsRows=false, double nOutputFactor=1.0, SvNumberFormatter *pFormatter=nullptr, bool bConvertDate=true)=0
ExportFormatExcel
Definition: filter.hxx:43
virtual ErrCode Read(SvStream &rStream, const OUString &rBaseURL)=0
EXCIMPFORMAT
Definition: filter.hxx:40
virtual ~ScEEAbsImport()
Definition: filter.hxx:49
SAL_DLLPUBLIC_EXPORT ScFormatFilterPlugin * ScFilterCreate()
Definition: ftools.cxx:354
#define SC_DLLPUBLIC
Definition: scdllapi.h:28