wx_html_report_panel.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 CERN
 * Copyright (C) 2015-2021 KiCad Developers, see change_log.txt for contributors.
 * Author: Tomasz Wlostowski <[email protected]>
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __WX_HTML_REPORT_PANEL_H__
#define __WX_HTML_REPORT_PANEL_H__
 
#include <reporter.h>
#include <vector>
 
#include "wx_html_report_panel_base.h"
 
class WX_HTML_REPORT_PANEL;
 
class KICOMMON_API WX_HTML_PANEL_REPORTER : public REPORTER
{
public:
 WX_HTML_PANEL_REPORTER( WX_HTML_REPORT_PANEL* aPanel ) : REPORTER(), m_panel( aPanel ) {}
 
 virtual ~WX_HTML_PANEL_REPORTER() {}
 
 REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
 REPORTER& ReportTail( const wxString& aText,
 SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
 REPORTER& ReportHead( const wxString& aText,
 SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
 bool HasMessage() const override;
 
private:
 WX_HTML_REPORT_PANEL* m_panel;
};
 
class KICOMMON_API WX_HTML_REPORT_PANEL : public WX_HTML_REPORT_PANEL_BASE
{
public:
 WX_HTML_REPORT_PANEL( wxWindow* parent, wxWindowID id = wxID_ANY,
 const wxPoint& pos = wxDefaultPosition,
 const wxSize& size = wxSize( 500,300 ), long style = wxTAB_TRAVERSAL );
 ~WX_HTML_REPORT_PANEL();
 
 void MsgPanelSetMinSize( const wxSize& aMinSize );
 
 REPORTER& Reporter();
 
 void Report( const wxString& aText, SEVERITY aSeverity,
 REPORTER::LOCATION aLocation = REPORTER::LOC_BODY );
 
 void Clear();
 
 int Count( int severityMask );
 
 void SetLabel( const wxString& aLabel ) override;
 
 void SetLazyUpdate( bool aLazyUpdate );
 
 void Flush( bool aSort = false );
 
 void SetVisibleSeverities( int aSeverities );
 
 int GetVisibleSeverities() const;
 
 void SetShowSeverity( SEVERITY aSeverity, bool aValue );
 
 void SetFileName( const wxString& aReportFileName );
 
 wxString& GetFileName( void );
 
 
private:
 struct REPORT_LINE
 {
 SEVERITY severity;
 wxString message;
 };
 
 typedef std::vector<REPORT_LINE> REPORT_LINES;
 
 wxString addHeader( const wxString& aBody );
 wxString generateHtml( const REPORT_LINE& aLine );
 wxString generatePlainText( const REPORT_LINE& aLine );
 void updateBadges();
 
 void scrollToBottom();
 void syncCheckboxes();
 
 void onRightClick( wxMouseEvent& event ) override;
 void onMenuEvent( wxMenuEvent& event );
 void onCheckBoxShowAll( wxCommandEvent& event ) override;
 void onCheckBoxShowWarnings( wxCommandEvent& event ) override;
 void onCheckBoxShowErrors( wxCommandEvent& event ) override;
 void onCheckBoxShowInfos( wxCommandEvent& event ) override;
 void onCheckBoxShowActions( wxCommandEvent& event ) override;
 
 void onBtnSaveToFile( wxCommandEvent& event ) override;
 
 void onThemeChanged( wxSysColourChangedEvent &aEvent );
 
private:
 WX_HTML_PANEL_REPORTER m_reporter;
 
 REPORT_LINES m_report; 
 REPORT_LINES m_reportTail; 
 REPORT_LINES m_reportHead; 
 
 int m_severities; 
 bool m_lazyUpdate;
 
 wxString m_reportFileName; 
};
 
#endif //__WX_HTML_REPORT_PANEL_H__