sc/inc/sortparam.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 #define DEFSORT 3
  23
  24 #include <vector>
  25
  26 #include "address.hxx"
  27 #include <editeng/colritem.hxx>
  28 #include <com/sun/star/lang/Locale.hpp>
  29 #include "scdllapi.h"
  30
  31 struct ScSubTotalParam;
  32 struct ScQueryParam;
  33
  34 enum class ScColorSortMode {
  35     None,
  36     TextColor,
  37     BackgroundColor
  38 };
  39
  40 struct ScSortKeyState
  41 {
  42     SCCOLROW nField;
  43     bool     bDoSort;
  44     bool     bAscending;
  45     ScColorSortMode aColorSortMode;
  46     Color    aColorSortColor;
  47 };
  48
  49 /** Struct to hold non-data extended area, used with
  50     ScDocument::ShrinkToUsedDataArea().
  51 */
  52 struct ScDataAreaExtras
  53 {
  54     /// If TRUE, consider the presence of cell notes besides data.
  55     bool    mbCellNotes = false;
  56     /// If TRUE, consider the presence of draw objects anchored to the cell.
  57     bool    mbCellDrawObjects = false;
  58     /// If TRUE, consider the presence of cell formats.
  59     bool    mbCellFormats = false;
  60     SCCOL   mnStartCol = SCCOL_MAX;
  61     SCROW   mnStartRow = SCROW_MAX;
  62     SCCOL   mnEndCol = -1;
  63     SCROW   mnEndRow = -1;
  64
  65     bool anyExtrasWanted() const { return mbCellNotes || mbCellDrawObjects || mbCellFormats; }
  66     void resetArea() { mnStartCol = SCCOL_MAX; mnStartRow = SCROW_MAX; mnEndCol = -1; mnEndRow = -1; }
  67
  68     bool operator==( const ScDataAreaExtras& rOther ) const
  69     {
  70         // Ignore area range, this is used in ScSortParam::operator==().
  71         return mbCellNotes       == rOther.mbCellNotes
  72             && mbCellDrawObjects == rOther.mbCellDrawObjects
  73             && mbCellFormats     == rOther.mbCellFormats;
  74     }
  75
  76     enum class Clip
  77     {
  78         None,
  79         Col,
  80         Row
  81     };
  82
  83     /// Obtain the overall range if area extras are larger.
  84     void GetOverallRange( SCCOL& nCol1, SCROW& nRow1, SCCOL& nCol2, SCROW& nRow2, Clip eClip = Clip::None ) const
  85     {
  86         if (eClip != Clip::Col)
  87         {
  88             if (nCol1 > mnStartCol)
  89                 nCol1 = mnStartCol;
  90             if (nCol2 < mnEndCol)
  91                 nCol2 = mnEndCol;
  92         }
  93         if (eClip != Clip::Row)
  94         {
  95             if (nRow1 > mnStartRow)
  96                 nRow1 = mnStartRow;
  97             if (nRow2 < mnEndRow)
  98                 nRow2 = mnEndRow;
  99         }
 100     }
 101
 102     /// Set the overall range.
 103     void SetOverallRange( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 )
 104     {
 105         mnStartCol = nCol1;
 106         mnStartRow = nRow1;
 107         mnEndCol   = nCol2;
 108         mnEndRow   = nRow2;
 109     }
 110 };
 111
 112 struct SC_DLLPUBLIC ScSortParam
 113 {
 114     SCCOL       nCol1;
 115     SCROW       nRow1;
 116     SCCOL       nCol2;
 117     SCROW       nRow2;
 118     ScDataAreaExtras aDataAreaExtras;
 119     sal_uInt16  nUserIndex;
 120     bool        bHasHeader;
 121     bool        bByRow;
 122     bool        bCaseSens;
 123     bool        bNaturalSort;
 124     bool        bUserDef;
 125     bool        bInplace;
 126     SCTAB       nDestTab;
 127     SCCOL       nDestCol;
 128     SCROW       nDestRow;
 129     ::std::vector<ScSortKeyState>
 130                 maKeyState;
 131     css::lang::Locale aCollatorLocale;
 132     OUString    aCollatorAlgorithm;
 133     sal_uInt16  nCompatHeader;
 134
 135     ScSortParam();
 136     ScSortParam( const ScSortParam& r );
 137     /// SubTotals sort
 138     ScSortParam( const ScSubTotalParam& rSub, const ScSortParam& rOld );
 139     /// TopTen sort
 140     ScSortParam( const ScQueryParam&, SCCOL nCol );
 141     ~ScSortParam();
 142
 143     ScSortParam&    operator=  ( const ScSortParam& r );
 144     bool            operator== ( const ScSortParam& rOther ) const;
 145     void            Clear       ();
 146     void            MoveToDest();
 147
 148     sal_uInt16 GetSortKeyCount() const { return maKeyState.size(); }
 149 };
 150
 151 namespace sc {
 152
 153 struct ReorderParam
 154 {
 155     /**
 156      * This sort range already takes into account the presence or absence of
 157      * header row / column i.e. if a header row / column is present, it
 158      * excludes that row / column.
 159      */
 160     ScRange maSortRange;
 161     ScDataAreaExtras maDataAreaExtras;
 162
 163     /**
 164      * List of original column / row positions after reordering.
 165      */
 166     std::vector<SCCOLROW> maOrderIndices;
 167     bool mbByRow;
 168     bool mbHiddenFiltered;
 169     bool mbUpdateRefs;
 170     bool mbHasHeaders;
 171
 172     /**
 173      * Reorder the position indices such that it can be used to undo the
 174      * original reordering.
 175      */
 176     void reverse();
 177
 178     ReorderParam()
 179         : mbByRow(false)
 180         , mbHiddenFiltered(false)
 181         , mbUpdateRefs(false)
 182         , mbHasHeaders(false)
 183     {
 184     }
 185 };
 186
 187 }
 188
 189 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */