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