sc/inc/edittextiterator.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 "types.hxx"
  13 #include "mtvelements.hxx"
  14
  15 class ScTable;
  16 class ScDocument;
  17 class EditTextObject;
  18
  19 namespace sc
  20 {
  21 /**
  22  * Iterate through all edit text cells in a given sheet.  The caller must
  23  * check the validity of the sheet index passed to its constructor.
  24  *
  25  * It iterates from top to bottom, and then left to right order.
  26  */
  27 class EditTextIterator
  28 {
  29     const ScTable& mrTable;
  30     SCCOL mnCol;
  31     const CellStoreType* mpCells;
  32     CellStoreType::const_position_type maPos;
  33     CellStoreType::const_iterator miEnd;
  34
  35     /**
  36      * Move to the next edit text cell position if the current position is not
  37      * an edit text.
  38      */
  39     const EditTextObject* seek();
  40
  41     void incBlock();
  42     /**
  43      * Initialize members w.r.t the dynamic column container in the given table.
  44      */
  45     void init();
  46
  47 public:
  48     EditTextIterator(const ScDocument& rDoc, SCTAB nTab);
  49
  50     const EditTextObject* first();
  51     const EditTextObject* next();
  52 };
  53 }
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */