Version 6.1.0.2, tag libreoffice-6.1.0.2
[LibreOffice.git] / sc / inc / filter.hxx
blob770d35e91350b142bffbcbc8133ba19157a90e68
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_SC_INC_FILTER_HXX
21 #define INCLUDED_SC_INC_FILTER_HXX
23 #include <rtl/textenc.h>
24 #include <rtl/ustring.hxx>
25 #include <vcl/errcode.hxx>
27 #include "scdllapi.h"
29 class SfxMedium;
30 class SvStream;
32 class ScAddress;
33 class ScDocument;
34 class ScRange;
35 class SvNumberFormatter;
36 class ScOrcusFilters;
38 // for import
39 enum EXCIMPFORMAT { EIF_AUTO, EIF_BIFF5, EIF_BIFF8, EIF_BIFF_LE4 };
41 // for export
42 enum ExportFormatLotus { ExpWK1, ExpWK3, ExpWK4 };
43 enum ExportFormatExcel { ExpBiff2, ExpBiff3, ExpBiff4, ExpBiff4W, ExpBiff5, ExpBiff8, Exp2007Xml };
45 // These are implemented inside the scfilt library and lazy loaded
47 class ScEEAbsImport {
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;
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;
73 // various import helpers
74 virtual ScEEAbsImport *CreateRTFImport( ScDocument* pDoc, const ScRange& rRange ) = 0;
75 virtual ScEEAbsImport *CreateHTMLImport( ScDocument* pDocP, const OUString& rBaseURL, const ScRange& rRange ) = 0;
76 virtual OUString GetHTMLRangeNameList( ScDocument* pDoc, const OUString& rOrigName ) = 0;
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;
86 virtual ScOrcusFilters* GetOrcusFilters() = 0;
88 protected:
89 ~ScFormatFilterPlugin() {}
92 // scfilt plugin symbol
93 extern "C" {
94 SAL_DLLPUBLIC_EXPORT ScFormatFilterPlugin * ScFilterCreate();
97 class ScFormatFilter {
98 public:
99 SC_DLLPUBLIC static ScFormatFilterPlugin &Get();
102 struct LotusContext;
104 ErrCode ScImportLotus123old(LotusContext& rContext, SvStream&, ScDocument*, rtl_TextEncoding eSrc);
106 #endif
108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */