KiCad PCB EDA Suite
wx_html_report_box.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2020 KiCad Developers, see change_log.txt for contributors.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation, either version 2 of the License, or (at your
9  * option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef WX_HTML_REPORT_BOX_H
21 #define WX_HTML_REPORT_BOX_H
22 
23 #include <wx/wx.h>
24 #include <reporter.h>
25 #include <vector>
26 #include <wx/html/htmlwin.h>
27 
33 class WX_HTML_REPORT_BOX : public wxHtmlWindow, public REPORTER
34 {
35 public:
36  WX_HTML_REPORT_BOX( wxWindow* parent, wxWindowID id = wxID_ANY,
37  const wxPoint& pos = wxDefaultPosition,
38  const wxSize& size = wxSize( 500,300 ), long style = wxTAB_TRAVERSAL );
39 
40  REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
41 
42  bool HasMessage() const override { return !m_messages.empty(); }
43 
44  void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }
45  EDA_UNITS GetUnits() const override { return m_units; }
46 
47  void Flush();
48  void Clear();
49 
50 private:
51  wxString addHeader( const wxString& aBody );
52  wxString generateHtml( const wxString& aLine );
53 
55 
57  std::vector<wxString> m_messages;
58 };
59 
60 #endif //WX_HTML_REPORT_BOX_H
void SetUnits(EDA_UNITS aUnits)
EDA_UNITS
Definition: common.h:198
wxString addHeader(const wxString &aBody)
WX_HTML_REPORT_BOX.
SEVERITY
Definition: ui_common.h:45
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Function Report is a pure virtual function to override in the derived object.
REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
std::vector< wxString > m_messages
copy of the report, stored for filtering
bool HasMessage() const override
Function HasMessage Returns true if the reporter client is non-empty.
EDA_UNITS GetUnits() const override
wxString generateHtml(const wxString &aLine)
WX_HTML_REPORT_BOX(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL)