sc/inc/clipparam.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef SC_CLIPPARAM_HXX
  29 #define SC_CLIPPARAM_HXX
  30
  31 #include "rangelst.hxx"
  32 #include "rangenam.hxx"
  33
  34 #include <vector>
  35
  36 /**
  37  * This struct stores general clipboard parameters associated with a
  38  * ScDocument instance created in clipboard mode.
  39  */
  40 struct ScClipParam
  41 {
  42     enum Direction { Unspecified, Column, Row };
  43
  44     ScRangeList maRanges;
  45     Direction   meDirection;
  46     bool        mbCutMode;
  47
  48     ScClipParam();
  49     ScClipParam(const ScRange& rRange, bool bCutMode);
  50     explicit ScClipParam(const ScClipParam& r);
  51
  52     bool isMultiRange() const;
  53
  54     /**
  55      * Get the column size of a pasted range.  Note that when the range is
  56      * non-contiguous, we first compress all individual ranges into a single
  57      * range, and the size of that compressed range is returned.
  58      */
  59     SCCOL getPasteColSize();
  60
  61     /**
  62      * Same as the above method, but returns the row size of the compressed
  63      * range.
  64      */
  65     SCROW getPasteRowSize();
  66
  67     /**
  68      * Return a single range that encompasses all individual ranges.
  69      */
  70     ScRange getWholeRange() const;
  71
  72     void transpose();
  73 };
  74
  75 // ============================================================================
  76
  77 struct ScClipRangeNameData
  78 {
  79     ScRangeData::IndexMap       maRangeMap;
  80     ::std::vector<ScRangeData*> mpRangeNames;
  81     bool                        mbReplace;
  82
  83     ScClipRangeNameData();
  84     ~ScClipRangeNameData();
  85     void insert(sal_uInt16 nOldIndex, sal_uInt16 nNewIndex);
  86 };
  87
  88 #endif