Branch data     Line data    Source code

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