Line data    Source code

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