report.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef REPORT_UTILS_H
#define REPORT_UTILS_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "utils_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QString>
#include <QStringList>
#include <QList>
#include <QPair>
 
//=============================================================================================================
// DEFINE NAMESPACE UTILSLIB
//=============================================================================================================
 
namespace UTILSLIB
{
 
//=============================================================================================================
struct UTILSSHARED_EXPORT ReportSection
{
    QString title;
    QString htmlContent;
};
 
//=============================================================================================================
class UTILSSHARED_EXPORT Report
{
public:
    //=========================================================================================================
    explicit Report(const QString& sTitle = "MNE-CPP Report");
 
    //=========================================================================================================
    void addText(const QString& sTitle, const QString& sContent);
 
    //=========================================================================================================
    void addTable(const QString& sTitle,
                   const QStringList& headers,
                   const QList<QStringList>& rows);
 
    //=========================================================================================================
    void addKeyValue(const QString& sTitle,
                      const QList<QPair<QString, QString>>& pairs);
 
    //=========================================================================================================
    void addCode(const QString& sTitle, const QString& sCode);
 
    //=========================================================================================================
    int sectionCount() const { return m_sections.size(); }
 
    //=========================================================================================================
    QString toHtml() const;
 
    //=========================================================================================================
    bool save(const QString& sPath) const;
 
    //=========================================================================================================
    const QString& title() const { return m_sTitle; }
 
private:
    QString m_sTitle;
    QList<ReportSection> m_sections;
};
 
} // namespace UTILSLIB
 
#endif // REPORT_UTILS_H