summaryrefslogtreecommitdiffstats
path: root/doc/cpp/spreadsheet-doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cpp/spreadsheet-doc')
-rw-r--r--doc/cpp/spreadsheet-doc/document.rst9
-rw-r--r--doc/cpp/spreadsheet-doc/import-export.rst50
-rw-r--r--doc/cpp/spreadsheet-doc/index.rst21
-rw-r--r--doc/cpp/spreadsheet-doc/pivot.rst21
-rw-r--r--doc/cpp/spreadsheet-doc/shared-strings.rst10
-rw-r--r--doc/cpp/spreadsheet-doc/sheet.rst6
-rw-r--r--doc/cpp/spreadsheet-doc/styles.rst30
-rw-r--r--doc/cpp/spreadsheet-doc/table.rst9
-rw-r--r--doc/cpp/spreadsheet-doc/types.rst5
-rw-r--r--doc/cpp/spreadsheet-doc/view.rst9
10 files changed, 170 insertions, 0 deletions
diff --git a/doc/cpp/spreadsheet-doc/document.rst b/doc/cpp/spreadsheet-doc/document.rst
new file mode 100644
index 0000000..0b03610
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/document.rst
@@ -0,0 +1,9 @@
+
+Document
+========
+
+.. doxygenclass:: orcus::spreadsheet::document
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::document_config
+ :members:
diff --git a/doc/cpp/spreadsheet-doc/import-export.rst b/doc/cpp/spreadsheet-doc/import-export.rst
new file mode 100644
index 0000000..0c5b801
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/import-export.rst
@@ -0,0 +1,50 @@
+
+Import and export
+=================
+
+The classes in this section can be viewed as the points of entry for initiating
+import or export processes.
+
+The :cpp:class:`~orcus::spreadsheet::import_factory` class wraps
+:cpp:class:`~orcus::spreadsheet::document` as its destination storage then
+gets passed to an import filter class that parses the content of an input file
+and populates the destination document store.
+
+The :cpp:class:`~orcus::spreadsheet::import_styles` class works similarly to
+:cpp:class:`~orcus::spreadsheet::import_factory` in that it wraps
+:cpp:class:`~orcus::spreadsheet::styles` as its destination storage then gets
+passed to a styles import parser in order to get the destination store
+populated. Although this class is used by
+:cpp:class:`~orcus::spreadsheet::import_factory` internally, it can also be
+instantiated independently to allow loading of just the styles data.
+
+The :cpp:class:`~orcus::spreadsheet::export_factory` also works in a similar
+fashion, however; the export functionality of the orcus library is currently
+very limited and should be considered experimental. It is currently only used
+by :cpp:class:`~orcus::orcus_xml` to export the content of a document which
+was originally imported from an XML document.
+
+.. warning::
+
+ The export functionality of the orcus library is highly experimental.
+
+
+Import factory
+--------------
+
+.. doxygenclass:: orcus::spreadsheet::import_factory
+ :members:
+
+
+Import styles
+-------------
+
+.. doxygenclass:: orcus::spreadsheet::import_styles
+ :members:
+
+
+Export factory
+--------------
+
+.. doxygenclass:: orcus::spreadsheet::export_factory
+ :members:
diff --git a/doc/cpp/spreadsheet-doc/index.rst b/doc/cpp/spreadsheet-doc/index.rst
new file mode 100644
index 0000000..b0c2c94
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/index.rst
@@ -0,0 +1,21 @@
+
+Spreadsheet document
+====================
+
+This section contains the API's related to the spreadsheet document storage, which
+is provided by the ``liborcus-spreadsheet`` part of this library. This ``liborcus-spreadsheet``
+module has dependency on the :ref:`ixion <ixion:index>` library in order to perform
+computation of formula cells.
+
+.. toctree::
+ :maxdepth: 1
+
+ types.rst
+ document.rst
+ sheet.rst
+ table.rst
+ pivot.rst
+ styles.rst
+ view.rst
+ shared-strings.rst
+ import-export.rst
diff --git a/doc/cpp/spreadsheet-doc/pivot.rst b/doc/cpp/spreadsheet-doc/pivot.rst
new file mode 100644
index 0000000..00c1a16
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/pivot.rst
@@ -0,0 +1,21 @@
+
+Pivot table
+===========
+
+.. doxygenstruct:: orcus::spreadsheet::pivot_cache_record_value_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::pivot_cache_item_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::pivot_cache_group_data_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::pivot_cache_field_t
+ :members:
+
+.. doxygenclass:: orcus::spreadsheet::pivot_cache
+ :members:
+
+.. doxygenclass:: orcus::spreadsheet::pivot_collection
+ :members:
diff --git a/doc/cpp/spreadsheet-doc/shared-strings.rst b/doc/cpp/spreadsheet-doc/shared-strings.rst
new file mode 100644
index 0000000..799e57b
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/shared-strings.rst
@@ -0,0 +1,10 @@
+
+Shared strings
+==============
+
+.. doxygenclass:: orcus::spreadsheet::shared_strings
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::format_run
+.. doxygentypedef:: orcus::spreadsheet::format_runs_t
+
diff --git a/doc/cpp/spreadsheet-doc/sheet.rst b/doc/cpp/spreadsheet-doc/sheet.rst
new file mode 100644
index 0000000..e1cf87e
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/sheet.rst
@@ -0,0 +1,6 @@
+
+Sheet
+=====
+
+.. doxygenclass:: orcus::spreadsheet::sheet
+ :members:
diff --git a/doc/cpp/spreadsheet-doc/styles.rst b/doc/cpp/spreadsheet-doc/styles.rst
new file mode 100644
index 0000000..59d7f77
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/styles.rst
@@ -0,0 +1,30 @@
+
+Styles
+======
+
+.. doxygenclass:: orcus::spreadsheet::styles
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::font_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::fill_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::border_attrs_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::border_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::protection_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::number_format_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::cell_format_t
+ :members:
+
+.. doxygenstruct:: orcus::spreadsheet::cell_style_t
+ :members:
diff --git a/doc/cpp/spreadsheet-doc/table.rst b/doc/cpp/spreadsheet-doc/table.rst
new file mode 100644
index 0000000..4b44e42
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/table.rst
@@ -0,0 +1,9 @@
+
+Table and autofilter
+====================
+
+.. doxygenstruct:: orcus::spreadsheet::auto_filter_column_t
+.. doxygenstruct:: orcus::spreadsheet::auto_filter_t
+.. doxygenstruct:: orcus::spreadsheet::table_column_t
+.. doxygenstruct:: orcus::spreadsheet::table_style_t
+.. doxygenstruct:: orcus::spreadsheet::table_t
diff --git a/doc/cpp/spreadsheet-doc/types.rst b/doc/cpp/spreadsheet-doc/types.rst
new file mode 100644
index 0000000..51a8489
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/types.rst
@@ -0,0 +1,5 @@
+
+Types
+=====
+
+.. doxygenstruct:: orcus::spreadsheet::color_t
diff --git a/doc/cpp/spreadsheet-doc/view.rst b/doc/cpp/spreadsheet-doc/view.rst
new file mode 100644
index 0000000..79c07dd
--- /dev/null
+++ b/doc/cpp/spreadsheet-doc/view.rst
@@ -0,0 +1,9 @@
+
+View
+====
+
+.. doxygenclass:: orcus::spreadsheet::view
+ :members:
+
+.. doxygenclass:: orcus::spreadsheet::sheet_view
+ :members: