sc/inc/documentstreamaccess.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
  10 #ifndef INCLUDED_SC_INC_DOCUMENTSTREAMACCESS_HXX
  11 #define INCLUDED_SC_INC_DOCUMENTSTREAMACCESS_HXX
  12
  13 #include <rtl/ustring.hxx>
  14 #include <memory>
  15
  16 class ScDocument;
  17 class ScAddress;
  18 class ScRange;
  19
  20 namespace sc
  21 {
  22 struct DocumentStreamAccessImpl;
  23
  24 /**
  25  * Provides methods to allow direct shifting of document content without
  26  * broadcasting or shifting of broadcaster positions.
  27  */
  28 class DocumentStreamAccess
  29 {
  30     std::unique_ptr<DocumentStreamAccessImpl> mpImpl;
  31
  32 public:
  33     DocumentStreamAccess(ScDocument& rDoc);
  34     ~DocumentStreamAccess();
  35
  36     void setNumericCell(const ScAddress& rPos, double fVal);
  37     void setStringCell(const ScAddress& rPos, const OUString& rStr);
  38
  39     /**
  40      * Clear its internal state, and more importantly all the block position
  41      * hints currently held.
  42      */
  43     void reset();
  44
  45     /**
  46      * Pop the top row inside specified range, shift all the other rows up by
  47      * one, then set the bottom row empty.
  48      */
  49     void shiftRangeUp(const ScRange& rRange);
  50
  51     /**
  52      * Top the bottom row inside specified range, shift all the other rows
  53      * above downward by one by inserting an empty row at the top.
  54      */
  55     void shiftRangeDown(const ScRange& rRange);
  56 };
  57 }
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */