SReport.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshReportInterface/RshReportFwd.h"
#include "RshPluginScript/SClass/SComp.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SReport : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
public:
    enum SPageSize
    {
        A4,
        B5,
        Letter,
        Legal,
        Executive,
        A0,
        A1,
        A2,
        A3,
        A5,
        A6,
        A7,
        A8,
        A9,
        B0,
        B1,
        B10,
        B2,
        B3,
        B4,
        B6,
        B7,
        B8,
        B9,
        C5E,
        Comm10E,
        DLE,
        Folio,
        Ledger,
        Tabloid,
        Custom,
        A10,
        A3Extra,
        A4Extra,
        A4Plus,
        A4Small,
        A5Extra,
        B5Extra,
        JisB0,
        JisB1,
        JisB2,
        JisB3,
        JisB4,
        JisB5,
        JisB6,
        JisB7,
        JisB8,
        JisB9,
        JisB10,
        AnsiC,
        AnsiD,
        AnsiE,
        LegalExtra,
        LetterExtra,
        LetterPlus,
        LetterSmall,
        TabloidExtra,
        ArchA,
        ArchB,
        ArchC,
        ArchD,
        ArchE,
        Imperial7x9,
        Imperial8x10,
        Imperial9x11,
        Imperial9x12,
        Imperial10x11,
        Imperial10x13,
        Imperial10x14,
        Imperial12x11,
        Imperial15x11,
        ExecutiveStandard,
        Note,
        Quarto,
        Statement,
        SuperA,
        SuperB,
        Postcard,
        DoublePostcard,
        Prc16K,
        Prc32K,
        Prc32KBig,
        FanFoldUS,
        FanFoldGerman,
        FanFoldGermanLegal,
        EnvelopeB4,
        EnvelopeB5,
        EnvelopeB6,
        EnvelopeC0,
        EnvelopeC1,
        EnvelopeC2,
        EnvelopeC3,
        EnvelopeC4,
        EnvelopeC6,
        EnvelopeC65,
        EnvelopeC7,
        Envelope9,
        Envelope11,
        Envelope12,
        Envelope14,
        EnvelopeMonarch,
        EnvelopePersonal,
        EnvelopeChou3,
        EnvelopeChou4,
        EnvelopeInvite,
        EnvelopeItalian,
        EnvelopeKaku2,
        EnvelopeKaku3,
        EnvelopePrc1,
        EnvelopePrc2,
        EnvelopePrc3,
        EnvelopePrc4,
        EnvelopePrc5,
        EnvelopePrc6,
        EnvelopePrc7,
        EnvelopePrc8,
        EnvelopePrc9,
        EnvelopePrc10,
        EnvelopeYou4,
        LastPageSize,
        NPageSize,
        NPaperSize,
        AnsiA,
        AnsiB,
        EnvelopeC5,
        EnvelopeDL,
        Envelope10};
 
    static_assert(
        (Number)SPageSize::A4 == (Number)QPageSize::A4,
        "Enum for page size on the script side is different from the Qt enum for page size");
    static_assert(
        (Number)SPageSize::LetterPlus == (Number)QPageSize::LetterPlus,
        "Enum for page size on the script side is different from the Qt enum for page size");
    static_assert(
        (Number)SPageSize::B6 == (Number)QPageSize::B6,
        "Enum for page size on the script side is different from the Qt enum for page size");
    static_assert(
        (Number)SPageSize::EnvelopeYou4 == (Number)QPageSize::EnvelopeYou4,
        "Enum for page size on the script side is different from the Qt enum for page size");
 
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
     SetReportOptions( Array iOptions 
    );
 
    Array AddChapter(
        SReportData ipReportData, 
         String iTemplateToUse =
            "" 
    );
 
    Array SetHeader(
         String iTemplateToUse 
    );
 
    Array SetFooter(
         String iTemplateToUse 
    );
 
    //-------------------------------------------------------------------------------------------------------------------
    Array ExportReportPDF( String iCompletePath 
    );
};
 
// @brief
// this class allow to wrap static function to SReport easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SReport
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots:
 
    static SReport New();
 
    static String toString();
};
Q_DECLARE_METATYPE(SReport::_SReportDummy);
Q_DECLARE_METATYPE(SReport);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC