summaryrefslogtreecommitdiffstats
path: root/sc/inc/edittextiterator.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'sc/inc/edittextiterator.hxx')
-rw-r--r--sc/inc/edittextiterator.hxx55
1 files changed, 55 insertions, 0 deletions
diff --git a/sc/inc/edittextiterator.hxx b/sc/inc/edittextiterator.hxx
new file mode 100644
index 0000000000..8bcbc1f7b3
--- /dev/null
+++ b/sc/inc/edittextiterator.hxx
@@ -0,0 +1,55 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#pragma once
+
+#include "types.hxx"
+#include "mtvelements.hxx"
+
+class ScTable;
+class ScDocument;
+class EditTextObject;
+
+namespace sc
+{
+/**
+ * Iterate through all edit text cells in a given sheet. The caller must
+ * check the validity of the sheet index passed to its constructor.
+ *
+ * It iterates from top to bottom, and then left to right order.
+ */
+class EditTextIterator
+{
+ const ScTable& mrTable;
+ SCCOL mnCol;
+ const CellStoreType* mpCells;
+ CellStoreType::const_position_type maPos;
+ CellStoreType::const_iterator miEnd;
+
+ /**
+ * Move to the next edit text cell position if the current position is not
+ * an edit text.
+ */
+ const EditTextObject* seek();
+
+ void incBlock();
+ /**
+ * Initialize members w.r.t the dynamic column container in the given table.
+ */
+ void init();
+
+public:
+ EditTextIterator(const ScDocument& rDoc, SCTAB nTab);
+
+ const EditTextObject* first();
+ const EditTextObject* next();
+};
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */