Cppcheck
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
XmlReport Class Reference

Base class for XML report classes. More...

#include <xmlreport.h>

Inheritance diagram for XmlReport:
Report XmlReportV2

Public Member Functions

 XmlReport (const QString &filename)
virtual QList< ErrorItemread ()=0
 Read contents of the report file.
- Public Member Functions inherited from Report
 Report (const QString &filename)
virtual ~Report ()
virtual bool create ()
 Create the report (file).
virtual bool open ()
 Open the existing report (file).
void close ()
 Close the report (file).
virtual void writeHeader ()=0
 Write report header.
virtual void writeFooter ()=0
 Write report footer.
virtual void writeError (const ErrorItem &error)=0
 Write error to report.

Static Public Member Functions

static QString quoteMessage (const QString &message)
 Quote the message.
static QString unquoteMessage (const QString &message)
 Unquote the message.
static int determineVersion (const QString &filename)
 Get the XML report format version from the file.

Additional Inherited Members

- Public Types inherited from Report
enum  Type { TXT, XMLV2, CSV }
- Protected Member Functions inherited from Report
QFile * getFile ()
 Get the file object where the report is written to.

Detailed Description

Base class for XML report classes.

Definition at line 36 of file xmlreport.h.

Constructor & Destructor Documentation

XmlReport::XmlReport ( const QString &  filename)
explicit

Definition at line 29 of file xmlreport.cpp.

Member Function Documentation

int XmlReport::determineVersion ( const QString &  filename)
static

Get the XML report format version from the file.

Parameters
filenameFilename of the report file.
Returns
XML report format version or 0 if error happened.

Definition at line 56 of file xmlreport.cpp.

References ResultElementName, and VersionAttribute.

Referenced by ResultsView::readErrorsXml().

QString XmlReport::quoteMessage ( const QString &  message)
static

Quote the message.

Parameters
messageMessage to quote.
Returns
quoted message.

Definition at line 34 of file xmlreport.cpp.

Referenced by XmlReportV2::writeError().

virtual QList<ErrorItem> XmlReport::read ( )
pure virtual

Read contents of the report file.

Implemented in XmlReportV2.

Referenced by ResultsView::readErrorsXml().

QString XmlReport::unquoteMessage ( const QString &  message)
static

Unquote the message.

Parameters
messageMessage to quote.
Returns
quoted message.

Definition at line 45 of file xmlreport.cpp.

Referenced by XmlReportV2::readError().


The documentation for this class was generated from the following files: