sc/inc/clipcontext.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 "address.hxx"
  13 #include "cellvalue.hxx"
  14 #include "celltextattr.hxx"
  15 #include "Sparkline.hxx"
  16
  17 #include <memory>
  18 #include <vector>
  19
  20 class ScDocument;
  21 class ScColumn;
  22 class ScPatternAttr;
  23 class ScPostIt;
  24 class ScConditionalFormatList;
  25
  26 namespace sc {
  27
  28 struct ColumnBlockPosition;
  29 class ColumnBlockPositionSet;
  30
  31 class ClipContextBase
  32 {
  33     std::unique_ptr<ColumnBlockPositionSet> mpSet;
  34
  35 public:
  36     ClipContextBase() = delete;
  37     ClipContextBase(const ClipContextBase&) = delete;
  38     const ClipContextBase& operator=(const ClipContextBase&) = delete;
  39     ClipContextBase(ScDocument& rDoc);
  40     virtual ~ClipContextBase();
  41
  42     ColumnBlockPosition* getBlockPosition(SCTAB nTab, SCCOL nCol);
  43     ColumnBlockPositionSet* getBlockPositionSet() { return mpSet.get(); }
  44 };
  45
  46 class SC_DLLPUBLIC CopyFromClipContext final : public ClipContextBase
  47 {
  48     SCCOL mnDestCol1;
  49     SCCOL mnDestCol2;
  50     SCROW mnDestRow1;
  51     SCROW mnDestRow2;
  52     SCTAB mnTabStart;
  53     SCTAB mnTabEnd;
  54     ScDocument& mrDestDoc;
  55     ScDocument* mpRefUndoDoc;
  56     ScDocument* mpClipDoc;
  57     InsertDeleteFlags mnInsertFlag;
  58     InsertDeleteFlags mnDeleteFlag;
  59
  60     std::vector<ScCellValue> maSingleCells;
  61     std::vector<sc::CellTextAttr> maSingleCellAttrs;
  62     std::vector<const ScPatternAttr*> maSinglePatterns;
  63     std::vector<const ScPostIt*> maSingleNotes;
  64     std::vector<std::shared_ptr<sc::Sparkline>> maSingleSparkline;
  65
  66     ScConditionalFormatList* mpCondFormatList;
  67     bool mbAsLink:1;
  68     bool mbSkipEmptyCells:1;
  69     bool mbTableProtected:1;
  70
  71 public:
  72
  73     struct Range
  74     {
  75         SCCOL mnCol1;
  76         SCCOL mnCol2;
  77         SCROW mnRow1;
  78         SCROW mnRow2;
  79     };
  80
  81     CopyFromClipContext() = delete;
  82     CopyFromClipContext(ScDocument& rDoc,
  83         ScDocument* pRefUndoDoc, ScDocument* pClipDoc, InsertDeleteFlags nInsertFlag,
  84         bool bAsLink, bool bSkipAttrForEmptyCells);
  85
  86     virtual ~CopyFromClipContext() override;
  87
  88     void setTabRange(SCTAB nStart, SCTAB nEnd);
  89
  90     SCTAB getTabStart() const;
  91     SCTAB getTabEnd() const;
  92
  93     void setDestRange( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 );
  94     Range getDestRange() const;
  95
  96     ScDocument* getUndoDoc();
  97     ScDocument* getClipDoc();
  98     ScDocument* getDestDoc() { return &mrDestDoc; }
  99     InsertDeleteFlags getInsertFlag() const;
 100
 101     void setDeleteFlag( InsertDeleteFlags nFlag );
 102     InsertDeleteFlags getDeleteFlag() const;
 103
 104     /**
 105      * Set the column size of a "single cell" row, which is used when copying
 106      * a single row of cells in a clip doc and pasting it into multiple
 107      * rows by replicating it.
 108      */
 109     void setSingleCellColumnSize( size_t nSize );
 110
 111     ScCellValue& getSingleCell( size_t nColOffset );
 112     sc::CellTextAttr& getSingleCellAttr( size_t nColOffset );
 113
 114     void setSingleCell( const ScAddress& rSrcPos, const ScColumn& rSrcCol );
 115
 116
 117     const ScPatternAttr* getSingleCellPattern( size_t nColOffset ) const;
 118     void setSingleCellPattern( size_t nColOffset, const ScPatternAttr* pAttr );
 119
 120     const ScPostIt* getSingleCellNote( size_t nColOffset ) const;
 121     void setSingleCellNote( size_t nColOffset, const ScPostIt* pNote );
 122
 123     std::shared_ptr<sc::Sparkline> const& getSingleSparkline(size_t nColOffset) const;
 124     void setSingleSparkline(size_t nColOffset, std::shared_ptr<sc::Sparkline> const& pSparkline);
 125
 126     void setCondFormatList( ScConditionalFormatList* pCondFormatList );
 127     ScConditionalFormatList* getCondFormatList();
 128
 129     void setTableProtected( bool b );
 130     bool isTableProtected() const;
 131
 132     bool isAsLink() const;
 133
 134     /**
 135      * Get the flag that indicates whether the "skip empty cells" paste option
 136      * is selected. When this option is selected, empty cells in the clipboard
 137      * document will not overwrite the corresponding non-empty cells in the
 138      * destination range.
 139      */
 140     bool isSkipEmptyCells() const;
 141     bool isCloneNotes() const;
 142     bool isCloneSparklines() const;
 143     bool isDateCell( const ScColumn& rCol, SCROW nRow ) const;
 144 };
 145
 146 class CopyToClipContext final : public ClipContextBase
 147 {
 148     bool mbKeepScenarioFlags:1;
 149
 150 public:
 151     CopyToClipContext(ScDocument& rDoc, bool bKeepScenarioFlags);
 152     virtual ~CopyToClipContext() override;
 153
 154     bool isKeepScenarioFlags() const;
 155 };
 156
 157 class CopyToDocContext final : public ClipContextBase
 158 {
 159     bool mbStartListening;
 160
 161 public:
 162     CopyToDocContext(ScDocument& rDoc);
 163     virtual ~CopyToDocContext() override;
 164
 165     void setStartListening( bool b );
 166     bool isStartListening() const;
 167 };
 168
 169 class MixDocContext final : public ClipContextBase
 170 {
 171 public:
 172     MixDocContext(ScDocument& rDoc);
 173     virtual ~MixDocContext() override;
 174 };
 175
 176 }
 177
 178 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */