sc/inc/clipparam.hxx

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