KiCad PCB EDA Suite
WX_HTML_PANEL_REPORTER Class Reference

Class WX_HTML_PANEL_REPORTER is a wrapper for reporting to a wx HTML window. More...

#include <reporter.h>

Inheritance diagram for WX_HTML_PANEL_REPORTER:
REPORTER

Public Types

enum  SEVERITY {
  RPT_UNDEFINED = 0x0, RPT_INFO = 0x1, RPT_ACTION = 0x2, RPT_WARNING = 0x4,
  RPT_ERROR = 0x8
}
 Severity of the reported messages. More...
 
enum  LOCATION { LOC_HEAD = 0, LOC_BODY, LOC_TAIL }
 Location where the message is to be reported. More...
 

Public Member Functions

 WX_HTML_PANEL_REPORTER (WX_HTML_REPORT_PANEL *aPanel)
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
 Function Report is a pure virtual function to override in the derived object. More...
 
REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
 Function ReportTail Places the report at the end of the list, for objects that support report ordering. More...
 
REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
 Function ReportHead Places the report at the beginning of the list for objects that support ordering. More...
 
bool HasMessage () const override
 Function HasMessage Returns true if the reporter client is non-empty. More...
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_UNDEFINED)
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 

Static Public Attributes

static constexpr int RPT_ALL = RPT_INFO | RPT_ACTION | RPT_WARNING | RPT_ERROR
 

Private Attributes

WX_HTML_REPORT_PANELm_panel
 

Detailed Description

Class WX_HTML_PANEL_REPORTER is a wrapper for reporting to a wx HTML window.

Definition at line 186 of file reporter.h.

Member Enumeration Documentation

◆ LOCATION

enum REPORTER::LOCATION
inherited

Location where the message is to be reported.

LOC_HEAD messages are printed before all others (typically intro messages) LOC_BODY messages are printed in the middle LOC_TAIL messages are printed after all others (typically status messages)

Enumerator
LOC_HEAD 
LOC_BODY 
LOC_TAIL 

Definition at line 90 of file reporter.h.

90  {
91  LOC_HEAD = 0,
92  LOC_BODY,
93  LOC_TAIL
94  };

◆ SEVERITY

enum REPORTER::SEVERITY
inherited

Severity of the reported messages.

Undefined are default status messages Info are processing messages for which no action is taken Action messages are items that modify the file(s) as expected Warning messages are items that might be problematic but don't prevent the process from completing Error messages are items that prevent the process from completing

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_ACTION 
RPT_WARNING 
RPT_ERROR 

Definition at line 74 of file reporter.h.

Constructor & Destructor Documentation

◆ WX_HTML_PANEL_REPORTER()

WX_HTML_PANEL_REPORTER::WX_HTML_PANEL_REPORTER ( WX_HTML_REPORT_PANEL aPanel)
inline

Definition at line 191 of file reporter.h.

191  :
192  REPORTER(),
193  m_panel( aPanel )
194  {
195  }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:188
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61

Member Function Documentation

◆ HasMessage()

bool WX_HTML_PANEL_REPORTER::HasMessage ( ) const
overridevirtual

Function HasMessage Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 94 of file reporter.cpp.

95 {
97 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:188
int Count(int severityMask)
return the number of messages matching the given severity mask.

References WX_HTML_REPORT_PANEL::Count(), m_panel, REPORTER::RPT_ERROR, and REPORTER::RPT_WARNING.

◆ operator<<() [1/4]

REPORTER& REPORTER::operator<< ( const wxString &  aText)
inlineinherited

Definition at line 127 of file reporter.h.

127 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ operator<<() [2/4]

REPORTER& REPORTER::operator<< ( const wxChar *  aText)
inlineinherited

Definition at line 128 of file reporter.h.

128 { return Report( wxString( aText ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ operator<<() [3/4]

REPORTER& REPORTER::operator<< ( wxChar  aChar)
inlineinherited

Definition at line 129 of file reporter.h.

129 { return Report( wxString( aChar ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ operator<<() [4/4]

REPORTER& REPORTER::operator<< ( const char *  aText)
inlineinherited

Definition at line 130 of file reporter.h.

130 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ Report() [1/2]

REPORTER & REPORTER::Report ( const char *  aText,
REPORTER::SEVERITY  aSeverity = RPT_UNDEFINED 
)
inherited

Definition at line 32 of file reporter.cpp.

33 {
34  Report( FROM_UTF8( aText ) );
35  return *this;
36 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:61
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References FROM_UTF8(), and REPORTER::Report().

◆ Report() [2/2]

REPORTER & WX_HTML_PANEL_REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
overridevirtual

Function Report is a pure virtual function to override in the derived object.

Parameters
aTextis the string to report.
aSeverityis an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Implements REPORTER.

Definition at line 67 of file reporter.cpp.

68 {
69  wxCHECK_MSG( m_panel != NULL, *this,
70  wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
71 
72  m_panel->Report( aText, aSeverity );
73  return *this;
74 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:188
void Report(const wxString &aText, REPORTER::SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
Reports the string.

References m_panel, and WX_HTML_REPORT_PANEL::Report().

◆ ReportHead()

REPORTER & WX_HTML_PANEL_REPORTER::ReportHead ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
overridevirtual

Function ReportHead Places the report at the beginning of the list for objects that support ordering.

Reimplemented from REPORTER.

Definition at line 85 of file reporter.cpp.

86 {
87  wxCHECK_MSG( m_panel != NULL, *this,
88  wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
89 
90  m_panel->Report( aText, aSeverity, LOC_HEAD );
91  return *this;
92 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:188
void Report(const wxString &aText, REPORTER::SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
Reports the string.

References REPORTER::LOC_HEAD, m_panel, and WX_HTML_REPORT_PANEL::Report().

◆ ReportTail()

REPORTER & WX_HTML_PANEL_REPORTER::ReportTail ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
overridevirtual

Function ReportTail Places the report at the end of the list, for objects that support report ordering.

Reimplemented from REPORTER.

Definition at line 76 of file reporter.cpp.

77 {
78  wxCHECK_MSG( m_panel != NULL, *this,
79  wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
80 
81  m_panel->Report( aText, aSeverity, LOC_TAIL );
82  return *this;
83 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:188
void Report(const wxString &aText, REPORTER::SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
Reports the string.

References REPORTER::LOC_TAIL, m_panel, and WX_HTML_REPORT_PANEL::Report().

Member Data Documentation

◆ m_panel

WX_HTML_REPORT_PANEL* WX_HTML_PANEL_REPORTER::m_panel
private

Definition at line 188 of file reporter.h.

Referenced by HasMessage(), Report(), ReportHead(), and ReportTail().

◆ RPT_ALL


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