A widget for browsing a rich text error/status report. More...

#include <wx_html_report_panel.h>

Inheritance diagram for WX_HTML_REPORT_PANEL:

Classes
struct	REPORT_LINE

Public Member Functions
	WX_HTML_REPORT_PANEL (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL)

	~WX_HTML_REPORT_PANEL ()

void	MsgPanelSetMinSize (const wxSize &aMinSize)
	Set the min size of the area which displays html messages.

REPORTER &	Reporter ()
	Return the reporter object that reports to this panel.

void	Report (const wxString &aText, SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
	Report the string.

void	Clear ()
	Clears the report panel.

int	Count (int severityMask)
	Return the number of messages matching the given severity mask.

void	SetLabel (const wxString &aLabel) override
	Set the frame label.

void	SetLazyUpdate (bool aLazyUpdate)
	Set the lazy update.

void	Flush (bool aSort=false)
	Force updating the HTML page, after the report is built in lazy mode If aSort = true, the body messages will be ordered by severity.

void	SetVisibleSeverities (int aSeverities)
	Set the visible severity filter.

int	GetVisibleSeverities () const

void	SetShowSeverity (SEVERITY aSeverity, bool aValue)

void	SetFileName (const wxString &aReportFileName)
	Set the report full file name to the string.

wxString &	GetFileName (void)

Protected Attributes
wxStaticBoxSizer *	m_box

wxFlexGridSizer *	m_fgSizer

HTML_WINDOW *	m_htmlView

wxStaticText *	m_staticTextShow

wxCheckBox *	m_checkBoxShowAll

wxCheckBox *	m_checkBoxShowErrors

NUMBER_BADGE *	m_errorsBadge

wxCheckBox *	m_checkBoxShowWarnings

NUMBER_BADGE *	m_warningsBadge

wxCheckBox *	m_checkBoxShowActions

wxCheckBox *	m_checkBoxShowInfos

wxButton *	m_btnSaveReportToFile

Private Types
typedef std::vector< REPORT_LINE >	REPORT_LINES

Private Member Functions
wxString	addHeader (const wxString &aBody)

wxString	generateHtml (const REPORT_LINE &aLine)

wxString	generatePlainText (const REPORT_LINE &aLine)

void	updateBadges ()

void	scrollToBottom ()

void	syncCheckboxes ()

void	onRightClick (wxMouseEvent &event) override

void	onMenuEvent (wxMenuEvent &event)

void	onCheckBoxShowAll (wxCommandEvent &event) override

void	onCheckBoxShowWarnings (wxCommandEvent &event) override

void	onCheckBoxShowErrors (wxCommandEvent &event) override

void	onCheckBoxShowInfos (wxCommandEvent &event) override

void	onCheckBoxShowActions (wxCommandEvent &event) override

void	onBtnSaveToFile (wxCommandEvent &event) override

void	onThemeChanged (wxSysColourChangedEvent &aEvent)

Private Attributes
WX_HTML_PANEL_REPORTER	m_reporter

REPORT_LINES	m_report
	copy of the report, stored for filtering

REPORT_LINES	m_reportTail
	Lines to print at the end, regardless of sorting.

REPORT_LINES	m_reportHead
	... and at the beginning, regardless of sorting

int	m_severities
	message severities to display (mask)

bool	m_lazyUpdate

wxString	m_reportFileName
	defaults to the not very useful /bin/report.txt

Detailed Description

A widget for browsing a rich text error/status report.

Used in numerous dialogs in Eeschema and Pcbnew. Provides error filtering functionality and saving report files. The messages are reported through a REPORTER object

Definition at line 63 of file wx_html_report_panel.h.

Member Typedef Documentation

◆ REPORT_LINES

typedef std::vector<REPORT_LINE> WX_HTML_REPORT_PANEL::REPORT_LINES

private

Definition at line 131 of file wx_html_report_panel.h.

Constructor & Destructor Documentation

◆ WX_HTML_REPORT_PANEL()

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

Definition at line 40 of file wx_html_report_panel.cpp.

References Flush(), KIUI::GetInfoFont(), WX_HTML_REPORT_PANEL_BASE::m_htmlView, onMenuEvent(), onThemeChanged(), and syncCheckboxes().

◆ ~WX_HTML_REPORT_PANEL()

WX_HTML_REPORT_PANEL::~WX_HTML_REPORT_PANEL ( )

Definition at line 60 of file wx_html_report_panel.cpp.

Member Function Documentation

◆ addHeader()

wxString WX_HTML_REPORT_PANEL::addHeader ( const wxString & aBody )

private

◆ Clear()

void WX_HTML_REPORT_PANEL::Clear ( )

Clears the report panel.

Definition at line 412 of file wx_html_report_panel.cpp.

References m_report, m_reportHead, and m_reportTail.

Referenced by DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ANNOTATE::OnAnnotateClick(), DIALOG_ANNOTATE::OnClearAnnotationClick(), DIALOG_IMPORT_NETLIST::onFilenameChanged(), DIALOG_CHANGE_SYMBOLS::onOkButtonClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), DIALOG_UPDATE_PCB::PerformUpdate(), and DIALOG_UPDATE_FROM_PCB::updateData().

◆ Count()

int WX_HTML_REPORT_PANEL::Count ( int severityMask )

Return the number of messages matching the given severity mask.

Definition at line 163 of file wx_html_report_panel.cpp.

References m_report, m_reportHead, and m_reportTail.

Referenced by WX_HTML_PANEL_REPORTER::HasMessageOfSeverity(), and updateBadges().

◆ Flush()

void WX_HTML_REPORT_PANEL::Flush ( bool aSort = false )

Force updating the HTML page, after the report is built in lazy mode If aSort = true, the body messages will be ordered by severity.

Definition at line 114 of file wx_html_report_panel.cpp.

References generateHtml(), WX_HTML_REPORT_PANEL_BASE::m_htmlView, m_report, m_reportHead, m_reportTail, scrollToBottom(), and HTML_WINDOW::SetPage().

Referenced by DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ANNOTATE::OnAnnotateClick(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), onCheckBoxShowActions(), onCheckBoxShowAll(), onCheckBoxShowErrors(), onCheckBoxShowInfos(), onCheckBoxShowWarnings(), DIALOG_ANNOTATE::OnClearAnnotationClick(), DIALOG_CHANGE_SYMBOLS::onOkButtonClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), onThemeChanged(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_UPDATE_FROM_PCB::updateData(), and WX_HTML_REPORT_PANEL().

◆ generateHtml()

wxString WX_HTML_REPORT_PANEL::generateHtml ( const REPORT_LINE & aLine )

private

Definition at line 180 of file wx_html_report_panel.cpp.

References _, KIPLATFORM::UI::IsDarkTheme(), m_severities, WX_HTML_REPORT_PANEL::REPORT_LINE::message, RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, and WX_HTML_REPORT_PANEL::REPORT_LINE::severity.

Referenced by Flush(), and Report().

◆ generatePlainText()

wxString WX_HTML_REPORT_PANEL::generatePlainText ( const REPORT_LINE & aLine )

private

Definition at line 240 of file wx_html_report_panel.cpp.

References _, WX_HTML_REPORT_PANEL::REPORT_LINE::message, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, and WX_HTML_REPORT_PANEL::REPORT_LINE::severity.

Referenced by onBtnSaveToFile().

◆ GetFileName()

wxString & WX_HTML_REPORT_PANEL::GetFileName ( void )

Returns: reference to the current report fill file name string.

Definition at line 449 of file wx_html_report_panel.cpp.

References m_reportFileName.

Referenced by DIALOG_BOARD_REANNOTATE::~DIALOG_BOARD_REANNOTATE().

◆ GetVisibleSeverities()

int WX_HTML_REPORT_PANEL::GetVisibleSeverities ( ) const

Returns: the visible severity filter. If the m_showAll option is set, the mask is < 0

Definition at line 437 of file wx_html_report_panel.cpp.

References m_severities.

Referenced by DIALOG_ANNOTATE::~DIALOG_ANNOTATE(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ MsgPanelSetMinSize()

void WX_HTML_REPORT_PANEL::MsgPanelSetMinSize ( const wxSize & aMinSize )

Set the min size of the area which displays html messages.

Definition at line 73 of file wx_html_report_panel.cpp.

References WX_HTML_REPORT_PANEL_BASE::m_fgSizer.

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), and DIALOG_ANNOTATE::InitValues().

◆ onBtnSaveToFile()

void WX_HTML_REPORT_PANEL::onBtnSaveToFile ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 354 of file wx_html_report_panel.cpp.

References _, ConvertSmartQuotesAndDashes(), generatePlainText(), m_report, m_reportFileName, m_reportHead, m_reportTail, and FILEEXT::TextFileWildcard().

◆ onCheckBoxShowActions()

void WX_HTML_REPORT_PANEL::onCheckBoxShowActions ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 342 of file wx_html_report_panel.cpp.

References Flush(), m_severities, RPT_SEVERITY_ACTION, and syncCheckboxes().

◆ onCheckBoxShowAll()

void WX_HTML_REPORT_PANEL::onCheckBoxShowAll ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 284 of file wx_html_report_panel.cpp.

References Flush(), m_severities, RPT_SEVERITY_ALL, RPT_SEVERITY_ERROR, and syncCheckboxes().

◆ onCheckBoxShowErrors()

void WX_HTML_REPORT_PANEL::onCheckBoxShowErrors ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 318 of file wx_html_report_panel.cpp.

References Flush(), m_severities, RPT_SEVERITY_ERROR, and syncCheckboxes().

◆ onCheckBoxShowInfos()

void WX_HTML_REPORT_PANEL::onCheckBoxShowInfos ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 330 of file wx_html_report_panel.cpp.

References Flush(), m_severities, RPT_SEVERITY_INFO, and syncCheckboxes().

◆ onCheckBoxShowWarnings()

void WX_HTML_REPORT_PANEL::onCheckBoxShowWarnings ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 306 of file wx_html_report_panel.cpp.

References Flush(), m_severities, RPT_SEVERITY_WARNING, and syncCheckboxes().

◆ onMenuEvent()

void WX_HTML_REPORT_PANEL::onMenuEvent ( wxMenuEvent & event )

private

Definition at line 260 of file wx_html_report_panel.cpp.

References WX_HTML_REPORT_PANEL_BASE::m_htmlView.

Referenced by WX_HTML_REPORT_PANEL().

◆ onRightClick()

void WX_HTML_REPORT_PANEL::onRightClick ( wxMouseEvent & event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 252 of file wx_html_report_panel.cpp.

◆ onThemeChanged()

void WX_HTML_REPORT_PANEL::onThemeChanged ( wxSysColourChangedEvent & aEvent )

private

Definition at line 65 of file wx_html_report_panel.cpp.

References Flush().

Referenced by WX_HTML_REPORT_PANEL().

◆ Report()

void WX_HTML_REPORT_PANEL::Report	(	const wxString &	aText,
		SEVERITY	aSeverity,
		REPORTER::LOCATION	aLocation = `REPORTER::LOC_BODY`
	)

Report the string.

Parameters

aText	string message to report.
aSeverity	string classification level bitfield.
aLocation	REPORTER::LOCATION enum for placement of message.

Definition at line 86 of file wx_html_report_panel.cpp.

References HTML_WINDOW::AppendToPage(), generateHtml(), REPORTER::LOC_HEAD, REPORTER::LOC_TAIL, WX_HTML_REPORT_PANEL_BASE::m_htmlView, m_lazyUpdate, m_report, m_reportHead, m_reportTail, WX_HTML_REPORT_PANEL::REPORT_LINE::message, scrollToBottom(), and WX_HTML_REPORT_PANEL::REPORT_LINE::severity.

Referenced by DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), DIALOG_CHANGE_SYMBOLS::processSymbols(), WX_HTML_PANEL_REPORTER::Report(), WX_HTML_PANEL_REPORTER::ReportHead(), WX_HTML_PANEL_REPORTER::ReportTail(), and DIALOG_BOARD_REANNOTATE::ShowReport().

◆ Reporter()

REPORTER & WX_HTML_REPORT_PANEL::Reporter ( )

Return the reporter object that reports to this panel.

Definition at line 80 of file wx_html_report_panel.cpp.

References m_reporter.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ANNOTATE::OnAnnotateClick(), DIALOG_ANNOTATE::OnClearAnnotationClick(), DIALOG_IMPORT_NETLIST::onFilenameChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), and DIALOG_UPDATE_FROM_PCB::updateData().

◆ scrollToBottom()

void WX_HTML_REPORT_PANEL::scrollToBottom ( )

private

Definition at line 141 of file wx_html_report_panel.cpp.

References WX_HTML_REPORT_PANEL_BASE::m_htmlView, and updateBadges().

Referenced by Flush(), and Report().

◆ SetFileName()

void WX_HTML_REPORT_PANEL::SetFileName ( const wxString & aReportFileName )

Set the report full file name to the string.

Definition at line 443 of file wx_html_report_panel.cpp.

References m_reportFileName.

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), and DIALOG_BOARD_REANNOTATE::InitValues().

◆ SetLabel()

void WX_HTML_REPORT_PANEL::SetLabel ( const wxString & aLabel )

override

Set the frame label.

Definition at line 420 of file wx_html_report_panel.cpp.

References WX_HTML_REPORT_PANEL_BASE::m_box.

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_PCB::OnUpdateClick(), and DIALOG_IMPORT_NETLIST::onUpdatePCB().

◆ SetLazyUpdate()

void WX_HTML_REPORT_PANEL::SetLazyUpdate ( bool aLazyUpdate )

Set the lazy update.

If this mode is on, messages are stored but the display is not updated (Updating display can be very time consuming if there are many messages) A call to Flush() will be needed after build the report

Definition at line 108 of file wx_html_report_panel.cpp.

References m_lazyUpdate.

Referenced by DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_BOARD_REANNOTATE::GetParameters(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ANNOTATE::OnAnnotateClick(), and DIALOG_BOARD_REANNOTATE::OnApplyClick().