xref: /aoo4110/main/sc/inc/clipparam.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef SC_CLIPPARAM_HXX
25*b1cdbd2cSJim Jagielski #define SC_CLIPPARAM_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include "rangelst.hxx"
28*b1cdbd2cSJim Jagielski #include "rangenam.hxx"
29*b1cdbd2cSJim Jagielski #include "charthelper.hxx"
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski #include <vector>
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski /**
34*b1cdbd2cSJim Jagielski  * This struct stores general clipboard parameters associated with a
35*b1cdbd2cSJim Jagielski  * ScDocument instance created in clipboard mode.
36*b1cdbd2cSJim Jagielski  */
37*b1cdbd2cSJim Jagielski struct ScClipParam
38*b1cdbd2cSJim Jagielski {
39*b1cdbd2cSJim Jagielski     enum Direction { Unspecified, Column, Row };
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski     ScRangeList         maRanges;
42*b1cdbd2cSJim Jagielski     Direction           meDirection;
43*b1cdbd2cSJim Jagielski     bool                mbCutMode;
44*b1cdbd2cSJim Jagielski     sal_uInt32          mnSourceDocID;
45*b1cdbd2cSJim Jagielski     ScRangeListVector   maProtectedChartRangesVector;
46*b1cdbd2cSJim Jagielski 
47*b1cdbd2cSJim Jagielski     ScClipParam();
48*b1cdbd2cSJim Jagielski     ScClipParam(const ScRange& rRange, bool bCutMode);
49*b1cdbd2cSJim Jagielski     explicit ScClipParam(const ScClipParam& r);
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski     bool isMultiRange() const;
52*b1cdbd2cSJim Jagielski 
53*b1cdbd2cSJim Jagielski     /**
54*b1cdbd2cSJim Jagielski      * Get the column size of a pasted range.  Note that when the range is
55*b1cdbd2cSJim Jagielski      * non-contiguous, we first compress all individual ranges into a single
56*b1cdbd2cSJim Jagielski      * range, and the size of that compressed range is returned.
57*b1cdbd2cSJim Jagielski      */
58*b1cdbd2cSJim Jagielski     SCCOL getPasteColSize();
59*b1cdbd2cSJim Jagielski 
60*b1cdbd2cSJim Jagielski     /**
61*b1cdbd2cSJim Jagielski      * Same as the above method, but returns the row size of the compressed
62*b1cdbd2cSJim Jagielski      * range.
63*b1cdbd2cSJim Jagielski      */
64*b1cdbd2cSJim Jagielski     SCROW getPasteRowSize();
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski     /**
67*b1cdbd2cSJim Jagielski      * Return a single range that encompasses all individual ranges.
68*b1cdbd2cSJim Jagielski      */
69*b1cdbd2cSJim Jagielski     ScRange getWholeRange() const;
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski     void transpose();
72*b1cdbd2cSJim Jagielski 
getSourceDocIDScClipParam73*b1cdbd2cSJim Jagielski     sal_uInt32 getSourceDocID() const { return mnSourceDocID; }
setSourceDocIDScClipParam74*b1cdbd2cSJim Jagielski     void setSourceDocID( sal_uInt32 nVal ) { mnSourceDocID = nVal; }
75*b1cdbd2cSJim Jagielski };
76*b1cdbd2cSJim Jagielski 
77*b1cdbd2cSJim Jagielski // ============================================================================
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski struct ScClipRangeNameData
80*b1cdbd2cSJim Jagielski {
81*b1cdbd2cSJim Jagielski     ScRangeData::IndexMap       maRangeMap;
82*b1cdbd2cSJim Jagielski     ::std::vector<ScRangeData*> mpRangeNames;
83*b1cdbd2cSJim Jagielski     bool                        mbReplace;
84*b1cdbd2cSJim Jagielski 
85*b1cdbd2cSJim Jagielski     ScClipRangeNameData();
86*b1cdbd2cSJim Jagielski     ~ScClipRangeNameData();
87*b1cdbd2cSJim Jagielski     void insert(sal_uInt16 nOldIndex, sal_uInt16 nNewIndex);
88*b1cdbd2cSJim Jagielski };
89*b1cdbd2cSJim Jagielski 
90*b1cdbd2cSJim Jagielski #endif
91