xref: /trunk/main/sc/inc/sortparam.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef SC_SORTPARAM_HXX
29*cdf0e10cSrcweir #define SC_SORTPARAM_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "address.hxx"
32*cdf0e10cSrcweir #include <tools/string.hxx>
33*cdf0e10cSrcweir #include <tools/solar.h>
34*cdf0e10cSrcweir #include <com/sun/star/lang/Locale.hpp>
35*cdf0e10cSrcweir #include "scdllapi.h"
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir #define MAXSORT     3
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir struct ScSubTotalParam;
41*cdf0e10cSrcweir struct ScQueryParam;
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir struct SC_DLLPUBLIC ScSortParam
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir     SCCOL       nCol1;
46*cdf0e10cSrcweir     SCROW       nRow1;
47*cdf0e10cSrcweir     SCCOL       nCol2;
48*cdf0e10cSrcweir     SCROW       nRow2;
49*cdf0e10cSrcweir     sal_Bool        bHasHeader;
50*cdf0e10cSrcweir     sal_Bool        bByRow;
51*cdf0e10cSrcweir     sal_Bool        bCaseSens;
52*cdf0e10cSrcweir     sal_Bool        bUserDef;
53*cdf0e10cSrcweir     sal_uInt16      nUserIndex;
54*cdf0e10cSrcweir     sal_Bool        bIncludePattern;
55*cdf0e10cSrcweir     sal_Bool        bInplace;
56*cdf0e10cSrcweir     SCTAB       nDestTab;
57*cdf0e10cSrcweir     SCCOL       nDestCol;
58*cdf0e10cSrcweir     SCROW       nDestRow;
59*cdf0e10cSrcweir     sal_Bool        bDoSort[MAXSORT];
60*cdf0e10cSrcweir     SCCOLROW    nField[MAXSORT];
61*cdf0e10cSrcweir     sal_Bool        bAscending[MAXSORT];
62*cdf0e10cSrcweir     ::com::sun::star::lang::Locale      aCollatorLocale;
63*cdf0e10cSrcweir     String      aCollatorAlgorithm;
64*cdf0e10cSrcweir     sal_uInt16      nCompatHeader;
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir     ScSortParam();
67*cdf0e10cSrcweir     ScSortParam( const ScSortParam& r );
68*cdf0e10cSrcweir     /// SubTotals sort
69*cdf0e10cSrcweir     ScSortParam( const ScSubTotalParam& rSub, const ScSortParam& rOld );
70*cdf0e10cSrcweir     /// TopTen sort
71*cdf0e10cSrcweir     ScSortParam( const ScQueryParam&, SCCOL nCol );
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir     ScSortParam&    operator=   ( const ScSortParam& r );
74*cdf0e10cSrcweir     sal_Bool            operator==  ( const ScSortParam& rOther ) const;
75*cdf0e10cSrcweir     void            Clear       ();
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir     void            MoveToDest();
78*cdf0e10cSrcweir };
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir #endif // SC_SORTPARAM_HXX
82