summaryrefslogtreecommitdiffstats
path: root/doc/python/orcus/cell.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:48:59 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:48:59 +0000
commitc484829272cd13a738e35412498e12f2c9a194ac (patch)
treea1f5ec09629ee895bd3963fa8820b45f2f4c574b /doc/python/orcus/cell.rst
parentInitial commit. (diff)
downloadliborcus-upstream.tar.xz
liborcus-upstream.zip
Adding upstream version 0.19.2.upstream/0.19.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/python/orcus/cell.rst')
-rw-r--r--doc/python/orcus/cell.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/python/orcus/cell.rst b/doc/python/orcus/cell.rst
new file mode 100644
index 0000000..0143307
--- /dev/null
+++ b/doc/python/orcus/cell.rst
@@ -0,0 +1,31 @@
+
+Cell
+====
+
+.. py:class:: orcus.Cell
+
+ This class represents a single cell within a :py:class:`.Sheet` object.
+
+ .. py:method:: get_formula_tokens
+
+ :rtype: :py:class:`.FormulaTokens`
+ :return: an iterator object for a formula cell.
+
+ Get an iterator object for formula tokens if the cell is a formula cell.
+ This method returns ``None`` for a non-formula cell.
+
+ .. py:attribute:: type
+ :type: orcus.CellType
+
+ Attribute specifying the type of this cell.
+
+ .. py:attribute:: value
+
+ Attribute containing the value of the cell.
+
+ .. py:attribute:: formula
+ :type: str
+
+ Attribute containing the formula string in case of a formula cell. This
+ value will be ``None`` for a non-formula cell.
+