KiCad PCB EDA Suite
WX_HTML_PANEL_REPORTER Class Reference

A wrapper for reporting to a wx HTML window. More...

#include <reporter.h>

Inheritance diagram for WX_HTML_PANEL_REPORTER:
REPORTER

Public Types

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)
 
virtual ~WX_HTML_PANEL_REPORTER ()
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Report a string with a given severity. More...
 
REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Places the report at the end of the list, for objects that support report ordering. More...
 
REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Places the report at the beginning of the list for objects that support ordering. More...
 
bool HasMessage () const override
 Returns true if the reporter client is non-empty. More...
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 
REPORTERoperator<< (const wxString &aText)
 
virtual EDA_UNITS GetUnits () const
 

Private Attributes

WX_HTML_REPORT_PANELm_panel
 

Detailed Description

A wrapper for reporting to a wx HTML window.

Definition at line 188 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 79 of file reporter.h.

79  {
80  LOC_HEAD = 0,
81  LOC_BODY,
82  LOC_TAIL
83  };

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:213
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:70

◆ ~WX_HTML_PANEL_REPORTER()

virtual WX_HTML_PANEL_REPORTER::~WX_HTML_PANEL_REPORTER ( )
inlinevirtual

Definition at line 197 of file reporter.h.

198  {
199  }

Member Function Documentation

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 123 of file reporter.h.

124  {
125  return EDA_UNITS::MILLIMETRES;
126  }

References MILLIMETRES.

Referenced by BOARD_INSPECTION_TOOL::reportClearance().

◆ HasMessage()

bool WX_HTML_PANEL_REPORTER::HasMessage ( ) const
overridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 105 of file reporter.cpp.

106 {
108 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:213
int Count(int severityMask)
sets the frame label

References WX_HTML_REPORT_PANEL::Count(), m_panel, RPT_SEVERITY_ERROR, and RPT_SEVERITY_WARNING.

◆ operator<<()

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

Definition at line 116 of file reporter.h.

116 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.

References REPORTER::Report().

◆ Report() [1/2]

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

Definition at line 36 of file reporter.cpp.

37 {
38  Report( FROM_UTF8( aText ) );
39  return *this;
40 }
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.

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

◆ Report() [2/2]

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

Report a string with a given severity.

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 75 of file reporter.cpp.

76 {
77  wxCHECK_MSG( m_panel != nullptr, *this,
78  wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
79 
80  m_panel->Report( aText, aSeverity );
81  return *this;
82 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:213
void Report(const wxString &aText, 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_SEVERITY_UNDEFINED 
)
overridevirtual

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

Reimplemented from REPORTER.

Definition at line 95 of file reporter.cpp.

96 {
97  wxCHECK_MSG( m_panel != nullptr, *this,
98  wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
99 
100  m_panel->Report( aText, aSeverity, LOC_HEAD );
101  return *this;
102 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:213
void Report(const wxString &aText, 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_SEVERITY_UNDEFINED 
)
overridevirtual

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

Reimplemented from REPORTER.

Definition at line 85 of file reporter.cpp.

86 {
87  wxCHECK_MSG( m_panel != nullptr, *this,
88  wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
89 
90  m_panel->Report( aText, aSeverity, LOC_TAIL );
91  return *this;
92 }
WX_HTML_REPORT_PANEL * m_panel
Definition: reporter.h:213
void Report(const wxString &aText, 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 213 of file reporter.h.

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


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