KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
WX_HTML_PANEL_REPORTER Class Reference

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

#include <wx_html_report_panel.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 ()
 
REPORTER & Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Report a string with a given severity.
 
REPORTER & ReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Places the report at the end of the list, for objects that support report ordering.
 
REPORTER & ReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Places the report at the beginning of the list for objects that support ordering.
 
bool HasMessage () const override
 Returns true if any messages were reported.
 
bool HasMessageOfSeverity (int aSeverityMask) const override
 Returns true if the reporter has one or more messages matching the specified severity mask.
 
REPORTER & Report (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 
REPORTER & operator<< (const wxString &aText)
 
virtual EDA_UNITS GetUnits () const
 
virtual void Clear ()
 

Private Attributes

WX_HTML_REPORT_PANEL * m_panel
 
int m_reportedSeverityMask
 

Detailed Description

A wrapper for reporting to a wx HTML window.

Definition at line 34 of file wx_html_report_panel.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 88 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 37 of file wx_html_report_panel.h.

References m_panel, and REPORTER::REPORTER().

◆ ~WX_HTML_PANEL_REPORTER()

virtual WX_HTML_PANEL_REPORTER::~WX_HTML_PANEL_REPORTER ( )
inlinevirtual

Definition at line 42 of file wx_html_report_panel.h.

Member Function Documentation

◆ Clear()

virtual void REPORTER::Clear ( )
inlinevirtualinherited

Reimplemented in TEST_REPORTER, WX_HTML_REPORT_BOX, and WX_STRING_REPORTER.

Definition at line 153 of file reporter.h.

References m_reportedSeverityMask.

Referenced by TEST_REPORTER::Clear(), WX_HTML_REPORT_BOX::Clear(), and WX_STRING_REPORTER::Clear().

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 148 of file reporter.h.

References MM.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ HasMessage()

bool WX_HTML_PANEL_REPORTER::HasMessage ( ) const
overridevirtual

Returns true if any messages were reported.

Reimplemented from REPORTER.

Definition at line 418 of file wx_html_report_panel.cpp.

References HasMessageOfSeverity(), RPT_SEVERITY_ERROR, and RPT_SEVERITY_WARNING.

◆ HasMessageOfSeverity()

bool WX_HTML_PANEL_REPORTER::HasMessageOfSeverity ( int aSeverityMask) const
overridevirtual

Returns true if the reporter has one or more messages matching the specified severity mask.

Reimplemented from REPORTER.

Definition at line 425 of file wx_html_report_panel.cpp.

References m_panel.

Referenced by HasMessage().

◆ operator<<()

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

Definition at line 129 of file reporter.h.

References Report(), and REPORTER().

◆ Report() [1/2]

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

Definition at line 49 of file reporter.cpp.

References From_UTF8(), Report(), and REPORTER().

◆ 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

Reimplemented from REPORTER.

Definition at line 382 of file wx_html_report_panel.cpp.

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

◆ 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 406 of file wx_html_report_panel.cpp.

References REPORTER::LOC_HEAD, m_panel, REPORTER::REPORTER(), and REPORTER::ReportHead().

◆ 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 394 of file wx_html_report_panel.cpp.

References REPORTER::LOC_TAIL, m_panel, REPORTER::REPORTER(), and REPORTER::ReportTail().

Member Data Documentation

◆ m_panel

WX_HTML_REPORT_PANEL* WX_HTML_PANEL_REPORTER::m_panel
private

Definition at line 52 of file wx_html_report_panel.h.

Referenced by HasMessageOfSeverity(), Report(), ReportHead(), ReportTail(), and WX_HTML_PANEL_REPORTER().

◆ m_reportedSeverityMask

int REPORTER::m_reportedSeverityMask
privateinherited

Definition at line 159 of file reporter.h.

Referenced by Clear(), HasMessage(), HasMessageOfSeverity(), Report(), and REPORTER().

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