Line data Source code
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 SC_FILTER_HXX
21 : #define SC_FILTER_HXX
22 :
23 : #include <rtl/textenc.h>
24 : #include <rtl/ustring.hxx>
25 : #include <tools/solar.h>
26 :
27 : #include "scdllapi.h"
28 :
29 : class SfxMedium;
30 : class SvStream;
31 :
32 : class ScAddress;
33 : class ScDocument;
34 : class ScRange;
35 : class SvNumberFormatter;
36 : class ScOrcusFilters;
37 :
38 : // return values im-/export filter (sal_uLong)
39 :
40 : typedef sal_uLong FltError;
41 :
42 : #define eERR_OK ERRCODE_NONE // no error
43 : #define eERR_OPEN SCERR_IMPORT_OPEN
44 : #define eERR_UNBEK SCERR_IMPORT_UNKNOWN // unknown error, historical meaning
45 : #define eERR_NOMEM SCERR_IMPORT_OUTOFMEM // out of memory
46 : #define eERR_UNKN_WK SCERR_IMPORT_UNKNOWN_WK // unknown WK? format (Lotus 1-2-3)
47 : #define eERR_FORMAT SCERR_IMPORT_FORMAT // format error during reading (no formula error!)
48 : #define eERR_NI SCERR_IMPORT_NI // filter not implemented
49 : #define eERR_UNKN_BIFF SCERR_IMPORT_UNKNOWN_BIFF // unknown BIFF format (Excel)
50 : #define eERR_NI_BIFF SCERR_IMPORT_NI_BIFF // not implemented BIFF format
51 : #define eERR_FILEPASSWD SCERR_IMPORT_FILEPASSWD // file password protected
52 : #define eERR_INTERN SCERR_IMPORT_INTERNAL // internal error
53 : #define eERR_RNGOVRFLW SCWARN_IMPORT_RANGE_OVERFLOW// overflow of cell coordinates
54 : // table restricted to valid area (?)
55 : // more error codes: s. scerrors.hxx
56 :
57 : // for import
58 : enum EXCIMPFORMAT { EIF_AUTO, EIF_BIFF5, EIF_BIFF8, EIF_BIFF_LE4 };
59 :
60 : // for export
61 : enum ExportFormatLotus { ExpWK1, ExpWK3, ExpWK4 };
62 : enum ExportFormatExcel { ExpBiff2, ExpBiff3, ExpBiff4, ExpBiff4W, ExpBiff5, ExpBiff8, Exp2007Xml };
63 :
64 :
65 : // options for DIF im-/export (combine with '|')
66 : #define SC_DIFOPT_PLAIN 0x00000000
67 : #define SC_DIFOPT_DATE 0x00000001
68 : #define SC_DIFOPT_TIME 0x00000002
69 : #define SC_DIFOPT_CURRENCY 0x00000004
70 :
71 : #define SC_DIFOPT_EXCEL (SC_DIFOPT_DATE|SC_DIFOPT_TIME|SC_DIFOPT_CURRENCY)
72 :
73 : // These are implemented inside the scfilt library and lazy loaded
74 :
75 0 : class ScEEAbsImport {
76 : public:
77 0 : virtual ~ScEEAbsImport() {}
78 : virtual sal_uLong Read( SvStream& rStream, const OUString& rBaseURL ) = 0;
79 : virtual ScRange GetRange() = 0;
80 : virtual void WriteToDocument(
81 : bool bSizeColsRows = false, double nOutputFactor = 1.0,
82 : SvNumberFormatter* pFormatter = NULL, bool bConvertDate = true ) = 0;
83 : };
84 :
85 0 : class ScFormatFilterPlugin {
86 : public:
87 : // various import filters
88 : virtual FltError ScImportLotus123( SfxMedium&, ScDocument*, rtl_TextEncoding eSrc = RTL_TEXTENCODING_DONTKNOW ) = 0;
89 : virtual FltError ScImportQuattroPro( SfxMedium &rMedium, ScDocument *pDoc ) = 0;
90 : virtual FltError ScImportExcel( SfxMedium&, ScDocument*, const EXCIMPFORMAT ) = 0;
91 : // eFormat == EIF_AUTO -> matching filter is used automatically
92 : // eFormat == EIF_BIFF5 -> only Biff5 stream is read successfully (in an Excel97 doc, too)
93 : // eFormat == EIF_BIFF8 -> only Biff8 stream is read successfully (only in Excel97 docs)
94 : // eFormat == EIF_BIFF_LE4 -> only non storage files _might_ be read successfully
95 : virtual FltError ScImportStarCalc10( SvStream&, ScDocument* ) = 0;
96 : virtual FltError ScImportDif( SvStream&, ScDocument*, const ScAddress& rInsPos,
97 : const rtl_TextEncoding eSrc = RTL_TEXTENCODING_DONTKNOW, sal_uInt32 nDifOption = SC_DIFOPT_EXCEL ) = 0;
98 : virtual FltError ScImportRTF( SvStream&, const OUString& rBaseURL, ScDocument*, ScRange& rRange ) = 0;
99 : virtual FltError ScImportHTML( SvStream&, const OUString& rBaseURL, ScDocument*, ScRange& rRange, double nOutputFactor = 1.0,
100 : bool bCalcWidthHeight = true, SvNumberFormatter* pFormatter = NULL, bool bConvertDate = true ) = 0;
101 :
102 : // various import helpers
103 : virtual ScEEAbsImport *CreateRTFImport( ScDocument* pDoc, const ScRange& rRange ) = 0;
104 : virtual ScEEAbsImport *CreateHTMLImport( ScDocument* pDocP, const OUString& rBaseURL, const ScRange& rRange, bool bCalcWidthHeight ) = 0;
105 : virtual OUString GetHTMLRangeNameList( ScDocument* pDoc, const OUString& rOrigName ) = 0;
106 :
107 : // various export filters
108 : virtual FltError ScExportExcel5( SfxMedium&, ScDocument*, ExportFormatExcel eFormat, rtl_TextEncoding eDest ) = 0;
109 : virtual FltError ScExportDif( SvStream&, ScDocument*, const ScAddress& rOutPos, const rtl_TextEncoding eDest,
110 : sal_uInt32 nDifOption = SC_DIFOPT_EXCEL ) = 0;
111 : virtual FltError ScExportDif( SvStream&, ScDocument*, const ScRange& rRange, const rtl_TextEncoding eDest,
112 : sal_uInt32 nDifOption = SC_DIFOPT_EXCEL ) = 0;
113 : virtual FltError ScExportHTML( SvStream&, const OUString& rBaseURL, ScDocument*, const ScRange& rRange, const rtl_TextEncoding eDest, bool bAll,
114 : const OUString& rStreamPath, OUString& rNonConvertibleChars ) = 0;
115 : virtual FltError ScExportRTF( SvStream&, ScDocument*, const ScRange& rRange, const rtl_TextEncoding eDest ) = 0;
116 :
117 : virtual ScOrcusFilters* GetOrcusFilters() = 0;
118 :
119 : protected:
120 0 : ~ScFormatFilterPlugin() {}
121 : };
122 :
123 : // scfilt plugin symbol
124 : extern "C" {
125 : SAL_DLLPUBLIC_EXPORT ScFormatFilterPlugin * SAL_CALL ScFilterCreate(void);
126 : }
127 :
128 : class ScFormatFilter {
129 : public:
130 : SC_DLLPUBLIC static ScFormatFilterPlugin &Get();
131 : };
132 :
133 : #endif
134 :
135 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
