xlnt/docs/index.rst

:mod:`xlnt` - user-friendly xlsx library for C++14
===========================================================================

.. module:: xlnt
.. moduleauthor:: Thomas Fussell

:Author: Thomas Fussell
:Source code: https://github.com/tfussell/xlnt
:Issues: https://github.com/tfussell/xlnt/issues
:Generated: |today|
:License: MIT
:Version: |release|

Introduction
------------

xlnt is a C++14 library for reading, writing, and modifying XLSX files as described in [ECMA 376](http://www.ecma-international.org/publications/standards/Ecma-376.htm). The API is based on [openpyxl](https://bitbucket.org/openpyxl/openpyxl), a Python library to read/write Excel 2007 xlsx/xlsm files, and ultimately on [PHPExcel](https://github.com/PHPOffice/PHPExcel), pure PHP library for reading and writing spreadsheet files upon which openpyxl was based. This project is still very much a work in progress, but the core development work is complete.

Summary of Features
+++++++++++++++++++

| Feature                                                             | Read | Edit | Write |
|---------------------------------------------------------------------|------|------|-------|
| Excel-style Workbook                                                | ✓    | ✓    | ✓     |
| LibreOffice-style Workbook                                          | ✓    | ✓    | ✓     |
| Numbers-style Workbook                                              | ✓    | ✓    | ✓     |
| Encrypted Workbook (Excel 2007-2010)                                | ✓    | ✓    |       |
| Encrypted Workbook (Excel 2013-2016)                                | ✓    | ✓    |       |
| Excel Binary Workbook (.xlsb)                                       |      |      |       |
| Excel Macro-Enabled Workbook (.xlsm)                                |      |      |       |
| Excel Macro-Enabled Template (.xltm)                                |      |      |       |
| Document Properties                                                 | ✓    | ✓    | ✓     |
| Numeric Cell Values                                                 | ✓    | ✓    | ✓     |
| Inline String Cell Values                                           | ✓    | ✓    | ✓     |
| Shared String Cell Values                                           | ✓    | ✓    | ✓     |
| Shared String Text Run Formatting (e.g. varied fonts within a cell) | ✓    | ✓    | ✓     |
| Hyperlink Cell Values                                               |      |      |       |
| Formula Cell Values                                                 |      |      |       |
| Formula Evaluation                                                  |      |      |       |
| Page Margins                                                        | ✓    | ✓    | ✓     |
| Page Setup                                                          |      |      |       |
| Print Area                                                          |      |      |       |
| Comments                                                            |      |      |       |
| Header and Footer                                                   |      |      |       |
| Custom Views                                                        |      |      |       |
| Charts                                                              |      |      |       |
| Chartsheets                                                         |      |      |       |
| Dialogsheets                                                        |      |      |       |
| Themes                                                              | ✓    |      | ✓     |
| Cell Styles                                                         | ✓    | ✓    | ✓     |
| Cell Formats                                                        | ✓    | ✓    | ✓     |
| Formatting->Alignment (e.g. right align)                            | ✓    | ✓    | ✓     |
| Formatting->Border (e.g. red cell outline)                          | ✓    | ✓    | ✓     |
| Formatting->Fill (e.g. green cell background)                       | ✓    | ✓    | ✓     |
| Formatting->Font (e.g. blue cell text)                              | ✓    | ✓    | ✓     |
| Formatting->Number Format (e.g. show 2 decimals)                    | ✓    | ✓    | ✓     |
| Formatting->Protection (e.g. hide formulas)                         | ✓    | ✓    | ✓     |
| Column Styles                                                       |      |      |       |
| Row Styles                                                          |      |      |       |
| Sheet Styles                                                        |      |      |       |
| Conditional Formatting                                              |      |      |       |
| Tables                                                              |      |      |       |
| Table Formatting                                                    |      |      |       |
| Pivot Tables                                                        |      |      |       |
| XLSX Thumbnail                                                      | ✓    |      | ✓     |
| Custom OOXML Properties                                             |      |      |       |
| Custom OOXML Parts                                                  |      |      |       |
| Drawing                                                             |      |      |       |
| Text Box                                                            |      |      |       |
| WordArt                                                             |      |      |       |
| Embedded Content (e.g. images)                                      |      |      |       |
| Excel VBA                                                           |      |      |       |

Sample code:
++++++++++++

.. literalinclude:: /samples/sample.cpp


How to Contribute Code
----------------------

See :ref:`development`

Installation
------------

Getting the source
------------------

Usage examples
--------------

Tutorial
++++++++

.. toctree::

    tutorial

Cookbook
++++++++

.. toctree::

    cookbook

Charts
++++++

.. toctree::

    charts/introduction

Comments
++++++++

.. toctree::

    comments

Working with styles
+++++++++++++++++++

.. toctree::

    styles

Conditional Formatting
++++++++++++++++++++++

.. toctree::

    formatting

Data Validation
+++++++++++++++

.. toctree::

    validation

Parsing Formulas
++++++++++++++++

.. toctree::

    formula


Information for Developers
--------------------------

.. toctree::

    development
    windows-development

API Documentation
------------------

.. toctree::
    :maxdepth: 2

    api/xlnt


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Release Notes
=============

.. toctree::
    :maxdepth: 1

    changes
update docs 2015-10-31 18:47:38 +08:00			:mod:`xlnt` - user-friendly xlsx library for C++14
			`===========================================================================`
init sphinx documentation, add some linux build scripts 2015-10-26 22:41:00 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. module:: xlnt`
			`.. moduleauthor:: Thomas Fussell`
init sphinx documentation, add some linux build scripts 2015-10-26 22:41:00 +08:00
update docs 2015-10-31 18:47:38 +08:00			`:Author: Thomas Fussell`
			`:Source code: https://github.com/tfussell/xlnt`
			`:Issues: https://github.com/tfussell/xlnt/issues`
			`:Generated: \|today\|`
			`:License: MIT`
			`:Version: \|release\|`
init sphinx documentation, add some linux build scripts 2015-10-26 22:41:00 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Introduction`
			`------------`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
work on docs 2016-07-22 11:25:24 +08:00			xlnt is a C++14 library for reading, writing, and modifying XLSX files as described in [ECMA 376](http://www.ecma-international.org/publications/standards/Ecma-376.htm). The API is based on [openpyxl](https://bitbucket.org/openpyxl/openpyxl), a Python library to read/write Excel 2007 xlsx/xlsm files, and ultimately on [PHPExcel](https://github.com/PHPOffice/PHPExcel), pure PHP library for reading and writing spreadsheet files upon which openpyxl was based. This project is still very much a work in progress, but the core development work is complete.
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
clean up cmake build, fix warnings, improve configuration, general housekeeping, fixes #72, fixes #70 2016-10-26 08:21:58 +08:00			`Summary of Features`
			`+++++++++++++++++++`

			`\| Feature \| Read \| Edit \| Write \|`
			`\|---------------------------------------------------------------------\|------\|------\|-------\|`
			`\| Excel-style Workbook \| ✓ \| ✓ \| ✓ \|`
			`\| LibreOffice-style Workbook \| ✓ \| ✓ \| ✓ \|`
			`\| Numbers-style Workbook \| ✓ \| ✓ \| ✓ \|`
			`\| Encrypted Workbook (Excel 2007-2010) \| ✓ \| ✓ \| \|`
			`\| Encrypted Workbook (Excel 2013-2016) \| ✓ \| ✓ \| \|`
			`\| Excel Binary Workbook (.xlsb) \| \| \| \|`
			`\| Excel Macro-Enabled Workbook (.xlsm) \| \| \| \|`
			`\| Excel Macro-Enabled Template (.xltm) \| \| \| \|`
			`\| Document Properties \| ✓ \| ✓ \| ✓ \|`
			`\| Numeric Cell Values \| ✓ \| ✓ \| ✓ \|`
			`\| Inline String Cell Values \| ✓ \| ✓ \| ✓ \|`
			`\| Shared String Cell Values \| ✓ \| ✓ \| ✓ \|`
			`\| Shared String Text Run Formatting (e.g. varied fonts within a cell) \| ✓ \| ✓ \| ✓ \|`
			`\| Hyperlink Cell Values \| \| \| \|`
			`\| Formula Cell Values \| \| \| \|`
			`\| Formula Evaluation \| \| \| \|`
			`\| Page Margins \| ✓ \| ✓ \| ✓ \|`
			`\| Page Setup \| \| \| \|`
			`\| Print Area \| \| \| \|`
			`\| Comments \| \| \| \|`
			`\| Header and Footer \| \| \| \|`
			`\| Custom Views \| \| \| \|`
			`\| Charts \| \| \| \|`
			`\| Chartsheets \| \| \| \|`
			`\| Dialogsheets \| \| \| \|`
			`\| Themes \| ✓ \| \| ✓ \|`
			`\| Cell Styles \| ✓ \| ✓ \| ✓ \|`
			`\| Cell Formats \| ✓ \| ✓ \| ✓ \|`
			`\| Formatting->Alignment (e.g. right align) \| ✓ \| ✓ \| ✓ \|`
			`\| Formatting->Border (e.g. red cell outline) \| ✓ \| ✓ \| ✓ \|`
			`\| Formatting->Fill (e.g. green cell background) \| ✓ \| ✓ \| ✓ \|`
			`\| Formatting->Font (e.g. blue cell text) \| ✓ \| ✓ \| ✓ \|`
			`\| Formatting->Number Format (e.g. show 2 decimals) \| ✓ \| ✓ \| ✓ \|`
			`\| Formatting->Protection (e.g. hide formulas) \| ✓ \| ✓ \| ✓ \|`
			`\| Column Styles \| \| \| \|`
			`\| Row Styles \| \| \| \|`
			`\| Sheet Styles \| \| \| \|`
			`\| Conditional Formatting \| \| \| \|`
			`\| Tables \| \| \| \|`
			`\| Table Formatting \| \| \| \|`
			`\| Pivot Tables \| \| \| \|`
			`\| XLSX Thumbnail \| ✓ \| \| ✓ \|`
			`\| Custom OOXML Properties \| \| \| \|`
			`\| Custom OOXML Parts \| \| \| \|`
			`\| Drawing \| \| \| \|`
			`\| Text Box \| \| \| \|`
			`\| WordArt \| \| \| \|`
			`\| Embedded Content (e.g. images) \| \| \| \|`
			`\| Excel VBA \| \| \| \|`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Sample code:`
			`++++++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
work on docs 2016-07-22 11:25:24 +08:00			`.. literalinclude:: /samples/sample.cpp`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00

update docs 2015-10-31 18:47:38 +08:00			`How to Contribute Code`
			`----------------------`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
work on docs 2016-07-22 11:25:24 +08:00			See :ref:`development`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Installation`
			`------------`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Getting the source`
			`------------------`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Usage examples`
			`--------------`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Tutorial`
			`++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`tutorial`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Cookbook`
			`++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`cookbook`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Charts`
			`++++++`
update docs 2015-10-31 18:21:21 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`charts/introduction`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Comments`
			`++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
update docs 2015-10-31 18:21:21 +08:00
update docs 2015-10-31 18:47:38 +08:00			`comments`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Working with styles`
			`+++++++++++++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`styles`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Conditional Formatting`
			`++++++++++++++++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`formatting`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Data Validation`
			`+++++++++++++++`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`validation`
update docs 2015-10-31 18:21:21 +08:00
update docs 2015-10-31 18:47:38 +08:00			`Parsing Formulas`
			`++++++++++++++++`
update docs 2015-10-31 18:21:21 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
update docs 2015-10-31 18:21:21 +08:00
update docs 2015-10-31 18:47:38 +08:00			`formula`
update docs 2015-10-31 18:21:21 +08:00

update docs 2015-10-31 18:47:38 +08:00			`Information for Developers`
			`--------------------------`
update docs 2015-10-31 18:21:21 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`development`
			`windows-development`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`API Documentation`
			`------------------`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`.. toctree::`
			`:maxdepth: 2`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
update docs 2015-10-31 18:47:38 +08:00			`api/xlnt`
better docs theme, actually add classes to the documentation 2015-10-26 23:43:48 +08:00
init sphinx documentation, add some linux build scripts 2015-10-26 22:41:00 +08:00
			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`

update docs 2015-10-31 18:47:38 +08:00
			`Release Notes`
			`=============`

			`.. toctree::`
			`:maxdepth: 1`

			`changes`