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 #ifndef INCLUDED_SC_INC_SORTPARAM_HXX
  21 #define INCLUDED_SC_INC_SORTPARAM_HXX
  22
  23 #define DEFSORT 3
  24
  25 #include <vector>
  26
  27 #include "address.hxx"
  28 #include <com/sun/star/lang/Locale.hpp>
  29 #include "scdllapi.h"
  30
  31 struct ScSubTotalParam;
  32 struct ScQueryParam;
  33
  34 struct ScSortKeyState
  35 {
  36     bool     bDoSort;
  37     SCCOLROW nField;
  38     bool     bAscending;
  39 };
  40
  41 struct SC_DLLPUBLIC ScSortParam
  42 {
  43     SCCOL       nCol1;
  44     SCROW       nRow1;
  45     SCCOL       nCol2;
  46     SCROW       nRow2;
  47     sal_uInt16  nUserIndex;
  48     bool        bHasHeader;
  49     bool        bByRow;
  50     bool        bCaseSens;
  51     bool        bNaturalSort;
  52     bool        bIncludeComments;
  53     bool        bIncludeGraphicObjects;
  54     bool        bUserDef;
  55     bool        bIncludePattern;
  56     bool        bInplace;
  57     SCTAB       nDestTab;
  58     SCCOL       nDestCol;
  59     SCROW       nDestRow;
  60     ::std::vector<ScSortKeyState>
  61                 maKeyState;
  62     css::lang::Locale aCollatorLocale;
  63     OUString    aCollatorAlgorithm;
  64     sal_uInt16  nCompatHeader;
  65
  66     ScSortParam();
  67     ScSortParam( const ScSortParam& r );
  68     /// SubTotals sort
  69     ScSortParam( const ScSubTotalParam& rSub, const ScSortParam& rOld );
  70     /// TopTen sort
  71     ScSortParam( const ScQueryParam&, SCCOL nCol );
  72     ~ScSortParam();
  73
  74     ScSortParam&    operator=  ( const ScSortParam& r );
  75     bool            operator== ( const ScSortParam& rOther ) const;
  76     void            Clear       ();
  77     void            MoveToDest();
  78
  79     sal_uInt16 GetSortKeyCount() const { return maKeyState.size(); }
  80 };
  81
  82 namespace sc {
  83
  84 struct SC_DLLPUBLIC ReorderParam
  85 {
  86     /**
  87      * This sort range already takes into account the presence or absence of
  88      * header row / column i.e. if a header row / column is present, it
  89      * excludes that row / column.
  90      */
  91     ScRange maSortRange;
  92
  93     /**
  94      * List of original column / row positions after reordering.
  95      */
  96     std::vector<SCCOLROW> maOrderIndices;
  97     bool mbByRow;
  98     bool mbPattern;
  99     bool mbHiddenFiltered;
 100     bool mbUpdateRefs;
 101     bool mbHasHeaders;
 102
 103     /**
 104      * Reorder the position indices such that it can be used to undo the
 105      * original reordering.
 106      */
 107     void reverse();
 108 };
 109
 110 }
 111
 112 #endif // INCLUDED_SC_INC_SORTPARAM_HXX
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */