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-2022 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 <reporter.h>
24#include <vector>
25#include <html_window.h>
26#include <eda_units.h>
27
32{
33public:
34 WX_HTML_REPORT_BOX( wxWindow* parent, wxWindowID id = wxID_ANY,
35 const wxPoint& pos = wxDefaultPosition,
36 const wxSize& size = wxSize( 500,300 ), long style = wxTAB_TRAVERSAL );
37
38 REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
39
40 bool HasMessage() const override { return !m_messages.empty(); }
41
42 void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }
43 EDA_UNITS GetUnits() const override { return m_units; }
44
50
55 void Flush();
56
60 void Clear();
61
62private:
63 void onThemeChanged( wxSysColourChangedEvent &aEvent );
64
65 wxString generateHtml( const wxString& aLine );
66
67private:
69
73
75 std::vector<wxString> m_messages;
76};
77
78#endif //WX_HTML_REPORT_BOX_H
Add dark theme support to wxHtmlWindow.
Definition: html_window.h:34
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
A slimmed down version of WX_HTML_REPORT_PANEL.
std::vector< wxString > m_messages
void Clear()
Delete the stored messages.
EDA_UNITS m_units
Indicates messages should be flushed as they are added.
void SetImmediateMode()
In immediate mode, messages are flushed as they are added.
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
bool m_immediateMode
copy of the report, stored for filtering
EDA_UNITS GetUnits() const override
void SetUnits(EDA_UNITS aUnits)
void Flush()
Build the HTML messages page.
WX_HTML_REPORT_BOX(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL)
bool HasMessage() const override
Returns true if the reporter client is non-empty.
wxString generateHtml(const wxString &aLine)
void onThemeChanged(wxSysColourChangedEvent &aEvent)
EDA_UNITS
Definition: eda_units.h:43
SEVERITY
@ RPT_SEVERITY_UNDEFINED