Warning, /office/calligra/filters/libodf2/README is written in an unsupported language. File is not indexed.

0001 Overview
0002 --------
0003 
0004 This library contains classes that are related to ODF but which are
0005 not used by any application or by any library in libs/. Most of the
0006 time this means that the classes are used by the filters, which is the
0007 reason why this library is placed here.
0008 
0009 The reason why the applications are not using them is often that these
0010 classes are pure storage classes and the applications have more
0011 advanced implementations that allow editing with good performance.
0012 Examples of such classes are style classes and objects that are part
0013 of text contents.
0014 
0015 If a class is interesting to use in an application it should be moved
0016 to libs/odf.
0017 
0018 
0019 Contents
0020 --------
0021 
0022 The current classes in libodf2 are written in two different batches
0023 and also represent two different sets of features and priorities.
0024 
0025 1. Text table and table style objects
0026 
0027 The first set was written for the OOXML import filters. They do not
0028 support loading from ODF, only writing to it. The main purpose of
0029 these classes is to be fast so it uses binary representation of the
0030 properties.
0031 
0032 It contains the following classes:
0033 
0034 1.1. Objects representing table objects of different kinds:
0035 
0036  - KoTable
0037  - KoColumn
0038  - KoRow
0039  - KoCellChild
0040  - KoCell
0041  - KoCellValue
0042  - KoDummyCellValue
0043  - KoRawCellChild
0044 
0045 1.2. Style objects
0046 
0047 Objects representing styles for the objects above.  They use a binary
0048 representation of style properties and implement only parts of the
0049 style properties defined in the ODF standard.
0050 
0051  - KoStyle
0052  - KoTblStyle
0053  - KoColumnStyle
0054  - KoRowStyle
0055  - KoCellStyle
0056 
0057 
0058 2. General style objects
0059 
0060 The second set was written to also represent styles in ODF. However,
0061 the main purpose is to be complete, i.e. they are intended to be able
0062 to represent all types of style properties, both the simple name/value
0063 pairs and more complex content in child elements.
0064 
0065 These style objects use text representation and do not provide any
0066 parsing to any other datatypes (yet). They all use the
0067 KoXmlStreamReader to parse their input.
0068 
0069  - KoOdfStyleManager
0070  - KoOdfStyle
0071  - KoOdfStyleProperties
0072  - KoOdfTextProperties
0073  - KoOdfParagraphProperties
0074  - KoOdfGraphicProperties
0075  - KoOdfPageLayoutProperties
0076  - KoOdfHeaderFooterProperties
0077 
0078  - KoXmlStreamReader
0079 
0080 
0081 Future plans
0082 ------------
0083 
0084 Only the second set is actively developed at this time (early
0085 2014). It is our intention to make this set of classes more complete
0086 and in the end be able to represent all types of style property sets
0087 and also all types of styles.
0088 
0089 As a second priority it is our intention to combine the sets so that
0090 we have only one set of content and style objects in libodf2.