xref: /trunk/main/sc/inc/clipparam.hxx (revision cdf0e10c)
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_CLIPPARAM_HXX
29*cdf0e10cSrcweir #define SC_CLIPPARAM_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "rangelst.hxx"
32*cdf0e10cSrcweir #include "rangenam.hxx"
33*cdf0e10cSrcweir #include "charthelper.hxx"
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <vector>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir /**
38*cdf0e10cSrcweir  * This struct stores general clipboard parameters associated with a
39*cdf0e10cSrcweir  * ScDocument instance created in clipboard mode.
40*cdf0e10cSrcweir  */
41*cdf0e10cSrcweir struct ScClipParam
42*cdf0e10cSrcweir {
43*cdf0e10cSrcweir     enum Direction { Unspecified, Column, Row };
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir     ScRangeList         maRanges;
46*cdf0e10cSrcweir     Direction           meDirection;
47*cdf0e10cSrcweir     bool                mbCutMode;
48*cdf0e10cSrcweir     sal_uInt32          mnSourceDocID;
49*cdf0e10cSrcweir     ScRangeListVector   maProtectedChartRangesVector;
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir     ScClipParam();
52*cdf0e10cSrcweir     ScClipParam(const ScRange& rRange, bool bCutMode);
53*cdf0e10cSrcweir     explicit ScClipParam(const ScClipParam& r);
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir     bool isMultiRange() const;
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir     /**
58*cdf0e10cSrcweir      * Get the column size of a pasted range.  Note that when the range is
59*cdf0e10cSrcweir      * non-contiguous, we first compress all individual ranges into a single
60*cdf0e10cSrcweir      * range, and the size of that compressed range is returned.
61*cdf0e10cSrcweir      */
62*cdf0e10cSrcweir     SCCOL getPasteColSize();
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir     /**
65*cdf0e10cSrcweir      * Same as the above method, but returns the row size of the compressed
66*cdf0e10cSrcweir      * range.
67*cdf0e10cSrcweir      */
68*cdf0e10cSrcweir     SCROW getPasteRowSize();
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir     /**
71*cdf0e10cSrcweir      * Return a single range that encompasses all individual ranges.
72*cdf0e10cSrcweir      */
73*cdf0e10cSrcweir     ScRange getWholeRange() const;
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     void transpose();
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir     sal_uInt32 getSourceDocID() const { return mnSourceDocID; }
78*cdf0e10cSrcweir     void setSourceDocID( sal_uInt32 nVal ) { mnSourceDocID = nVal; }
79*cdf0e10cSrcweir };
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir // ============================================================================
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir struct ScClipRangeNameData
84*cdf0e10cSrcweir {
85*cdf0e10cSrcweir     ScRangeData::IndexMap       maRangeMap;
86*cdf0e10cSrcweir     ::std::vector<ScRangeData*> mpRangeNames;
87*cdf0e10cSrcweir     bool                        mbReplace;
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir     ScClipRangeNameData();
90*cdf0e10cSrcweir     ~ScClipRangeNameData();
91*cdf0e10cSrcweir     void insert(sal_uInt16 nOldIndex, sal_uInt16 nNewIndex);
92*cdf0e10cSrcweir };
93*cdf0e10cSrcweir 
94*cdf0e10cSrcweir #endif
95