ksayit/src/parasaxparser.h

   1 //
   2 // C++ Interface: parasaxparser
   3 //
   4 // Description: SAX2-Parser for 'para' elements of a DocBook file.
   5 //
   6 //
   7 // Author: Robert Vogl <voglrobe@web.de>, (C) 2005
   8 //
   9 // Copyright: See COPYING file that comes with this distribution
  10 //
  11 //
  12 #ifndef PARASAXPARSER_H
  13 #define PARASAXPARSER_H
  14
  15 // Qt includes
  16 #include <qxml.h>
  17 #include <qstring.h>
  18
  19 // App specific includes
  20 #include "saxhandler.h"
  21
  22 /**
  23 This class is a singleton.
  24 @author Robert Vogl
  25 */
  26 class ParaSaxParser{
  27 public:
  28    ~ParaSaxParser();
  29
  30     /**
  31      * Creates the single instance of this parser (if not
  32      * allready exists) and returns a pointer to it.
  33      */
  34     static ParaSaxParser* Instance();
  35
  36     /**
  37      * Because this parser sees nothing but the 'para'
  38      * parts of the document, it requires the documents header
  39      * info, e.g. to resolve entities defined in the internal DTD.
  40      * \param data The header (preamble) of the DocBook document.
  41      */
  42     void setProcessingInstruction(const QString &data);
  43
  44     /**
  45      * This is the 'para' element to parse. It has to be encapsulated
  46      * in <para> and </para>. Nested 'para' elements are not supported.
  47      * \param data See description.
  48      */
  49     void setData(const QString &data);
  50
  51     /**
  52      * Returns the pure text content of the paragraph without tags.
  53      * \param data See description.
  54      */
  55     void getText(QString &data);
  56
  57     /**
  58      * Returns the text in RTF format, i.e. replaces DocBook tags
  59      * with RTF tags.
  60      * \param data See description.
  61      */
  62     void getRTFText(QString &data);
  63
  64 protected:
  65     ParaSaxParser();
  66
  67 private:
  68     static ParaSaxParser* _instance;
  69     SaxHandler* m_handler;
  70     QXmlSimpleReader* m_reader;
  71     QString m_XmlInputHeader;
  72     QString m_XmlInputBody;
  73
  74
  75 };
  76
  77 #endif