A wrapper for reporting to a specific text location in a statusbar. More...
#include <reporter.h>
Public Types | |
| enum | LOCATION { LOC_HEAD = 0 , LOC_BODY , LOC_TAIL } |
| Location where the message is to be reported. More... | |
Public Member Functions | |
| STATUSBAR_REPORTER (wxStatusBar *aStatusBar, int aPosition=0) | |
| 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. | |
| 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 | |
| wxStatusBar * | m_statusBar |
| int | m_position |
| int | m_severityMask |
Detailed Description
A wrapper for reporting to a specific text location in a statusbar.
Definition at line 294 of file reporter.h.
Member Enumeration Documentation
◆ 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
◆ STATUSBAR_REPORTER()
|
inline |
Definition at line 297 of file reporter.h.
Member Function Documentation
◆ Clear()
|
inlinevirtualinherited |
Reimplemented in WX_HTML_REPORT_BOX, WX_STRING_REPORTER, and TEST_REPORTER.
Definition at line 150 of file reporter.h.
Referenced by WX_HTML_REPORT_BOX::Clear(), WX_STRING_REPORTER::Clear(), TEST_REPORTER::Clear(), and SCH_PLOTTER::createPlotFileName().
◆ GetUnits()
|
inlinevirtualinherited |
Reimplemented in WX_HTML_REPORT_BOX.
Definition at line 145 of file reporter.h.
Referenced by BOOST_AUTO_TEST_CASE().
◆ HasMessage()
|
overridevirtual |
Returns true if the reporter client is non-empty.
Implements REPORTER.
Definition at line 225 of file reporter.cpp.
References m_position, and m_statusBar.
◆ HasMessageOfSeverity()
|
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().
◆ operator<<()
|
inlineinherited |
Definition at line 129 of file reporter.h.
◆ Report() [1/2]
|
inherited |
Definition at line 49 of file reporter.cpp.
References From_UTF8(), and REPORTER::Report().
◆ Report() [2/2]
|
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 214 of file reporter.cpp.
References m_position, m_statusBar, and REPORTER::Report().
Referenced by EDA_3D_CANVAS::DoRePaint(), and EDA_3D_CANVAS::OnMouseMove().
◆ ReportHead()
|
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()
|
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().
Member Data Documentation
◆ m_position
|
private |
Definition at line 309 of file reporter.h.
Referenced by HasMessage(), and Report().
◆ m_severityMask
|
privateinherited |
Definition at line 156 of file reporter.h.
◆ m_statusBar
|
private |
Definition at line 308 of file reporter.h.
Referenced by HasMessage(), and Report().
The documentation for this class was generated from the following files:
