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 #ifndef INCLUDED_SC_INC_CLIPCONTEXT_HXX
  11 #define INCLUDED_SC_INC_CLIPCONTEXT_HXX
  12
  13 #include "address.hxx"
  14 #include "cellvalue.hxx"
  15 #include "celltextattr.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 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* const mpRefUndoDoc;
  56     ScDocument* mpClipDoc;
  57     InsertDeleteFlags const 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
  65     ScConditionalFormatList* mpCondFormatList;
  66     bool const mbAsLink:1;
  67     bool const mbSkipAttrForEmptyCells:1;
  68     bool const mbCloneNotes: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     InsertDeleteFlags getInsertFlag() const;
  99
 100     void setDeleteFlag( InsertDeleteFlags nFlag );
 101     InsertDeleteFlags getDeleteFlag() const;
 102
 103     /**
 104      * Set the column size of a "single cell" row, which is used when copying
 105      * a single row of cells in a clip doc and pasting it into multiple
 106      * rows by replicating it.
 107      */
 108     void setSingleCellColumnSize( size_t nSize );
 109
 110     ScCellValue& getSingleCell( size_t nColOffset );
 111     sc::CellTextAttr& getSingleCellAttr( size_t nColOffset );
 112
 113     void setSingleCell( const ScAddress& rSrcPos, const ScColumn& rSrcCol );
 114
 115
 116     const ScPatternAttr* getSingleCellPattern( size_t nColOffset ) const;
 117     void setSingleCellPattern( size_t nColOffset, const ScPatternAttr* pAttr );
 118
 119     const ScPostIt* getSingleCellNote( size_t nColOffset ) const;
 120     void setSingleCellNote( size_t nColOffset, const ScPostIt* pNote );
 121
 122     void setCondFormatList( ScConditionalFormatList* pCondFormatList );
 123     ScConditionalFormatList* getCondFormatList();
 124
 125     void setTableProtected( bool b );
 126     bool isTableProtected() const;
 127
 128     bool isAsLink() const;
 129     bool isSkipAttrForEmptyCells() const;
 130     bool isCloneNotes() const;
 131     bool isDateCell( const ScColumn& rCol, SCROW nRow ) const;
 132 };
 133
 134 class CopyToClipContext final : public ClipContextBase
 135 {
 136     bool const mbKeepScenarioFlags:1;
 137
 138 public:
 139     CopyToClipContext(ScDocument& rDoc, bool bKeepScenarioFlags);
 140     virtual ~CopyToClipContext() override;
 141
 142     bool isKeepScenarioFlags() const;
 143 };
 144
 145 class CopyToDocContext final : public ClipContextBase
 146 {
 147     bool mbStartListening;
 148
 149 public:
 150     CopyToDocContext(ScDocument& rDoc);
 151     virtual ~CopyToDocContext() override;
 152
 153     void setStartListening( bool b );
 154     bool isStartListening() const;
 155 };
 156
 157 class MixDocContext final : public ClipContextBase
 158 {
 159 public:
 160     MixDocContext(ScDocument& rDoc);
 161     virtual ~MixDocContext() override;
 162 };
 163
 164 }
 165
 166 #endif
 167
 168 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */