xlnt/docs/index.rst

183 lines
6.8 KiB
ReStructuredText
Raw Normal View History

2015-10-31 18:47:38 +08:00
:mod:`xlnt` - user-friendly xlsx library for C++14
===========================================================================
2015-10-31 18:47:38 +08:00
.. module:: xlnt
.. moduleauthor:: Thomas Fussell
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|
2015-10-31 18:47:38 +08:00
Introduction
------------
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.
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 | | | |
2015-10-31 18:47:38 +08:00
Sample code:
++++++++++++
2016-07-22 11:25:24 +08:00
.. literalinclude:: /samples/sample.cpp
2015-10-31 18:47:38 +08:00
How to Contribute Code
----------------------
2016-07-22 11:25:24 +08:00
See :ref:`development`
2015-10-31 18:47:38 +08:00
Installation
------------
2015-10-31 18:47:38 +08:00
Getting the source
------------------
2015-10-31 18:47:38 +08:00
Usage examples
--------------
2015-10-31 18:47:38 +08:00
Tutorial
++++++++
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
tutorial
2015-10-31 18:47:38 +08:00
Cookbook
++++++++
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
cookbook
2015-10-31 18:47:38 +08:00
Charts
++++++
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
charts/introduction
2015-10-31 18:47:38 +08:00
Comments
++++++++
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
comments
2015-10-31 18:47:38 +08:00
Working with styles
+++++++++++++++++++
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
styles
2015-10-31 18:47:38 +08:00
Conditional Formatting
++++++++++++++++++++++
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
formatting
2015-10-31 18:47:38 +08:00
Data Validation
+++++++++++++++
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
validation
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
Parsing Formulas
++++++++++++++++
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
formula
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
Information for Developers
--------------------------
2015-10-31 18:21:21 +08:00
2015-10-31 18:47:38 +08:00
.. toctree::
2015-10-31 18:47:38 +08:00
development
windows-development
2015-10-31 18:47:38 +08:00
API Documentation
------------------
2015-10-31 18:47:38 +08:00
.. toctree::
:maxdepth: 2
2015-10-31 18:47:38 +08:00
api/xlnt
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2015-10-31 18:47:38 +08:00
Release Notes
=============
.. toctree::
:maxdepth: 1
changes