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 #ifndef INCLUDED_SC_INC_EDITTEXTITERATOR_HXX
  11 #define INCLUDED_SC_INC_EDITTEXTITERATOR_HXX
  12
  13 #include "address.hxx"
  14 #include "mtvelements.hxx"
  15
  16 class ScColumn;
  17 class ScTable;
  18 class ScDocument;
  19 class EditTextObject;
  20
  21 namespace sc {
  22
  23 /**
  24  * Iterate through all edit text cells in a given sheet.  The caller must
  25  * check the validity of the sheet index passed to its constructor.
  26  *
  27  * It iterates from top to bottom, and then left to right order.
  28  */
  29 class EditTextIterator
  30 {
  31     const ScTable& mrTable;
  32     const ScColumn* mpCol;
  33     const ScColumn* mpColEnd;
  34     const CellStoreType* mpCells;
  35     CellStoreType::const_position_type maPos;
  36     CellStoreType::const_iterator miEnd;
  37
  38     /**
  39      * Move to the next edit text cell position if the current position is not
  40      * an edit text.
  41      */
  42     const EditTextObject* seek();
  43
  44     /**
  45      * Increment current position by one.
  46      */
  47     void incPos();
  48     void incBlock();
  49
  50 public:
  51     EditTextIterator( const ScDocument& rDoc, SCTAB nTab );
  52
  53     const EditTextObject* first();
  54     const EditTextObject* next();
  55 };
  56
  57 }
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */