KDReportsHeader.h

/****************************************************************************
**
** This file is part of the KD Reports library.
**
** SPDX-FileCopyrightText: 2007-2020 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 KDREPORTSHEADER_H
#define KDREPORTSHEADER_H

#include "KDReportsGlobal.h"
#include "KDReportsVariableType.h"
#include <QtCore/Qt>
#include <QTextOption>

QT_BEGIN_NAMESPACE
template<class T> class QList;
class QFont;
class QTextDocument;
class HeaderData;
QT_END_NAMESPACE

namespace KDReports {

class HeaderPrivate;
class XmlParser;
class Element;
class HeaderMap;
class Report;
class ReportPrivate;
class TextDocument;

class KDREPORTS_EXPORT Header
{
public:
    void setDefaultFont( const QFont& font );

    QFont defaultFont() const;

    void addInlineElement( const Element& element );

    void addElement( const Element& element, Qt::AlignmentFlag horizontalAlignment = Qt::AlignLeft );

    void addVariable( VariableType variable );

    void addVerticalSpacing( qreal space );

    void setTabPositions( const QList<QTextOption::Tab>& tabs );

    int currentPosition() const;

private:
    friend class XmlParser;
    friend class Report;
    friend class ReportPrivate;
    explicit Header( Report* report );
    ~Header();
    friend class Test;
    friend class HeaderMap;
    friend class ::HeaderData;
    TextDocument& doc();
    void preparePaintingPage( int pageNumber );

    Q_DISABLE_COPY( Header )

    HeaderPrivate* const d;
};

typedef Header Footer;

}

#endif /* KDREPORTSHEADER_H */