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

A wrapper for reporting to a WX_INFOBAR UI element. More...

#include <wx_infobar.h>

Inheritance diagram for INFOBAR_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

 INFOBAR_REPORTER (WX_INFOBAR *aInfoBar)
 
virtual ~INFOBAR_REPORTER ()
 
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 Finalize ()
 Update the infobar with the reported text.
 
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.
 
virtual EDA_UNITS GetUnits () const
 
virtual void Clear ()
 

Private Attributes

bool m_messageSet
 
WX_INFOBAR * m_infoBar
 
std::unique_ptr< wxString > m_message
 
SEVERITY m_severity
 
int m_severityMask
 

Detailed Description

A wrapper for reporting to a WX_INFOBAR UI element.

The infobar is not updated until the Finalize() method is called. That method will queue either a show message or a dismiss event for the infobar - so this reporter is safe to use inside a paint event without causing an infinite paint event loop.

No action is taken if no message is given to the reporter.

Definition at line 326 of file wx_infobar.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

◆ INFOBAR_REPORTER()

INFOBAR_REPORTER::INFOBAR_REPORTER ( WX_INFOBAR *  aInfoBar)
inline

Definition at line 329 of file wx_infobar.h.

◆ ~INFOBAR_REPORTER()

virtual INFOBAR_REPORTER::~INFOBAR_REPORTER ( )
inlinevirtual

Definition at line 335 of file wx_infobar.h.

Member Function Documentation

◆ Clear()

virtual void REPORTER::Clear ( )
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX, and WX_STRING_REPORTER.

Definition at line 150 of file reporter.h.

Referenced by WX_HTML_REPORT_BOX::Clear(), WX_STRING_REPORTER::Clear(), and SCH_PLOTTER::createPlotFileName().

◆ Finalize()

void INFOBAR_REPORTER::Finalize ( )

Update the infobar with the reported text.

Definition at line 504 of file wx_infobar.cpp.

References HasMessage(), m_infoBar, m_message, m_messageSet, m_severity, WX_INFOBAR::QueueDismiss(), WX_INFOBAR::QueueShowMessage(), RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_IGNORE, RPT_SEVERITY_INFO, RPT_SEVERITY_UNDEFINED, and RPT_SEVERITY_WARNING.

Referenced by EDA_3D_CANVAS::DoRePaint(), and DISPLAY_FOOTPRINTS_FRAME::InitDisplay().

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 145 of file reporter.h.

◆ HasMessage()

bool INFOBAR_REPORTER::HasMessage ( ) const
overridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 498 of file wx_infobar.cpp.

References m_message.

Referenced by Finalize().

◆ 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 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().

◆ 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 & INFOBAR_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 488 of file wx_infobar.cpp.

References m_message, m_messageSet, and m_severity.

Referenced by EDA_3D_CANVAS::DoRePaint().

◆ 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(), 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(), 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().

Member Data Documentation

◆ m_infoBar

WX_INFOBAR* INFOBAR_REPORTER::m_infoBar
private

Definition at line 348 of file wx_infobar.h.

Referenced by Finalize().

◆ m_message

std::unique_ptr<wxString> INFOBAR_REPORTER::m_message
private

Definition at line 349 of file wx_infobar.h.

Referenced by Finalize(), HasMessage(), and Report().

◆ m_messageSet

bool INFOBAR_REPORTER::m_messageSet
private

Definition at line 347 of file wx_infobar.h.

Referenced by Finalize(), and Report().

◆ m_severity

SEVERITY INFOBAR_REPORTER::m_severity
private

Definition at line 350 of file wx_infobar.h.

Referenced by Finalize(), and Report().

◆ m_severityMask

int REPORTER::m_severityMask
privateinherited

Definition at line 156 of file reporter.h.

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