sc/inc/markdata.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  * 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 #pragma once
  21
  22 #include "address.hxx"
  23 #include "rangelst.hxx"
  24 #include "markmulti.hxx"
  25 #include "scdllapi.h"
  26
  27 #include <set>
  28 #include <vector>
  29
  30 namespace sc {
  31
  32 struct ColRowSpan;
  33
  34 }
  35
  36 class ScMarkArray;
  37
  38 //!     todo:
  39 //!     It should be possible to have MarkArrays for each table, in order to
  40 //!     enable "search all" across more than one table again!
  41
  42 class SC_DLLPUBLIC ScMarkData
  43 {
  44 public:
  45     typedef std::set<SCTAB> MarkedTabsType;
  46 private:
  47     MarkedTabsType  maTabMarked;
  48
  49     ScRange         aMarkRange;             // area
  50     ScRange         aMultiRange;            // maximum area altogether
  51     ScMultiSel      aMultiSel;              // multi selection
  52     ScRangeList     aTopEnvelope;           // list of ranges in the top envelope of the multi selection
  53     ScRangeList     aBottomEnvelope;        // list of ranges in the bottom envelope of the multi selection
  54     ScRangeList     aLeftEnvelope;          // list of ranges in the left envelope of the multi selection
  55     ScRangeList     aRightEnvelope;         // list of ranges in the right envelope of the multi selection
  56     const ScSheetLimits& mrSheetLimits;
  57     bool            bMarked:1;              // rectangle marked
  58     bool            bMultiMarked:1;
  59
  60     bool            bMarking:1;             // area is being marked -> no MarkToMulti
  61     bool            bMarkIsNeg:1;           // cancel if multi selection
  62
  63 public:
  64     ScMarkData(const ScSheetLimits& rSheetLimits);
  65     ScMarkData(const ScSheetLimits& rSheetLimits, const ScRangeList& rList);
  66     ScMarkData(const ScMarkData& rData) = default;
  67     ScMarkData(ScMarkData&& rData) = default;
  68     ScMarkData& operator=(const ScMarkData& rData);
  69     ScMarkData& operator=(ScMarkData&& rData);
  70     ~ScMarkData();
  71
  72     void        ResetMark();
  73     void        SetMarkArea( const ScRange& rRange );
  74
  75     // bSetupMulti must be set to true only for recursive calls to SetMultiMarkArea
  76     void        SetMultiMarkArea( const ScRange& rRange, bool bMark = true, bool bSetupMulti = false );
  77
  78     void        MarkToMulti();
  79     void        MarkToSimple();
  80
  81     bool        IsMarked() const                { return bMarked; }
  82     bool        IsMultiMarked() const           { return bMultiMarked; }
  83
  84     void        GetMarkArea( ScRange& rRange ) const;
  85     void        GetMultiMarkArea( ScRange& rRange ) const;
  86
  87     void        SetAreaTab( SCTAB nTab );
  88
  89     void        SelectTable( SCTAB nTab, bool bNew );
  90     bool        GetTableSelect( SCTAB nTab ) const;
  91
  92     void        SelectOneTable( SCTAB nTab );
  93     SCTAB       GetSelectCount() const;
  94     SCTAB       GetFirstSelected() const;
  95     SCTAB       GetLastSelected() const;
  96
  97     const MarkedTabsType& GetSelectedTabs() const { return maTabMarked;}
  98     void SetSelectedTabs(const MarkedTabsType& rTabs);
  99
 100     void        SetMarkNegative( bool bFlag )   { bMarkIsNeg = bFlag; }
 101     bool        IsMarkNegative() const          { return bMarkIsNeg;  }
 102     void        SetMarking( bool bFlag )        { bMarking = bFlag;   }
 103     bool        GetMarkingFlag() const          { return bMarking;    }
 104
 105     //  for FillInfo / Document etc.
 106     const ScMultiSel& GetMultiSelData() const   { return aMultiSel;   }
 107     ScMarkArray GetMarkArray( SCCOL nCol ) const;
 108
 109     bool        IsCellMarked( SCCOL nCol, SCROW nRow, bool bNoSimple = false ) const;
 110
 111     /** Create a range list of marks.
 112         @param  nForTab
 113                 If -1, use start-sheet-tab of the multi-area in ranges.
 114                 If >= 0, use given sheet-tab in ranges.
 115      */
 116     void        FillRangeListWithMarks( ScRangeList* pList, bool bClear, SCTAB nForTab = -1 ) const;
 117     void        ExtendRangeListTables( ScRangeList* pList ) const;
 118
 119     ScRangeList GetMarkedRanges() const;
 120     /** Get marked ranges with sheet-tab set to nTab.
 121         Marks are stored for the currently active sheet respectively the
 122         multi-area start-sheet-tab, update ranges with the sheet for which this
 123         is called. */
 124     ScRangeList GetMarkedRangesForTab( SCTAB nTab ) const;
 125
 126     void        MarkFromRangeList( const ScRangeList& rList, bool bReset );
 127
 128     std::vector<sc::ColRowSpan> GetMarkedRowSpans() const;
 129     std::vector<sc::ColRowSpan> GetMarkedColSpans() const;
 130
 131     bool        IsColumnMarked( SCCOL nCol ) const;
 132     bool        IsRowMarked( SCROW nRow ) const;
 133     bool        IsAllMarked( const ScRange& rRange ) const;     // Multi
 134
 135                 /// May return -1
 136     SCROW       GetNextMarked( SCCOL nCol, SCROW nRow, bool bUp ) const;
 137     bool        HasMultiMarks( SCCOL nCol ) const;
 138     bool        HasAnyMultiMarks() const;
 139
 140     //  adjust table marking:
 141     void        InsertTab( SCTAB nTab );
 142     void        DeleteTab( SCTAB nTab );
 143
 144     void        ShiftCols(const ScDocument& rDoc, SCCOL nStartCol, sal_Int32 nColOffset);
 145     void        ShiftRows(const ScDocument& rDoc, SCROW nStartRow, sal_Int32 nRowOffset);
 146
 147     // Generate envelopes if multimarked and fills the passed ScRange object with
 148     // the smallest range that includes the marked area plus its envelopes.
 149     void        GetSelectionCover( ScRange& rRange );
 150     // Get top, bottom, left and right envelopes
 151     const ScRangeList& GetTopEnvelope() const    { return aTopEnvelope;    }
 152     const ScRangeList& GetBottomEnvelope() const { return aBottomEnvelope; }
 153     const ScRangeList& GetLeftEnvelope() const   { return aLeftEnvelope;   }
 154     const ScRangeList& GetRightEnvelope() const  { return aRightEnvelope;  }
 155
 156     // iterators for table access
 157     typedef std::set<SCTAB>::iterator iterator;
 158     typedef std::set<SCTAB>::const_iterator const_iterator;
 159     typedef std::set<SCTAB>::const_reverse_iterator const_reverse_iterator;
 160     iterator begin();
 161     iterator end();
 162     const_iterator begin() const;
 163     const_iterator end() const;
 164     const_reverse_iterator rbegin() const;
 165 };
 166
 167 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */