KDReportsXmlElementHandler.h

Go to the documentation of this file.

/****************************************************************************
**
** This file is part of the KD Reports library.
**
** SPDX-FileCopyrightText: 2007-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDAB-KDReports OR LicenseRef-KDAB-KDReports-US
**
** Licensees holding valid commercial KD Reports licenses may use this file in
** accordance with the KD Reports Commercial License Agreement provided with
** the Software.
**
** Contact info@kdab.com if any conditions of this licensing are not clear to you.
**
****************************************************************************/
 
#ifndef KDREPORTSXMLELEMENTHANDLER_H
#define KDREPORTSXMLELEMENTHANDLER_H
 
#include "KDReportsErrorDetails.h"
#include "KDReportsGlobal.h"
#include "KDReportsVariableType.h"
#include <QTextOption>
#include <memory>
 
QT_BEGIN_NAMESPACE
class QDomElement;
QT_END_NAMESPACE
 
namespace KDReports {
 
class Report;
class TextElement;
class HtmlElement;
class TableElement;
class AutoTableElement;
class ChartElement;
class ImageElement;
class HLineElement;
class Header;
typedef Header Footer;
class Cell;
class XmlElementHandlerPrivate;
 
class KDREPORTS_EXPORT XmlElementHandler
{
public:
    XmlElementHandler();
    virtual ~XmlElementHandler();
 
    virtual bool startReport(KDReports::Report &report, QDomElement &xmlElement);
 
    virtual bool startHeader(KDReports::Header &header, QDomElement &xmlElement);
 
    virtual void endHeader(KDReports::Header &header, const QDomElement &xmlElement);
 
    virtual bool startFooter(KDReports::Footer &footer, QDomElement &xmlElement);
 
    virtual void endFooter(KDReports::Footer &footer, const QDomElement &xmlElement);
 
    virtual bool textElement(KDReports::TextElement &textElement, QDomElement &xmlElement);
 
    virtual bool htmlElement(KDReports::HtmlElement &htmlElement, QDomElement &xmlElement);
 
    virtual bool startTableElement(KDReports::TableElement &tableElement, QDomElement &xmlElement);
 
    virtual bool endTableElement(KDReports::TableElement &tableElement, QDomElement &xmlElement);
 
    virtual bool startCell(KDReports::Cell &cell, QDomElement &xmlElement);
 
    virtual bool endCell(KDReports::Cell &cell, QDomElement &xmlElement);
 
    virtual bool autoTableElement(KDReports::AutoTableElement &tableElement, QDomElement &xmlElement);
 
    virtual bool chartElement(KDReports::ChartElement &chartElement, QDomElement &xmlElement);
 
    virtual bool imageElement(KDReports::ImageElement &imageElement, QDomElement &xmlElement);
 
    virtual bool pageBreak(QDomElement &xmlElement);
 
    virtual bool hLineElement(KDReports::HLineElement &hLineElement, QDomElement &xmlElement);
 
    virtual void customElement(const QDomElement &xmlElement);
 
    virtual void endReport(KDReports::Report &report, const QDomElement &xmlElement);
 
    virtual bool variable(KDReports::VariableType &type, QDomElement &xmlElement);
 
    virtual bool vspace(int &size, QDomElement &xmlElement);
 
    virtual bool paragraphMargin(qreal &left, qreal &top, qreal &right, qreal &bottom, const QDomElement &xmlElement);
 
    virtual bool tabs(QList<QTextOption::Tab> &tabs, const QDomElement &xmlElement);
 
    KDReports::ErrorDetails errorDetails();
 
    void setErrorDetails(const KDReports::ErrorDetails &details);
 
private:
    virtual void virtual_hook(int id, void *data);
 
    std::unique_ptr<XmlElementHandlerPrivate> d;
};
 
using XmlElementHandlerPrivateV2 = XmlElementHandlerPrivate; // old compat name from before 2.0
 
}
 
#endif /* KDREPORTSXMLELEMENTHANDLER_H */