A slimmed down version of WX_HTML_REPORT_PANEL. More...

#include <wx_html_report_box.h>

Inheritance diagram for WX_HTML_REPORT_BOX:

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_REPORT_BOX (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL)

	~WX_HTML_REPORT_BOX ()

REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
	Report a string with a given severity.

bool	HasMessage () const override
	Returns true if the reporter client is non-empty.

void	SetUnits (EDA_UNITS aUnits)

EDA_UNITS	GetUnits () const override

void	SetImmediateMode ()
	In immediate mode, messages are flushed as they are added.

void	Flush ()
	Build the HTML messages page.

void	Clear () override
	Delete the stored messages.

bool	SetPage (const wxString &aSource) override

bool	AppendToPage (const wxString &aSource)

void	ThemeChanged ()

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

virtual REPORTER &	ReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Places the report at the end of the list, for objects that support report ordering.

virtual REPORTER &	ReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Places the report at the beginning of the list for objects that support ordering.

REPORTER &	operator<< (const wxString &aText)

virtual bool	HasMessageOfSeverity (int aSeverityMask) const
	Returns true if the reporter has one or more messages matching the specified severity mask.

Private Member Functions
void	onThemeChanged (wxSysColourChangedEvent &aEvent)

void	onRightClick (wxMouseEvent &event)

void	onMenuEvent (wxMenuEvent &event)

wxString	generateHtml (const wxString &aLine)

Private Attributes
EDA_UNITS	m_units

bool	m_immediateMode
	Indicates messages should be flushed as they are added.

std::vector< wxString >	m_messages
	copy of the report, stored for filtering.

wxString	m_pageSource

int	m_severityMask

Detailed Description

A slimmed down version of WX_HTML_REPORT_PANEL.

Definition at line 31 of file wx_html_report_box.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_REPORT_BOX()

WX_HTML_REPORT_BOX::WX_HTML_REPORT_BOX	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxSize( 500,300 )`,
		long	style = `wxTAB_TRAVERSAL`
	)

Definition at line 31 of file wx_html_report_box.cpp.

References Flush(), onRightClick(), and onThemeChanged().

◆ ~WX_HTML_REPORT_BOX()

WX_HTML_REPORT_BOX::~WX_HTML_REPORT_BOX ( )

Definition at line 47 of file wx_html_report_box.cpp.

References onRightClick().

Member Function Documentation

◆ AppendToPage()

bool HTML_WINDOW::AppendToPage ( const wxString & aSource )

inherited

Definition at line 69 of file html_window.cpp.

References HTML_WINDOW::m_pageSource, and HTML_WINDOW::SetPage().

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), WX_HTML_REPORT_PANEL::Report(), and PANEL_RF_ATTENUATORS::TransfAttenuatorResultsToPanel().

◆ Clear()

void WX_HTML_REPORT_BOX::Clear ( )

overridevirtual

Delete the stored messages.

Reimplemented from REPORTER.

Definition at line 137 of file wx_html_report_box.cpp.

References REPORTER::Clear(), and m_messages.

Referenced by PANEL_SETUP_RULES::OnCompile(), DIALOG_ASSIGN_NETCLASS::onPatternText(), DIALOG_DRC::OnRunDRCClick(), DIALOG_ERC::OnRunERCClick(), and PANEL_SETUP_NETCLASSES::OnUpdateUI().

◆ Flush()

void WX_HTML_REPORT_BOX::Flush ( )

Build the HTML messages page.

Call it if the immediate mode is not activated to be able to display them.

Definition at line 107 of file wx_html_report_box.cpp.

References generateHtml(), m_messages, and HTML_WINDOW::SetPage().

Referenced by BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), SCH_EDIT_FRAME::importFile(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_RULES::OnCompile(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), DIALOG_ASSIGN_NETCLASS::onPatternText(), DIALOG_DRC::OnRunDRCClick(), onThemeChanged(), PANEL_SETUP_NETCLASSES::OnUpdateUI(), PCB_EDIT_FRAME::OpenProjectFiles(), Report(), NETLIST_VIEW_DIALOG::SetNetlist(), and WX_HTML_REPORT_BOX().

◆ generateHtml()

wxString WX_HTML_REPORT_BOX::generateHtml ( const wxString & aLine )

private

Definition at line 118 of file wx_html_report_box.cpp.

References KiROUND().

Referenced by Flush().

◆ GetUnits()

EDA_UNITS WX_HTML_REPORT_BOX::GetUnits ( ) const

inlineoverridevirtual

Reimplemented from REPORTER.

Definition at line 45 of file wx_html_report_box.h.

References m_units.

◆ HasMessage()

bool WX_HTML_REPORT_BOX::HasMessage ( ) const

inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 42 of file wx_html_report_box.h.

References m_messages.

Referenced by SCH_EDIT_FRAME::importFile(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ HasMessageOfSeverity()

virtual bool REPORTER::HasMessageOfSeverity ( int aSeverityMask ) const

inlinevirtualinherited

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 140 of file reporter.h.

Referenced by BOOST_AUTO_TEST_CASE(), COMPONENT_CLASS_MANAGER::CompileAssignmentRule(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), EXPORTER_STEP::Export(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), DIALOG_SIM_MODEL< T >::loadLibrary(), SIMULATOR_CONTROL::NewAnalysisTab(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SIM_LIB_MGR::SetLibrary(), and SIMULATOR_FRAME::showNetlistErrors().

◆ onMenuEvent()

void WX_HTML_REPORT_BOX::onMenuEvent ( wxMenuEvent & event )

private

Definition at line 71 of file wx_html_report_box.cpp.

◆ onRightClick()

void WX_HTML_REPORT_BOX::onRightClick ( wxMouseEvent & event )

private

Definition at line 63 of file wx_html_report_box.cpp.

Referenced by WX_HTML_REPORT_BOX(), and ~WX_HTML_REPORT_BOX().

◆ onThemeChanged()

void WX_HTML_REPORT_BOX::onThemeChanged ( wxSysColourChangedEvent & aEvent )

private

Definition at line 55 of file wx_html_report_box.cpp.

References Flush().

Referenced by WX_HTML_REPORT_BOX().

◆ operator<<()

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

inlineinherited

Definition at line 129 of file reporter.h.

◆ 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(), and REPORTER::Report().

◆ Report() [2/2]

REPORTER & WX_HTML_REPORT_BOX::Report	(	const wxString &	aText,
		SEVERITY	aSeverity = `RPT_SEVERITY_UNDEFINED`
	)

overridevirtual

Report a string with a given severity.

Parameters

aText	is the string to report.
aSeverity	is an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Reimplemented from REPORTER.

Definition at line 90 of file wx_html_report_box.cpp.

References Flush(), m_immediateMode, and m_messages.

Referenced by DIALOG_DRC::AdvancePhase(), PANEL_SETUP_RULES::checkPlausibility(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), DIALOG_PCM_PROGRESS::OnCancelClicked(), PANEL_SETUP_RULES::OnCompile(), DIALOG_ASSIGN_NETCLASS::onPatternText(), DIALOG_DRC::OnRunDRCClick(), DIALOG_ERC::OnRunERCClick(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PANEL_SETUP_NETCLASSES::OnUpdateUI(), DIALOG_ERC::Report(), and DIALOG_PCM_PROGRESS::updateUI().

◆ ReportHead()

virtual REPORTER & REPORTER::ReportHead	(	const wxString &	aText,
		SEVERITY	aSeverity = `RPT_SEVERITY_UNDEFINED`
	)

inlinevirtualinherited

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 121 of file reporter.h.

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), WX_HTML_PANEL_REPORTER::ReportHead(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ ReportTail()

virtual REPORTER & REPORTER::ReportTail	(	const wxString &	aText,
		SEVERITY	aSeverity = `RPT_SEVERITY_UNDEFINED`
	)

inlinevirtualinherited

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 112 of file reporter.h.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::BackAnnotateSymbols(), BOOST_AUTO_TEST_CASE(), BACK_ANNOTATE::checkForUnusedSymbols(), GERBER_WRITER::CreateDrillandMapFilesSet(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), BACK_ANNOTATE::getChangeList(), PCB_PLOTTER::Plot(), GERBER_JOBFILE_READER::ReadGerberJobFile(), WX_HTML_PANEL_REPORTER::ReportTail(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ SetImmediateMode()

void WX_HTML_REPORT_BOX::SetImmediateMode ( )

inline

In immediate mode, messages are flushed as they are added.

Required for progress-related reports, but can be very slow for larger reports.

Definition at line 52 of file wx_html_report_box.h.

References m_immediateMode.

Referenced by DIALOG_DRC::DIALOG_DRC(), DIALOG_ERC::DIALOG_ERC(), and DIALOG_PCM_PROGRESS::DIALOG_PCM_PROGRESS().

◆ SetPage()

bool HTML_WINDOW::SetPage ( const wxString & aSource )

overrideinherited

◆ SetUnits()

void WX_HTML_REPORT_BOX::SetUnits ( EDA_UNITS aUnits )

inline

Definition at line 44 of file wx_html_report_box.h.

References m_units.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage().

◆ ThemeChanged()

void HTML_WINDOW::ThemeChanged ( )

inherited

Definition at line 75 of file html_window.cpp.

References HTML_WINDOW::m_pageSource, and HTML_WINDOW::SetPage().

Referenced by HTML_WINDOW::onThemeChanged(), PANEL_GALVANIC_CORROSION::ThemeChanged(), PANEL_R_CALCULATOR::ThemeChanged(), PANEL_RF_ATTENUATORS::ThemeChanged(), and PANEL_TRACK_WIDTH::ThemeChanged().

Member Data Documentation

◆ m_immediateMode

bool WX_HTML_REPORT_BOX::m_immediateMode

private

Indicates messages should be flushed as they are added.

Required for progress-related reports, but can be very slow for larger reports.

Definition at line 78 of file wx_html_report_box.h.

Referenced by Report(), and SetImmediateMode().

◆ m_messages

std::vector<wxString> WX_HTML_REPORT_BOX::m_messages

private

copy of the report, stored for filtering.

Definition at line 81 of file wx_html_report_box.h.

Referenced by Clear(), Flush(), HasMessage(), and Report().

◆ m_pageSource

wxString HTML_WINDOW::m_pageSource

privateinherited

Definition at line 56 of file html_window.h.

Referenced by HTML_WINDOW::AppendToPage(), HTML_WINDOW::SetPage(), and HTML_WINDOW::ThemeChanged().

◆ m_severityMask

int REPORTER::m_severityMask

privateinherited

Definition at line 156 of file reporter.h.

◆ m_units

EDA_UNITS WX_HTML_REPORT_BOX::m_units

private

Definition at line 74 of file wx_html_report_box.h.

Referenced by GetUnits(), and SetUnits().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ LOCATION

Constructor & Destructor Documentation

◆ WX_HTML_REPORT_BOX()

◆ ~WX_HTML_REPORT_BOX()

Member Function Documentation

◆ AppendToPage()

◆ Clear()

◆ Flush()

◆ generateHtml()

◆ GetUnits()

◆ HasMessage()

◆ HasMessageOfSeverity()

◆ onMenuEvent()

◆ onRightClick()

◆ onThemeChanged()

◆ operator<<()

◆ Report() [1/2]

◆ Report() [2/2]

◆ ReportHead()

◆ ReportTail()

◆ SetImmediateMode()

◆ SetPage()

◆ SetUnits()

◆ ThemeChanged()

Member Data Documentation

◆ m_immediateMode

◆ m_messages

◆ m_pageSource

◆ m_severityMask

◆ m_units