cppcheck/gui/printablereport.h

77 lines
1.8 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
2022-05-21 12:18:27 +02:00
* Copyright (C) 2007-2022 Cppcheck team.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PRINTABLE_REPORT_H
#define PRINTABLE_REPORT_H
#include "report.h"
#include <QString>
class ErrorItem;
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief Printable (in-memory) report.
* This report formats results and exposes them for printing.
*/
class PrintableReport : public Report {
public:
PrintableReport();
~PrintableReport() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Create the report (file).
* @return true if succeeded, false if file could not be created.
*/
bool create() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write report header.
*/
void writeHeader() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write report footer.
*/
void writeFooter() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write error to report.
* @param error Error data.
*/
void writeError(const ErrorItem &error) override;
/**
2021-08-07 20:51:18 +02:00
* @brief Returns the formatted report.
*/
2017-07-28 11:12:05 +02:00
QString getFormattedReportText() const;
private:
/**
2021-08-07 20:51:18 +02:00
* @brief Stores the formatted report contents.
*/
QString mFormattedReport;
};
/// @}
#endif // PRINTABLE_REPORT_H