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