sc/inc/documentimport.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 #ifndef INCLUDED_SC_INC_DOCUMENTIMPORT_HXX
  11 #define INCLUDED_SC_INC_DOCUMENTIMPORT_HXX
  12
  13 #include "scdllapi.h"
  14 #include "address.hxx"
  15
  16 #include <rtl/ustring.hxx>
  17
  18 #include <memory>
  19 #include <vector>
  20
  21 class EditTextObject;
  22 class ScDocument;
  23 class ScColumn;
  24 struct ScAttrEntry;
  25 class ScTokenArray;
  26 class ScFormulaCell;
  27 class ScStyleSheet;
  28 struct ScSetStringParam;
  29 struct ScTabOpParam;
  30 struct ScDocumentImportImpl;
  31 enum class SvtScriptType;
  32
  33 /**
  34  * Accessor class to ScDocument.  Its purpose is to allow import filter to
  35  * fill the document model and nothing but that.  Filling the document via
  36  * this class does not trigger any kind of broadcasting, drawing object
  37  * position calculation, or anything else that requires expensive
  38  * computation which are unnecessary and undesirable during import.
  39  */
  40 class SC_DLLPUBLIC ScDocumentImport
  41 {
  42     std::unique_ptr<ScDocumentImportImpl> mpImpl;
  43
  44 public:
  45
  46     struct SC_DLLPUBLIC Attrs
  47     {
  48         std::vector<ScAttrEntry> mvData;
  49
  50         bool mbLatinNumFmtOnly;
  51
  52         Attrs();
  53         ~Attrs();
  54         Attrs& operator=( Attrs const & ) = delete; // MSVC2015 workaround
  55         Attrs( Attrs const & ) = delete; // MSVC2015 workaround
  56     };
  57
  58     ScDocumentImport() = delete;
  59     ScDocumentImport(ScDocument& rDoc);
  60     ScDocumentImport(const ScDocumentImport&) = delete;
  61     const ScDocumentImport& operator=(const ScDocumentImport&) = delete;
  62     ~ScDocumentImport();
  63
  64     ScDocument& getDoc();
  65     const ScDocument& getDoc() const;
  66
  67     /**
  68      * Initialize the storage for all sheets after all the sheet instances
  69      * have been created in the document.
  70      */
  71     void initForSheets();
  72
  73     void setDefaultNumericScript(SvtScriptType nScript);
  74
  75     /**
  76      * Apply specified cell style to an entire sheet.
  77      */
  78     void setCellStyleToSheet(SCTAB nTab, const ScStyleSheet& rStyle);
  79
  80     /**
  81      * @param rName sheet name.
  82      *
  83      * @return 0-based sheet index, or -1 in case no sheet is found by
  84      *         specified name.
  85      */
  86     SCTAB getSheetIndex(const OUString& rName) const;
  87     SCTAB getSheetCount() const;
  88     bool appendSheet(const OUString& rName);
  89     void setSheetName(SCTAB nTab, const OUString& rName);
  90
  91     void setOriginDate(sal_uInt16 nYear, sal_uInt16 nMonth, sal_uInt16 nDay);
  92
  93     void setAutoInput(const ScAddress& rPos, const OUString& rStr,
  94             const ScSetStringParam* pStringParam = nullptr);
  95     void setNumericCell(const ScAddress& rPos, double fVal);
  96     void setStringCell(const ScAddress& rPos, const OUString& rStr);
  97     void setEditCell(const ScAddress& rPos, std::unique_ptr<EditTextObject> pEditText);
  98
  99     void setFormulaCell(
 100         const ScAddress& rPos, const OUString& rFormula, formula::FormulaGrammar::Grammar eGrammar,
 101         const double* pResult = nullptr );
 102
 103     void setFormulaCell(
 104         const ScAddress& rPos, const OUString& rFormula, formula::FormulaGrammar::Grammar eGrammar,
 105         const OUString& rResult );
 106
 107     void setFormulaCell(const ScAddress& rPos, ScTokenArray* pArray);
 108     void setFormulaCell(const ScAddress& rPos, ScFormulaCell* pCell);
 109
 110     void setMatrixCells(
 111         const ScRange& rRange, const ScTokenArray& rArray, formula::FormulaGrammar::Grammar eGrammar);
 112
 113     void setTableOpCells(const ScRange& rRange, const ScTabOpParam& rParam);
 114
 115     /**
 116      * Set an array of cell attributes to specified column.  This call
 117      * transfers the ownership of the ScAttrEntry array from the caller to the
 118      * column.
 119      */
 120     void setAttrEntries( SCTAB nTab, SCCOL nCol, Attrs&& rAttrs );
 121
 122     void setRowsVisible(SCTAB nTab, SCROW nRowStart, SCROW nRowEnd, bool bVisible);
 123
 124     void setMergedCells(SCTAB nTab, SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2);
 125
 126     void finalize();
 127
 128     /** Broadcast all formula cells that are marked with
 129         FormulaTokenArray::IsRecalcModeMustAfterImport() for a subsequent
 130         ScDocument::CalcFormulaTree().
 131      */
 132     void broadcastRecalcAfterImport();
 133
 134 private:
 135     void initColumn(ScColumn& rCol);
 136     void broadcastRecalcAfterImportColumn(ScColumn& rCol);
 137 };
 138
 139 #endif
 140
 141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */