libmwaw documentation

This document contains both the libmwaw API specification and the normal libmwaw documentation.

# libmwaw API documentation

The external libmwaw API is provided by the MWAWDocument class. This class with MWAWPropertyHandler, combined with the libwpd's WPXDocumentInterface class are the only three classes that will be of interest for the application programmer using libmwaw.

- The class MWAWPropertyHandler is a small class which can decode the internal encoded format used to export odg's data.
- libmwaw can add some non-standart properties in some property list of WPXDocumentInterface, these properties can be ignored or used:
  - Properties "fo:border", "fo:border-left", "fo:border-right", "fo:border-top", "fo:border-bottom" can appear in the property list of OpenParagraph.
  - Encoded object with "libwpd:mimetype"="image/mwaw-odg" can be given to insertBinaryObject. In this case, MWAWPropertyHandler can be used to decode the data which is an encoded odg picture.

# libmwaw documentation

If you are interrested in the structure of libmwaw itself, this whole document would be a good starting point for exploring the interals of libmwaw. Mind that this document is a work-in-progress, and will most likely not cover libmwaw for the full 100%.

Warning
  When compiled with -DDEBUG_WITH__FILES, code is added to store the results of the parsing in different files: one file by Ole parts ( or sometimes to reconstruct a part of file which is stored discontinuously ) and some files to store the read pictures. These files are created in the current repository, therefore it is recommended to launch the tests in a empty repository...