File indexing completed on 2024-05-12 16:29:19

 /* This file is part of the KDE project
 
    Copyright (C) 2012-2013 Inge Wallin            <inge@lysator.liu.se>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */
 
 #ifndef ODTREADER_H
 #define ODTREADER_H
 
 // Qt
 #include <QHash>
 #include <QString>
 
 // Calligra
 #include <KoXmlStreamReader.h>
 
 // this library
 #include "koodfreader_export.h"
 #include "OdfReader.h"
 #include "OdfReaderInternals.h"
 
 
 
 class OdtReaderBackend;
 class OdfReaderContext;
 
 class OdfTextReader;
 
 
 /** @brief Read the XML tree of the content of an ODT file.
  *
  * The OdtReader is used to traverse (read) the contents of an ODT
  * file using an XML stream reader.  For every XML element that the
  * reading process comes across it will call a specific function in a
  * backend class: @see OdtReaderBackend.
  *
  * Before the reading process is started the ODT file will be
  * analyzed to collect some data that may be needed during the
  * read: metadata, manifest and styles are examples of this. This
  * data is stored in the so called reading context, which is kept in
  * an instance of the OdfReaderContext class.
  *
  * The context will be passed around to the backend in every call to a
  * backend callback function.
  *
  * In addition to the pre-analyzed data from the ODT file, the context
  * can be used to keep track of data that is used in the backend
  * processing such as internal links, lists of embedded data such as
  * pictures.
  */
 class KOODFREADER_EXPORT OdtReader : public OdfReader
 {
  public:
     OdtReader();
     ~OdtReader() override;
 
  protected:
     // ODT document level functions
     DECLARE_READER_FUNCTION(OfficeText) override;
 
  private:
     // Not much here. Most are already in OdfReader.
 };
 
 #endif // ODTREADER_H