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 class SfxViewShell;
  30
  31 /**
  32  * This struct stores general clipboard parameters associated with a
  33  * ScDocument instance created in clipboard mode.
  34  */
  35 struct ScClipParam
  36 {
  37     enum Direction { Unspecified, Column, Row };
  38
  39     ScRangeList         maRanges;
  40     Direction           meDirection;
  41     bool                mbCutMode;
  42     sal_uInt32          mnSourceDocID;
  43     SfxViewShell*       mpSourceView;
  44     ScRangeListVector   maProtectedChartRangesVector;
  45
  46     ScClipParam();
  47     ScClipParam(const ScRange& rRange, bool bCutMode);
  48
  49     bool isMultiRange() const;
  50
  51     /**
  52      * Get the column size of a pasted range.  Note that when the range is
  53      * non-contiguous, we first compress all individual ranges into a single
  54      * range, and the size of that compressed range is returned.
  55      */
  56     SCCOL getPasteColSize();
  57
  58     /**
  59      * Same as the above method, but returns the row size of the compressed
  60      * range.
  61      */
  62     SCROW getPasteRowSize();
  63
  64     /**
  65      * Return a single range that encompasses all individual ranges.
  66      */
  67     ScRange getWholeRange() const;
  68
  69     void transpose();
  70
  71     sal_uInt32 getSourceDocID() const { return mnSourceDocID; }
  72     void setSourceDocID( sal_uInt32 nVal ) { mnSourceDocID = nVal; }
  73
  74     SfxViewShell* getSourceView() const { return mpSourceView; }
  75     void setSourceView( SfxViewShell* pSourceView ) { mpSourceView = pSourceView; }
  76 };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */