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-2021 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 #include <eda_units.h>
28 
32 class WX_HTML_REPORT_BOX : public wxHtmlWindow, public REPORTER
33 {
34 public:
35  WX_HTML_REPORT_BOX( wxWindow* parent, wxWindowID id = wxID_ANY,
36  const wxPoint& pos = wxDefaultPosition,
37  const wxSize& size = wxSize( 500,300 ), long style = wxTAB_TRAVERSAL );
38 
39  REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
40 
41  bool HasMessage() const override { return !m_messages.empty(); }
42 
43  void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }
44  EDA_UNITS GetUnits() const override { return m_units; }
45 
46  void SetImmediateMode() { m_immediateMode = true; }
47 
48  void Flush();
49  void Clear();
50 
51 private:
52  wxString addHeader( const wxString& aBody );
53  wxString generateHtml( const wxString& aLine );
54 
56 
57  // Indicates messages should be flushed as they are added. Required for progress-related
58  // reports, but can be very slow for larger reports.
60 
62  std::vector<wxString> m_messages;
63 };
64 
65 #endif //WX_HTML_REPORT_BOX_H
void SetUnits(EDA_UNITS aUnits)
wxString addHeader(const wxString &aBody)
A slimmed down version of WX_HTML_REPORT_PANEL.
SEVERITY
Definition: ui_common.h:83
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
std::vector< wxString > m_messages
bool HasMessage() const override
Returns true if the reporter client is non-empty.
bool m_immediateMode
copy of the report, stored for filtering
EDA_UNITS
Definition: eda_units.h:38
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)