sc/inc/clipparam.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SC_INC_CLIPPARAM_HXX
  21 #define INCLUDED_SC_INC_CLIPPARAM_HXX
  22
  23 #include "rangelst.hxx"
  24 #include "rangenam.hxx"
  25 #include "charthelper.hxx"
  26
  27 #include <vector>
  28
  29 /**
  30  * This struct stores general clipboard parameters associated with a
  31  * ScDocument instance created in clipboard mode.
  32  */
  33 struct ScClipParam
  34 {
  35     enum Direction { Unspecified, Column, Row };
  36
  37     ScRangeList         maRanges;
  38     Direction           meDirection;
  39     bool                mbCutMode;
  40     sal_uInt32          mnSourceDocID;
  41     ScRangeListVector   maProtectedChartRangesVector;
  42
  43     ScClipParam();
  44     ScClipParam(const ScRange& rRange, bool bCutMode);
  45
  46     bool isMultiRange() const;
  47
  48     /**
  49      * Get the column size of a pasted range.  Note that when the range is
  50      * non-contiguous, we first compress all individual ranges into a single
  51      * range, and the size of that compressed range is returned.
  52      */
  53     SCCOL getPasteColSize();
  54
  55     /**
  56      * Same as the above method, but returns the row size of the compressed
  57      * range.
  58      */
  59     SCROW getPasteRowSize();
  60
  61     /**
  62      * Return a single range that encompasses all individual ranges.
  63      */
  64     ScRange getWholeRange() const;
  65
  66     void transpose();
  67
  68     sal_uInt32 getSourceDocID() const { return mnSourceDocID; }
  69     void setSourceDocID( sal_uInt32 nVal ) { mnSourceDocID = nVal; }
  70 };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */