KDReportsReport.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 KDREPORTSREPORT_H
#define KDREPORTSREPORT_H

#include "KDReportsErrorDetails.h"
#include "KDReportsGlobal.h"
#include <QtCore/QSizeF>
#include <QColor>
#include <QFont>
#include <QTextOption>

#include <QtPrintSupport/QPrinter>

QT_BEGIN_NAMESPACE
class QDomDocument;
class QTextDocumentFragment;
class QTextDocument;
class QDomElement;
class QDomNode;
class QAbstractItemModel;
class QIODevice;
class QRect;
class QPainter;
class ReportData;
class EditorData;
QT_END_NAMESPACE

namespace KDReports {

class MainTable;
class XmlParser;
class Element;
class HeaderReportBuilder;
class Header;
typedef Header Footer;
class ReportPrivate;
class ReportBuilder;
class TextDocument;
class TableBreakingSettingsDialog;
class AutoTableElement;
class XmlElementHandler;

enum HeaderLocation {
    FirstPage = 1, 
    EvenPages = 2, 
    OddPages = 4,  
    LastPage = 8,  
    AllPages = OddPages | EvenPages 
};
Q_DECLARE_FLAGS( HeaderLocations, HeaderLocation )


class KDREPORTS_EXPORT Report : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString documentName READ documentName WRITE setDocumentName)

public:
    explicit Report( QObject* parent = 0 );
    ~Report() override;

    enum ReportMode {
        WordProcessing = 0,
        SpreadSheet = 1
    };

    void setReportMode( ReportMode reportMode );

    ReportMode reportMode() const;

    void setDefaultFont( const QFont& font );

    QFont defaultFont() const;

    MainTable* mainTable() const;

    void addInlineElement( const Element& element );

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

    void addVerticalSpacing( qreal space );

    void addFragment( const QTextDocumentFragment& fragment );

    void addPageBreak();

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

    QTextOption::Tab rightAlignedTab() const;

    QTextOption::Tab middleAlignedTab() const;

    void setParagraphMargins( qreal left, qreal top, qreal right, qreal bottom );

    void setPageSize( const QPrinter::PageSize& size );

    void setPaperSize( const QSizeF & paperSize, QPrinter::Unit unit );

    QPrinter::PageSize pageSize() const;
    void setOrientation( QPrinter::Orientation orientation );
    QPrinter::Orientation orientation() const;

    void setWidthForEndlessPrinter( qreal widthMM );

    void setMargins( qreal top, qreal left, qreal bottom, qreal right );

    void getMargins( qreal* top, qreal* left, qreal* bottom, qreal* right ) const;

    void setTopPageMargin( qreal top );

    qreal topPageMargins() const;

    void setLeftPageMargin( qreal left );

    qreal leftPageMargins() const;

    void setRightPageMargin( qreal right );

    qreal rightPageMargins() const;

    void setBottomPageMargin( qreal bottom );

    qreal bottomPageMargins() const;

    void setHeaderBodySpacing( qreal spacing );

    qreal headerBodySpacing() const;

    void setFooterBodySpacing( qreal spacing );

    qreal footerBodySpacing() const;

    Header& header( HeaderLocations hl = AllPages );

    Footer& footer( HeaderLocations hl = AllPages );

    void associateModel( const QString& modelKey, QAbstractItemModel* model );

    void associateTextValue( const QString& id, const QString& value );

    void associateImageValue( const QString& id, const QPixmap& value );

    void associateImageValue( const QString& id, const QImage& value );

    bool loadFromXML( QIODevice* iodevice, ErrorDetails* details = 0 );

    bool loadFromXML( const QDomDocument& doc, ErrorDetails* details = 0 );

    void setXmlElementHandler( KDReports::XmlElementHandler* handler );

    void setCurrentRow( const QAbstractItemModel *model, int row );

    void setDocumentName( const QString &name );

    QString documentName() const;

    bool printWithDialog( QWidget* parent );

    bool print( QPrinter* printer, QWidget* parent = 0 );

    bool exportToFile( const QString& fileName, QWidget* parent = 0 );

    bool exportToImage( const QSize& size, const QString& fileName, const char* format );

    bool exportToHtml( const QString& fileName );

    void paintPage( int pageNumber, QPainter& painter );

    void setFirstPageNumber( int num );

    int firstPageNumber() const;

    int numberOfPages() const;

    void setTableBreakingEnabled( bool tableBreakingEnabled );

    bool isTableBreakingEnabled() const;

    enum TableBreakingPageOrder { DownThenRight, RightThenDown };

    void setTableBreakingPageOrder( TableBreakingPageOrder pageOrder );

    TableBreakingPageOrder tableBreakingPageOrder() const;

    void setFontScalingFactor( qreal factor );

    qreal fontScalingFactor() const;

    void scaleTo( int numPagesHorizontally, int numPagesVertically );

    int maximumNumberOfPagesForHorizontalScaling() const;
    int maximumNumberOfPagesForVerticalScaling() const;

    void setFixedRowHeight( qreal mm );

    QList<KDReports::AutoTableElement *> autoTableElements() const;

    void regenerateAutoTables();

    void regenerateAutoTableForModel( QAbstractItemModel* model );

    void setWatermarkText( const QString& text,
                           int rotation = 0,
                           const QColor& color = QColor( 204, 204, 204 ),
                           const QFont& font = QFont( QLatin1String( "Helvetica" ), 48 ) );

    QString watermarkText() const;

    int watermarkRotation() const;

    QColor watermarkColor() const;

    QFont watermarkFont() const;

    void setWatermarkPixmap( const QPixmap& pixmap, bool autoGrayOut = true );

    QPixmap watermarkPixmap() const;

    void setWatermarkImage( const QImage& image );

    QImage watermarkImage() const;

    KDReports::HeaderLocations headerLocation(Header* header) const;

    KDReports::HeaderLocations footerLocation(KDReports::Footer *footer) const;

    void setHeaderLocation(HeaderLocations hl, Header *header);

    void setFooterLocation(HeaderLocations hl, Footer *footer);

    QSizeF paperSize() const;

    void dump() const;

    int currentPosition() const;

    void beginEdit();

    void endEdit();

private:
    friend class Test;
    friend class ::ReportData;
    friend class ::EditorData;
    KDReports::TextDocument& doc() const;

    QString asHtml() const;

    void setupPrinter( QPrinter* printer );

private:
    Q_DISABLE_COPY( Report )
    friend class HeaderReportBuilder; // for headerChanged()
    friend class ImageElement; // for textDocumentWidth()
    friend class ChartElement; // for textDocumentWidth()
    friend class XmlParser; // d->m_builder
    friend class Header; // doc()
    friend class PreviewDialogPrivate; // setupPrinter
    friend class PreviewWidgetPrivate; // setupPrinter
    friend class ReportPrivate; // setupPrinter
    ReportPrivate* const d;
};

}

#endif /* KDREPORTSREPORT_H */