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 ()
	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
	Indicates messages should be flushed as they are added.

bool	m_immediateMode
	copy of the report, stored for filtering

std::vector< wxString >	m_messages

wxString	m_pageSource

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 80 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 ( )

Delete the stored messages.

Definition at line 136 of file wx_html_report_box.cpp.

References 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 106 of file wx_html_report_box.cpp.

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

Referenced by BOARD_INSPECTION_TOOL::DiffFootprint(), EE_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 117 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()

bool REPORTER::HasMessageOfSeverity ( int aSeverityMask ) const

virtualinherited

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

Reimplemented in WX_HTML_PANEL_REPORTER, and WX_STRING_REPORTER.

Definition at line 53 of file reporter.cpp.

References REPORTER::HasMessage().

Referenced by DIALOG_SIM_MODEL< T >::loadLibrary(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), and SIM_LIB_MGR::SetLibrary().

◆ 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 117 of file reporter.h.

◆ Report() [1/2]

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

inherited

Definition at line 46 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

Implements REPORTER.

Definition at line 90 of file wx_html_report_box.cpp.

References Flush(), m_immediateMode, and m_messages.

Referenced by DIALOG_DRC::AdvancePhase(), BOARD_INSPECTION_TOOL::DiffFootprint(), EE_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().