KiCad PCB EDA Suite
|
A wrapper for reporting to a wxString object. 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 | |
WX_STRING_REPORTER (wxString *aString) | |
virtual | ~WX_STRING_REPORTER () |
REPORTER & | Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override |
Report a string with a given severity. More... | |
bool | HasMessage () const override |
Returns true if the reporter client is non-empty. More... | |
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. More... | |
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. More... | |
REPORTER & | operator<< (const wxString &aText) |
virtual EDA_UNITS | GetUnits () const |
Private Attributes | |
wxString * | m_string |
A wrapper for reporting to a wxString object.
Definition at line 163 of file reporter.h.
|
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 79 of file reporter.h.
|
inline |
Definition at line 166 of file reporter.h.
|
inlinevirtual |
Definition at line 172 of file reporter.h.
|
inlinevirtualinherited |
Reimplemented in WX_HTML_REPORT_BOX.
Definition at line 123 of file reporter.h.
|
overridevirtual |
Returns true if the reporter client is non-empty.
Implements REPORTER.
Definition at line 71 of file reporter.cpp.
References m_string.
Referenced by SIMULATOR_FRAME_UI::applyTuners(), DIALOG_SIM_MODEL< T_symbol, T_field >::loadLibrary(), SIM_MODEL::MigrateSimModel(), SCH_EDITOR_CONTROL::SimProbe(), and DIALOG_SIM_MODEL< T_symbol, T_field >::TransferDataToWindow().
|
inlineinherited |
Definition at line 116 of file reporter.h.
References REPORTER::Report().
|
inherited |
Definition at line 38 of file reporter.cpp.
References From_UTF8(), and REPORTER::Report().
|
overridevirtual |
Report a string with a given severity.
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 61 of file reporter.cpp.
References m_string.
Referenced by SIMULATOR_FRAME_UI::applyTuners(), and GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles().
|
inlinevirtualinherited |
Places the report at the beginning of the list for objects that support ordering.
Reimplemented in WX_HTML_PANEL_REPORTER.
Definition at line 108 of file reporter.h.
References REPORTER::Report().
Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), and SCH_EDIT_FRAME::WriteNetListFile().
|
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 99 of file reporter.h.
References REPORTER::Report().
Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::BackAnnotateSymbols(), BACK_ANNOTATE::checkForUnusedSymbols(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), BACK_ANNOTATE::getChangeList(), DIALOG_PLOT::Plot(), GERBER_JOBFILE_READER::ReadGerberJobFile(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().
|
private |
Definition at line 181 of file reporter.h.
Referenced by HasMessage(), and Report().