Warning, /office/calligra/libs/text/Mainpage.dox is written in an unsupported language. File is not indexed.
0001 /** 0002 * \mainpage 0003 * 0004 * KoText is a library for general use that extends the QText framework 0005 * (codenamed scribe) with an enhanced text-layout which adds features 0006 * required by ODF and general word-processing applications. 0007 * 0008 * You can use KoText at all places where you would normally use a 0009 * QTextDocument as the main text layout class in scribe can be replaced 0010 * on any QTextDocument instance using QTextDocument::setDocumentLayout(). 0011 * This means you can use the Qt API as normal, but you will be 0012 * able to use extra features like the plugins, the variables and the 0013 * ODF loading and saving for all the ODF text-layout features. 0014 * 0015 * TextShape Flake-Plugin 0016 * 0017 * Closely coupled with the kotext library is the text plugin that is 0018 * build on flake technology. All the user interaction dialogs and code 0019 * will reside in that plugin, and the actual heavy lifting of the 0020 * layout also is present only in that plugin. In other words; this 0021 * library will supply you with the APIs but without having the text 0022 * shape plugin loaded you can't show or layout the text. The goal is 0023 * to keep it cheap to link to this library and only provide the bare 0024 * minimum of functionality is the way to get there. The feature- 0025 * package will be completed by the optional text-plugin. 0026 * 0027 * QTextDocument compatibility 0028 * 0029 * The actual content is stored in the QTextDocument, as mentioned before. 0030 * In KoText we support a lot more features than Qt does in its layout 0031 * and this library will allow you to enrich your document with those 0032 * features. The core design goal is that you can use an externally 0033 * created QTextDocument with KoText. This has the implication that all 0034 * the extra content is stored inside the document. We add QTextFormat 0035 * based properties for that as can be seen in the styles (see 0036 * KoParagraphStyle::Properities for instance), and we allow managers to 0037 * be stored on the document too. So for example a KoStyleManager will 0038 * be stored as a property on the QTextDocument and you can access that 0039 * using the KoTextDocument API. Note that you can use the 0040 * KoTextDocument class while using only a QTextDocument instance. 0041 * 0042 * Plugins 0043 * 0044 * There are various plugins for KoText that make it possible for 3rd 0045 * parties to extend the KoText functionality, see the techbase page; 0046 * http://techbase.kde.org/Development/Tutorials/Calligra_Overview#Text_Plugins 0047 * 0048 * ODF compatibility 0049 * 0050 * Loading and saving of documents can be done to and from ODF using the 0051 * open document classes. 0052 * 0053 * Important classes; 0054 * 0055 * KoTextDocumentLayout the main layout class to be set on the QTextDocument. 0056 * 0057 * KoInlineTextObject plugin base for inline objects (and variables) 0058 * 0059 * KoTextEditingPlugin plugin base for text editing plugins. 0060 * 0061 * KoText namespace. 0062 */ 0063 0064 // DOXYGEN_SET_PROJECT_NAME = KoText 0065 // DOXYGEN_SET_IGNORE_PREFIX = Ko K