KiCad PCB EDA Suite
|
A slimmed down version of WX_HTML_REPORT_PANEL. More...
#include <wx_html_report_box.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_HTML_REPORT_BOX (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL) | |
~WX_HTML_REPORT_BOX () | |
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 any messages were reported. | |
void | SetUnits (EDA_UNITS aUnits) |
EDA_UNITS | GetUnits () const override |
void | SetImmediateMode () |
In immediate mode, messages are flushed as they are added. | |
void | Flush () |
Build the HTML messages page. | |
void | Clear () override |
Delete the stored messages. | |
bool | SetPage (const wxString &aSource) override |
bool | AppendToPage (const wxString &aSource) |
void | ThemeChanged () |
bool | ScrollToAnchor (const wxString &aAnchor) |
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. | |
Private Member Functions | |
void | onThemeChanged (wxSysColourChangedEvent &aEvent) |
void | onRightClick (wxMouseEvent &event) |
void | onMenuEvent (wxMenuEvent &event) |
wxString | generateHtml (const wxString &aLine) |
Private Attributes | |
EDA_UNITS | m_units |
bool | m_immediateMode |
Indicates messages should be flushed as they are added. | |
std::vector< wxString > | m_messages |
copy of the report, stored for filtering. | |
wxString | m_pageSource |
int | m_reportedSeverityMask |
A slimmed down version of WX_HTML_REPORT_PANEL.
Definition at line 31 of file wx_html_report_box.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 88 of file reporter.h.
WX_HTML_REPORT_BOX::WX_HTML_REPORT_BOX | ( | wxWindow * | parent, |
wxWindowID | id = wxID_ANY, | ||
const wxPoint & | pos = wxDefaultPosition, | ||
const wxSize & | size = wxSize( 500,300 ), | ||
long | style = wxTAB_TRAVERSAL ) |
Definition at line 31 of file wx_html_report_box.cpp.
References Flush(), HTML_WINDOW::HTML_WINDOW(), m_immediateMode, m_units, MM, onRightClick(), and onThemeChanged().
WX_HTML_REPORT_BOX::~WX_HTML_REPORT_BOX | ( | ) |
Definition at line 47 of file wx_html_report_box.cpp.
References onRightClick().
|
inherited |
Definition at line 69 of file html_window.cpp.
References m_pageSource, and SetPage().
|
overridevirtual |
Delete the stored messages.
Reimplemented from REPORTER.
Definition at line 137 of file wx_html_report_box.cpp.
References REPORTER::Clear(), and m_messages.
void WX_HTML_REPORT_BOX::Flush | ( | ) |
Build the HTML messages page.
Call it if the immediate mode is not activated to be able to display them.
Definition at line 107 of file wx_html_report_box.cpp.
References generateHtml(), m_messages, and HTML_WINDOW::SetPage().
Referenced by BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), SCH_EDIT_FRAME::importFile(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), onThemeChanged(), PCB_EDIT_FRAME::OpenProjectFiles(), Report(), and WX_HTML_REPORT_BOX().
|
private |
|
inlineoverridevirtual |
Reimplemented from REPORTER.
Definition at line 45 of file wx_html_report_box.h.
References m_units.
|
inlineoverridevirtual |
Returns true if any messages were reported.
Reimplemented from REPORTER.
Definition at line 42 of file wx_html_report_box.h.
References m_messages.
Referenced by SCH_EDIT_FRAME::importFile(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), and PCB_EDIT_FRAME::OpenProjectFiles().
|
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 143 of file reporter.h.
References m_reportedSeverityMask.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COMPONENT_CLASS_MANAGER::CompileAssignmentRule(), DRC_ENGINE::compileRules(), DIALOG_SIM_MODEL< T >::loadLibrary(), SIMULATOR_CONTROL::NewAnalysisTab(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SIM_LIB_MGR::SetLibrary(), and SIMULATOR_FRAME::showNetlistErrors().
|
private |
Definition at line 71 of file wx_html_report_box.cpp.
|
private |
Definition at line 63 of file wx_html_report_box.cpp.
Referenced by WX_HTML_REPORT_BOX(), and ~WX_HTML_REPORT_BOX().
|
private |
Definition at line 55 of file wx_html_report_box.cpp.
References Flush().
Referenced by WX_HTML_REPORT_BOX().
|
inlineinherited |
Definition at line 129 of file reporter.h.
References Report(), and REPORTER().
|
inherited |
Definition at line 49 of file reporter.cpp.
References From_UTF8(), Report(), and REPORTER().
|
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 |
Reimplemented from REPORTER.
Definition at line 90 of file wx_html_report_box.cpp.
References Flush(), m_immediateMode, m_messages, and REPORTER::REPORTER().
Referenced by BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), and BOARD_INSPECTION_TOOL::InspectDRCError().
|
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.
References Report(), REPORTER(), and RPT_SEVERITY_UNDEFINED.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_IMPORT_NETLIST::loadNetlist(), WX_HTML_PANEL_REPORTER::ReportHead(), 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 112 of file reporter.h.
References Report(), REPORTER(), and RPT_SEVERITY_UNDEFINED.
Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), WX_HTML_PANEL_REPORTER::ReportTail(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().
|
inherited |
Definition at line 81 of file html_window.cpp.
References result.
|
inline |
In immediate mode, messages are flushed as they are added.
Required for progress-related reports, but can be very slow for larger reports.
Definition at line 52 of file wx_html_report_box.h.
References m_immediateMode.
|
overrideinherited |
Definition at line 50 of file html_window.cpp.
References m_pageSource.
Referenced by AppendToPage(), DIALOG_ABOUT::createNotebookHtmlPage(), WX_HTML_REPORT_BOX::Flush(), and ThemeChanged().
|
inline |
Definition at line 44 of file wx_html_report_box.h.
References m_units.
Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage().
|
inherited |
Definition at line 75 of file html_window.cpp.
References m_pageSource, and SetPage().
Referenced by onThemeChanged().
|
private |
Indicates messages should be flushed as they are added.
Required for progress-related reports, but can be very slow for larger reports.
Definition at line 78 of file wx_html_report_box.h.
Referenced by Report(), SetImmediateMode(), and WX_HTML_REPORT_BOX().
|
private |
copy of the report, stored for filtering.
Definition at line 81 of file wx_html_report_box.h.
Referenced by Clear(), Flush(), HasMessage(), and Report().
|
privateinherited |
Definition at line 61 of file html_window.h.
Referenced by AppendToPage(), SetPage(), and ThemeChanged().
|
privateinherited |
Definition at line 159 of file reporter.h.
Referenced by Clear(), HasMessage(), HasMessageOfSeverity(), Report(), and REPORTER().
|
private |
Definition at line 74 of file wx_html_report_box.h.
Referenced by GetUnits(), SetUnits(), and WX_HTML_REPORT_BOX().