KiCad PCB EDA Suite
STATUSBAR_REPORTER Class Reference

A wrapper for reporting to a specific text location in a statusbar. More...

#include <reporter.h>

Inheritance diagram for STATUSBAR_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

 STATUSBAR_REPORTER (wxStatusBar *aStatusBar, int aPosition=0)
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Report a string with a given severity. More...
 
bool HasMessage () const override
 Returns true if the reporter client is non-empty. More...
 
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. More...
 
virtual REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 Places the report at the beginning of the list for objects that support ordering. More...
 
REPORTERoperator<< (const wxString &aText)
 
virtual EDA_UNITS GetUnits () const
 

Private Attributes

wxStatusBar * m_statusBar
 
int m_position
 

Detailed Description

A wrapper for reporting to a specific text location in a statusbar.

Definition at line 286 of file reporter.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 79 of file reporter.h.

79 {
80 LOC_HEAD = 0,
83 };
@ LOC_BODY
Definition: reporter.h:81
@ LOC_TAIL
Definition: reporter.h:82
@ LOC_HEAD
Definition: reporter.h:80

Constructor & Destructor Documentation

◆ STATUSBAR_REPORTER()

STATUSBAR_REPORTER::STATUSBAR_REPORTER ( wxStatusBar *  aStatusBar,
int  aPosition = 0 
)
inline

Definition at line 289 of file reporter.h.

290 : REPORTER(),
291 m_statusBar( aStatusBar ),
292 m_position( aPosition )
293 {
294 }
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
wxStatusBar * m_statusBar
Definition: reporter.h:301

Member Function Documentation

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 123 of file reporter.h.

124 {
126 }

References MILLIMETRES.

◆ HasMessage()

bool STATUSBAR_REPORTER::HasMessage ( ) const
overridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 197 of file reporter.cpp.

198{
199 if( m_statusBar )
200 return m_statusBar->GetStatusText().IsEmpty();
201
202 return false;
203}

References m_statusBar.

Referenced by EDA_3D_CANVAS::DoRePaint().

◆ operator<<()

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

Definition at line 116 of file reporter.h.

116{ return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.

References REPORTER::Report().

◆ Report() [1/2]

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

Definition at line 36 of file reporter.cpp.

37{
38 Report( FROM_UTF8( aText ) );
39 return *this;
40}
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110

References FROM_UTF8(), and REPORTER::Report().

◆ Report() [2/2]

REPORTER & STATUSBAR_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

Implements REPORTER.

Definition at line 188 of file reporter.cpp.

189{
190 if( m_statusBar )
191 m_statusBar->SetStatusText( aText, m_position );
192
193 return *this;
194}

References m_position, and m_statusBar.

Referenced by EDA_3D_CANVAS::DoRePaint(), and EDA_3D_CANVAS::OnMouseMove().

◆ 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 108 of file reporter.h.

110 {
111 return Report( aText, aSeverity );
112 }

References REPORTER::Report().

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ ReportTail()

Member Data Documentation

◆ m_position

int STATUSBAR_REPORTER::m_position
private

Definition at line 302 of file reporter.h.

Referenced by Report().

◆ m_statusBar

wxStatusBar* STATUSBAR_REPORTER::m_statusBar
private

Definition at line 301 of file reporter.h.

Referenced by HasMessage(), and Report().


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