KiCad PCB EDA Suite
Loading...
Searching...
No Matches
INFOBAR_REPORTER Class Reference

A wrapper for reporting to a WX_INFOBAR UI element. More...

#include <wx_infobar.h>

Inheritance diagram for INFOBAR_REPORTER:
REPORTER

Public Types

enum  LOCATION { LOC_HEAD = 0 , LOC_BODY , LOC_TAIL }
 Location where the message is to be reported. More...
 

Public Member Functions

 INFOBAR_REPORTER (WX_INFOBAR *aInfoBar)
 
virtual ~INFOBAR_REPORTER ()
 
REPORTERReport (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 Finalize ()
 Update the infobar with the reported text.
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 
virtual REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 Places the report at the end of the list, for objects that support report ordering.
 
virtual REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 Places the report at the beginning of the list for objects that support ordering.
 
REPORTERoperator<< (const wxString &aText)
 
virtual bool HasMessageOfSeverity (int aSeverityMask) const
 Returns true if the reporter has one or more messages matching the specified severity mask.
 
virtual EDA_UNITS GetUnits () const
 
virtual void Clear ()
 

Private Attributes

bool m_messageSet
 
WX_INFOBARm_infoBar
 
std::unique_ptr< wxString > m_message
 
SEVERITY m_severity
 
int m_reportedSeverityMask
 

Detailed Description

A wrapper for reporting to a WX_INFOBAR UI element.

The infobar is not updated until the Finalize() method is called. That method will queue either a show message or a dismiss event for the infobar - so this reporter is safe to use inside a paint event without causing an infinite paint event loop.

No action is taken if no message is given to the reporter.

Definition at line 326 of file wx_infobar.h.

Member Enumeration Documentation

◆ LOCATION

enum REPORTER::LOCATION
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.

Constructor & Destructor Documentation

◆ INFOBAR_REPORTER()

INFOBAR_REPORTER::INFOBAR_REPORTER ( WX_INFOBAR * aInfoBar)
inline

◆ ~INFOBAR_REPORTER()

virtual INFOBAR_REPORTER::~INFOBAR_REPORTER ( )
inlinevirtual

Definition at line 337 of file wx_infobar.h.

Member Function Documentation

◆ Clear()

virtual void REPORTER::Clear ( )
inlinevirtualinherited

◆ Finalize()

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 148 of file reporter.h.

References MM.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ HasMessage()

bool INFOBAR_REPORTER::HasMessage ( ) const
overridevirtual

Returns true if any messages were reported.

Reimplemented from REPORTER.

Definition at line 506 of file wx_infobar.cpp.

References m_message.

Referenced by Finalize().

◆ HasMessageOfSeverity()

◆ operator<<()

REPORTER & REPORTER::operator<< ( const wxString & aText)
inlineinherited

Definition at line 129 of file reporter.h.

References Report(), and REPORTER().

◆ Report() [1/2]

REPORTER & INFOBAR_REPORTER::Report ( const wxString & aText,
SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
overridevirtual

Report a string with a given severity.

Parameters
aTextis the string to report.
aSeverityis an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Reimplemented from REPORTER.

Definition at line 496 of file wx_infobar.cpp.

References m_message, m_messageSet, m_severity, and REPORTER::REPORTER().

Referenced by EDA_3D_CANVAS::DoRePaint().

◆ Report() [2/2]

REPORTER & REPORTER::Report ( const char * aText,
SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
inherited

Definition at line 49 of file reporter.cpp.

References From_UTF8(), Report(), and REPORTER().

◆ ReportHead()

virtual REPORTER & REPORTER::ReportHead ( const wxString & aText,
SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
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().

◆ ReportTail()

Member Data Documentation

◆ m_infoBar

WX_INFOBAR* INFOBAR_REPORTER::m_infoBar
private

Definition at line 350 of file wx_infobar.h.

Referenced by Finalize(), and INFOBAR_REPORTER().

◆ m_message

std::unique_ptr<wxString> INFOBAR_REPORTER::m_message
private

Definition at line 351 of file wx_infobar.h.

Referenced by Finalize(), HasMessage(), and Report().

◆ m_messageSet

bool INFOBAR_REPORTER::m_messageSet
private

Definition at line 349 of file wx_infobar.h.

Referenced by Finalize(), INFOBAR_REPORTER(), and Report().

◆ m_reportedSeverityMask

int REPORTER::m_reportedSeverityMask
privateinherited

Definition at line 159 of file reporter.h.

Referenced by Clear(), HasMessage(), HasMessageOfSeverity(), Report(), and REPORTER().

◆ m_severity

SEVERITY INFOBAR_REPORTER::m_severity
private

Definition at line 352 of file wx_infobar.h.

Referenced by Finalize(), INFOBAR_REPORTER(), and Report().


The documentation for this class was generated from the following files: