WX_HTML_REPORT_PANEL Class Reference

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 ()
	Set the min size of the area which displays html messages: More...
void	MsgPanelSetMinSize (const wxSize &aMinSize)
	returns the reporter object that reports to this panel More...
REPORTER &	Reporter ()
void	Report (const wxString &aText, SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
	Reports the string. More...
void	Clear ()
	return the number of messages matching the given severity mask. More...
int	Count (int severityMask)
	sets the frame label More...
void	SetLabel (const wxString &aLabel) override
	Sets the lazy update. More...
void	SetLazyUpdate (bool aLazyUpdate)
	Forces updating the HTML page, after the report is built in lazy mode If aSort = true, the body messages will be ordered by severity. More...
void	Flush (bool aSort=false)
	Set the visible severity filter. More...
void	SetVisibleSeverities (int aSeverities)
int	GetVisibleSeverities () const
void	SetShowSeverity (SEVERITY aSeverity, bool aValue)
	Set the report full file name to the string. More...
void	SetFileName (const wxString &aReportFileName)
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 More...
REPORT_LINES	m_reportTail
	Lines to print at the end, regardless of sorting. More...
REPORT_LINES	m_reportHead
	... and at the beginning, regardless of sorting More...
int	m_severities
	message severities to display (mask) More...
bool	m_lazyUpdate
wxString	m_reportFileName
	defaults to the not very useful /bin/report.txt More...

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 37 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 104 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.

 :
 WX_HTML_REPORT_PANEL_BASE( parent, id, pos, size, style ),
 m_reporter( this ),
 m_severities( -1 ),
 m_lazyUpdate( false )
{
 syncCheckboxes();
 m_htmlView->SetFont( KIUI::GetInfoFont( m_htmlView ) );
 Flush();
 
 Connect( wxEVT_COMMAND_MENU_SELECTED,
 wxMenuEventHandler( WX_HTML_REPORT_PANEL::onMenuEvent ), nullptr, this );
 
 m_htmlView->Bind( wxEVT_SYS_COLOUR_CHANGED,
 wxSysColourChangedEventHandler( WX_HTML_REPORT_PANEL::onThemeChanged ),
 this );
}

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

(

)

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

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

(

)

return the number of messages matching the given severity mask.

Definition at line 407 of file wx_html_report_panel.cpp.

{
 m_report.clear();
 m_reportHead.clear();
 m_reportTail.clear();
}

References m_report, m_reportHead, and m_reportTail.

Referenced by DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ANNOTATE::OnApplyClick(), 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

)

sets the frame label

Definition at line 163 of file wx_html_report_panel.cpp.

{
 int count = 0;
 
 for( const auto& reportLineArray : { m_report, m_reportHead, m_reportTail } )
 {
 for( const REPORT_LINE& reportLine : reportLineArray )
 {
 if( severityMask & reportLine.severity )
 count++;
 }
 }
 
 return count;
}

References m_report, m_reportHead, and m_reportTail.

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

Flush()

void WX_HTML_REPORT_PANEL::Flush

(

bool

aSort = false

)

Set the visible severity filter.

if aSeverities < 0 the m_showAll option is set

Definition at line 114 of file wx_html_report_panel.cpp.

{
 wxString html;
 
 if( aSort )
 {
 std::sort( m_report.begin(), m_report.end(),
 []( const REPORT_LINE& a, const REPORT_LINE& b)
 {
 return a.severity < b.severity;
 });
 }
 
 for( const auto& line : m_reportHead )
 html += generateHtml( line );
 
 for( const auto& line : m_report )
 html += generateHtml( line );
 
 for( const auto& line : m_reportTail )
 html += generateHtml( line );
 
 m_htmlView->SetPage( html );
 scrollToBottom();
}

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::OnApplyClick(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), onCheckBoxShowActions(), onCheckBoxShowAll(), onCheckBoxShowErrors(), onCheckBoxShowInfos(), onCheckBoxShowWarnings(), 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.

{
 wxString retv;
 
 if( !( m_severities & aLine.severity ) )
 return retv;
 
 if( KIPLATFORM::UI::IsDarkTheme() )
 {
 switch( aLine.severity )
 {
 case RPT_SEVERITY_ERROR:
 retv = wxS( "<font color=#F04040 size=3>" ) + _( "Error:" ) + wxS( " </font>" )
 wxS( "<font size=3>" ) + aLine.message + wxS( "</font><br>" );
 break;
 case RPT_SEVERITY_WARNING:
 retv = wxS( "<font size=3>" ) + _( "Warning:" ) + wxS( " " ) + aLine.message + wxS( "</font><br>" );
 break;
 case RPT_SEVERITY_INFO:
 retv = wxS( "<font color=#909090 size=3>" ) + aLine.message + wxS( "</font><br>" );
 break;
 case RPT_SEVERITY_ACTION:
 retv = wxS( "<font color=#60D060 size=3>" ) + aLine.message + wxS( "</font><br>" );
 break;
 default:
 retv = wxS( "<font size=3>" ) + aLine.message + wxS( "</font><br>" );
 }
 }
 else
 {
 switch( aLine.severity )
 {
 case RPT_SEVERITY_ERROR:
 retv = wxS( "<font color=#D00000 size=3>" ) + _( "Error:" ) + wxS( " </font>" )
 wxS( "<font size=3>" ) + aLine.message + wxS( "</font><br>" );
 break;
 case RPT_SEVERITY_WARNING:
 retv = wxS( "<font size=3>" ) + _( "Warning:" ) + wxS( " " ) + aLine.message + wxS( "</font><br>" );
 break;
 case RPT_SEVERITY_INFO:
 retv = wxS( "<font color=#808080 size=3>" ) + aLine.message + wxS( "</font><br>" );
 break;
 case RPT_SEVERITY_ACTION:
 retv = wxS( "<font color=#008000 size=3>" ) + aLine.message + wxS( "</font><br>" );
 break;
 default:
 retv = wxS( "<font size=3>" ) + aLine.message + wxS( "</font><br>" );
 }
 }
 
 // wxHtmlWindow fails to do correct baseline alignment between Japanese/Chinese cells and
 // Roman cells. This keeps the line in a single cell.
 retv.Replace( wxS( " " ), wxS( "&nbsp;" ) );
 
 return retv;
}

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

{
 switch( aLine.severity )
 {
 case RPT_SEVERITY_ERROR: return _( "Error:" ) + wxS( " " ) + aLine.message + wxT( "\n" );
 case RPT_SEVERITY_WARNING: return _( "Warning:" ) + wxS( " " ) + aLine.message + wxT( "\n" );
 case RPT_SEVERITY_INFO: return _( "Info:" ) + wxS( " " ) + aLine.message + wxT( "\n" );
 default: return aLine.message + wxT( "\n" );
 }
}

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

)

Definition at line 444 of file wx_html_report_panel.cpp.

{
 return ( m_reportFileName );
}

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

{
 return m_severities;
}

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

)

returns the reporter object that reports to this panel

Definition at line 73 of file wx_html_report_panel.cpp.

{
 m_fgSizer->SetMinSize( aMinSize );
 GetSizer()->SetSizeHints( this );
}

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

{
 wxFileName fn;
 
 if( m_reportFileName.empty() )
 {
 fn = wxT( "report.txt" );
 
 KIWAY_HOLDER* parent = dynamic_cast<KIWAY_HOLDER*>( m_parent );
 
 if( parent )
 fn.SetPath( parent->Prj().GetProjectPath() );
 }
 else
  fn = m_reportFileName;
 
 wxFileDialog dlg( this, _( "Save Report to File" ), fn.GetPath(), fn.GetFullName(),
 TextFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
 if( dlg.ShowModal() != wxID_OK )
 return;
 
 fn = dlg.GetPath();
 
 if( fn.GetExt().IsEmpty() )
 fn.SetExt( "txt" );
 
 wxFFile f( fn.GetFullPath(), "wb" );
 
 if( !f.IsOpened() )
 {
 wxString msg;
 
 msg.Printf( _( "Cannot write report to file '%s'." ),
 fn.GetFullPath().GetData() );
 wxMessageBox( msg, _( "File save error" ), wxOK | wxICON_ERROR, this );
 return;
 }
 
 for( REPORT_LINES section : { m_reportHead, m_report, m_reportTail } )
 {
 for( const REPORT_LINE& l : section )
 {
 wxString s = generatePlainText( l );
 
 ConvertSmartQuotesAndDashes( &s );
 f.Write( s );
 }
 }
 
 m_reportFileName = fn.GetFullPath();
 f.Close();
}

References _, ConvertSmartQuotesAndDashes(), generatePlainText(), PROJECT::GetProjectPath(), m_report, m_reportFileName, m_reportHead, m_reportTail, KIWAY_HOLDER::Prj(), and TextFileWildcard().

onCheckBoxShowActions()

void WX_HTML_REPORT_PANEL::onCheckBoxShowActions ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from WX_HTML_REPORT_PANEL_BASE.

Definition at line 340 of file wx_html_report_panel.cpp.

{
 if( event.IsChecked() )
 m_severities |= RPT_SEVERITY_ACTION;
 else
 m_severities &= ~RPT_SEVERITY_ACTION;
 
 syncCheckboxes();
 Flush( true );
}

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

{
 if( event.IsChecked() )
 m_severities = RPT_SEVERITY_ALL;
 else
 m_severities = RPT_SEVERITY_ERROR;
 
 syncCheckboxes();
 Flush( true );
}

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

{
 if( event.IsChecked() )
 m_severities |= RPT_SEVERITY_ERROR;
 else
 m_severities &= ~RPT_SEVERITY_ERROR;
 
 syncCheckboxes();
 Flush( true );
}

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

{
 if( event.IsChecked() )
 m_severities |= RPT_SEVERITY_INFO;
 else
 m_severities &= ~RPT_SEVERITY_INFO;
 
 syncCheckboxes();
 Flush( true );
}

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

{
 if( event.IsChecked() )
 m_severities |= RPT_SEVERITY_WARNING;
 else
 m_severities &= ~RPT_SEVERITY_WARNING;
 
 syncCheckboxes();
 Flush( true );
}

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

onMenuEvent()

void WX_HTML_REPORT_PANEL::onMenuEvent ( wxMenuEvent &  event )

private

Definition at line 258 of file wx_html_report_panel.cpp.

{
 if( event.GetId() == wxID_COPY )
 {
 wxLogNull doNotLog; // disable logging of failed clipboard actions
 
 if( wxTheClipboard->Open() )
 {
 bool primarySelection = wxTheClipboard->IsUsingPrimarySelection();
 wxTheClipboard->UsePrimarySelection( false ); // required to use the main clipboard
 wxTheClipboard->SetData( new wxTextDataObject( m_htmlView->SelectionToText() ) );
 wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
 wxTheClipboard->Close();
 wxTheClipboard->UsePrimarySelection( primarySelection );
 }
 }
}

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

{
 wxMenu popup;
 popup.Append( wxID_COPY, "Copy" );
 PopupMenu( &popup );
}

onThemeChanged()

void WX_HTML_REPORT_PANEL::onThemeChanged ( wxSysColourChangedEvent &  aEvent )

private

Definition at line 65 of file wx_html_report_panel.cpp.

{
 Flush();
 
 aEvent.Skip();
}

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
	)

Reports the string.

Parameters

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

Definition at line 86 of file wx_html_report_panel.cpp.

{
 REPORT_LINE line;
 line.message = aText;
 line.severity = aSeverity;
 
 if( aLocation == REPORTER::LOC_HEAD )
 m_reportHead.push_back( line );
 else if( aLocation == REPORTER::LOC_TAIL )
 m_reportTail.push_back( line );
 else
 m_report.push_back( line );
 
 if( !m_lazyUpdate )
 {
 m_htmlView->AppendToPage( generateHtml( line ) );
 scrollToBottom();
 }
}

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::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

(

)

Definition at line 80 of file wx_html_report_panel.cpp.

{
 return m_reporter;
}

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_EXPORT_SVG::ExportSVGFile(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ANNOTATE::OnApplyClick(), 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.

{
 int x, y, xUnit, yUnit;
 
 m_htmlView->GetVirtualSize( &x, &y );
 m_htmlView->GetScrollPixelsPerUnit( &xUnit, &yUnit );
 m_htmlView->Scroll( 0, y / yUnit );
 
 updateBadges();
}

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

)

Returns

reference to the current report fill file name string.

Definition at line 438 of file wx_html_report_panel.cpp.

{
 m_reportFileName = aReportFileName;
}

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_EXPORT_SVG::DIALOG_EXPORT_SVG(), 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

Sets 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 415 of file wx_html_report_panel.cpp.

{
 m_box->GetStaticBox()->SetLabel( aLabel );
}

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

)

Forces 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 108 of file wx_html_report_panel.cpp.

{
 m_lazyUpdate = aLazyUpdate;
}

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::OnApplyClick(), and DIALOG_BOARD_REANNOTATE::OnApplyClick().

SetShowSeverity()

void WX_HTML_REPORT_PANEL::SetShowSeverity	(	SEVERITY	aSeverity,
		bool	aValue
	)

Set the report full file name to the string.

Definition at line 450 of file wx_html_report_panel.cpp.

{
 switch( aSeverity )
 {
 case RPT_SEVERITY_INFO: m_checkBoxShowInfos->SetValue( aValue ); break;
 case RPT_SEVERITY_ACTION: m_checkBoxShowActions->SetValue( aValue ); break;
 case RPT_SEVERITY_WARNING: m_checkBoxShowWarnings->SetValue( aValue ); break;
 default: m_checkBoxShowErrors->SetValue( aValue ); break;
 }
}

References WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowActions, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowErrors, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowInfos, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowWarnings, RPT_SEVERITY_ACTION, RPT_SEVERITY_INFO, and RPT_SEVERITY_WARNING.

SetVisibleSeverities()

void WX_HTML_REPORT_PANEL::SetVisibleSeverities

(

int

aSeverities

)

Returns

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

Definition at line 421 of file wx_html_report_panel.cpp.

{
 if( aSeverities < 0 )
 m_severities = RPT_SEVERITY_ALL;
 else
 m_severities = aSeverities;
 
 syncCheckboxes();
}

References m_severities, RPT_SEVERITY_ALL, and syncCheckboxes().

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

syncCheckboxes()

void WX_HTML_REPORT_PANEL::syncCheckboxes ( )

private

Definition at line 294 of file wx_html_report_panel.cpp.

{
 m_checkBoxShowAll->SetValue( m_severities == RPT_SEVERITY_ALL );
 m_checkBoxShowWarnings->SetValue( m_severities & RPT_SEVERITY_WARNING );
 m_checkBoxShowErrors->SetValue( m_severities & RPT_SEVERITY_ERROR );
 m_checkBoxShowInfos->SetValue( m_severities & RPT_SEVERITY_INFO );
 m_checkBoxShowActions->SetValue( m_severities & RPT_SEVERITY_ACTION );
}

References WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowActions, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowAll, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowErrors, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowInfos, WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowWarnings, m_severities, RPT_SEVERITY_ACTION, RPT_SEVERITY_ALL, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, and RPT_SEVERITY_WARNING.

Referenced by onCheckBoxShowActions(), onCheckBoxShowAll(), onCheckBoxShowErrors(), onCheckBoxShowInfos(), onCheckBoxShowWarnings(), SetVisibleSeverities(), and WX_HTML_REPORT_PANEL().

updateBadges()

void WX_HTML_REPORT_PANEL::updateBadges ( )

private

Definition at line 153 of file wx_html_report_panel.cpp.

{
 int count = Count(RPT_SEVERITY_ERROR );
 m_errorsBadge->UpdateNumber( count, RPT_SEVERITY_ERROR );
 
 count = Count(RPT_SEVERITY_WARNING );
 m_warningsBadge->UpdateNumber( count, RPT_SEVERITY_WARNING );
}

References Count(), WX_HTML_REPORT_PANEL_BASE::m_errorsBadge, WX_HTML_REPORT_PANEL_BASE::m_warningsBadge, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, and NUMBER_BADGE::UpdateNumber().

Referenced by scrollToBottom().

Member Data Documentation

m_box

wxStaticBoxSizer* WX_HTML_REPORT_PANEL_BASE::m_box

protectedinherited

Definition at line 42 of file wx_html_report_panel_base.h.

Referenced by SetLabel(), and WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE().

m_btnSaveReportToFile

wxButton* WX_HTML_REPORT_PANEL_BASE::m_btnSaveReportToFile

protectedinherited

Definition at line 53 of file wx_html_report_panel_base.h.

Referenced by WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_checkBoxShowActions

wxCheckBox* WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowActions

protectedinherited

Definition at line 51 of file wx_html_report_panel_base.h.

Referenced by SetShowSeverity(), syncCheckboxes(), WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_checkBoxShowAll

wxCheckBox* WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowAll

protectedinherited

Definition at line 46 of file wx_html_report_panel_base.h.

Referenced by syncCheckboxes(), WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_checkBoxShowErrors

wxCheckBox* WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowErrors

protectedinherited

Definition at line 47 of file wx_html_report_panel_base.h.

Referenced by SetShowSeverity(), syncCheckboxes(), WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_checkBoxShowInfos

wxCheckBox* WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowInfos

protectedinherited

Definition at line 52 of file wx_html_report_panel_base.h.

Referenced by SetShowSeverity(), syncCheckboxes(), WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_checkBoxShowWarnings

wxCheckBox* WX_HTML_REPORT_PANEL_BASE::m_checkBoxShowWarnings

protectedinherited

Definition at line 49 of file wx_html_report_panel_base.h.

Referenced by SetShowSeverity(), syncCheckboxes(), WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_errorsBadge

NUMBER_BADGE* WX_HTML_REPORT_PANEL_BASE::m_errorsBadge

protectedinherited

Definition at line 48 of file wx_html_report_panel_base.h.

Referenced by updateBadges(), and WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE().

m_fgSizer

wxFlexGridSizer* WX_HTML_REPORT_PANEL_BASE::m_fgSizer

protectedinherited

Definition at line 43 of file wx_html_report_panel_base.h.

Referenced by MsgPanelSetMinSize(), and WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE().

m_htmlView

HTML_WINDOW* WX_HTML_REPORT_PANEL_BASE::m_htmlView

protectedinherited

Definition at line 44 of file wx_html_report_panel_base.h.

Referenced by Flush(), onMenuEvent(), Report(), scrollToBottom(), WX_HTML_REPORT_PANEL(), WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE(), and WX_HTML_REPORT_PANEL_BASE::~WX_HTML_REPORT_PANEL_BASE().

m_lazyUpdate

bool WX_HTML_REPORT_PANEL::m_lazyUpdate

private

Definition at line 134 of file wx_html_report_panel.h.

Referenced by Report(), and SetLazyUpdate().

m_report

REPORT_LINES WX_HTML_REPORT_PANEL::m_report

private

copy of the report, stored for filtering

Definition at line 129 of file wx_html_report_panel.h.

Referenced by Clear(), Count(), Flush(), onBtnSaveToFile(), and Report().

m_reporter

WX_HTML_PANEL_REPORTER WX_HTML_REPORT_PANEL::m_reporter

private

Definition at line 127 of file wx_html_report_panel.h.

Referenced by Reporter().

m_reportFileName

wxString WX_HTML_REPORT_PANEL::m_reportFileName

private

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

Definition at line 136 of file wx_html_report_panel.h.

Referenced by GetFileName(), onBtnSaveToFile(), and SetFileName().

m_reportHead

REPORT_LINES WX_HTML_REPORT_PANEL::m_reportHead

private

... and at the beginning, regardless of sorting

Definition at line 131 of file wx_html_report_panel.h.

Referenced by Clear(), Count(), Flush(), onBtnSaveToFile(), and Report().

m_reportTail

REPORT_LINES WX_HTML_REPORT_PANEL::m_reportTail

private

Lines to print at the end, regardless of sorting.

Definition at line 130 of file wx_html_report_panel.h.

Referenced by Clear(), Count(), Flush(), onBtnSaveToFile(), and Report().

m_severities

int WX_HTML_REPORT_PANEL::m_severities

private

message severities to display (mask)

Definition at line 133 of file wx_html_report_panel.h.

Referenced by generateHtml(), GetVisibleSeverities(), onCheckBoxShowActions(), onCheckBoxShowAll(), onCheckBoxShowErrors(), onCheckBoxShowInfos(), onCheckBoxShowWarnings(), SetVisibleSeverities(), and syncCheckboxes().

m_staticTextShow

wxStaticText* WX_HTML_REPORT_PANEL_BASE::m_staticTextShow

protectedinherited

Definition at line 45 of file wx_html_report_panel_base.h.

Referenced by WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE().

m_warningsBadge

NUMBER_BADGE* WX_HTML_REPORT_PANEL_BASE::m_warningsBadge

protectedinherited

Definition at line 50 of file wx_html_report_panel_base.h.

Referenced by updateBadges(), and WX_HTML_REPORT_PANEL_BASE::WX_HTML_REPORT_PANEL_BASE().

---

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

• wx_html_report_panel.h
• wx_html_report_panel.cpp