KiCad PCB EDA Suite
WX_TEXT_CTRL_REPORTER Class Reference

WX_TEXT_CTRL_REPORTER is wrapper for reporting to a wxTextCtrl object. More...

#include <reporter.h>

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

 WX_TEXT_CTRL_REPORTER (wxTextCtrl *aTextCtrl)
 
virtual ~WX_TEXT_CTRL_REPORTER ()
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Function Report is a pure virtual function to override in the derived object. More...
 
bool HasMessage () const override
 Function HasMessage 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)
 Function ReportTail 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)
 Function ReportHead Places the report at the beginning of the list for objects that support ordering. More...
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 
virtual EDA_UNITS GetUnits () const
 

Private Attributes

wxTextCtrl * m_textCtrl
 

Detailed Description

WX_TEXT_CTRL_REPORTER is wrapper for reporting to a wxTextCtrl object.

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

73  {
74  LOC_HEAD = 0,
75  LOC_BODY,
76  LOC_TAIL
77  };

Constructor & Destructor Documentation

◆ WX_TEXT_CTRL_REPORTER()

WX_TEXT_CTRL_REPORTER::WX_TEXT_CTRL_REPORTER ( wxTextCtrl *  aTextCtrl)
inline

Definition at line 141 of file reporter.h.

141  :
142  REPORTER(),
143  m_textCtrl( aTextCtrl )
144  {
145  }
wxTextCtrl * m_textCtrl
Definition: reporter.h:138
REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64

◆ ~WX_TEXT_CTRL_REPORTER()

virtual WX_TEXT_CTRL_REPORTER::~WX_TEXT_CTRL_REPORTER ( )
inlinevirtual

Definition at line 147 of file reporter.h.

148  {
149  }

Member Function Documentation

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 121 of file reporter.h.

122  {
123  return EDA_UNITS::MILLIMETRES;
124  }

References MILLIMETRES.

Referenced by PCB_INSPECTION_TOOL::reportClearance(), and PCB_INSPECTION_TOOL::reportZoneConnection().

◆ HasMessage()

bool WX_TEXT_CTRL_REPORTER::HasMessage ( ) const
overridevirtual

Function HasMessage Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 49 of file reporter.cpp.

50 {
51  return !m_textCtrl->IsEmpty();
52 }
wxTextCtrl * m_textCtrl
Definition: reporter.h:138

References m_textCtrl.

◆ operator<<() [1/4]

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

Definition at line 110 of file reporter.h.

110 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ operator<<() [2/4]

REPORTER& REPORTER::operator<< ( const wxChar *  aText)
inlineinherited

Definition at line 111 of file reporter.h.

111 { return Report( wxString( aText ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ operator<<() [3/4]

REPORTER& REPORTER::operator<< ( wxChar  aChar)
inlineinherited

Definition at line 112 of file reporter.h.

112 { return Report( wxString( aChar ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ operator<<() [4/4]

REPORTER& REPORTER::operator<< ( const char *  aText)
inlineinherited

Definition at line 113 of file reporter.h.

113 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

◆ Report() [1/2]

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

Definition at line 33 of file reporter.cpp.

34 {
35  Report( FROM_UTF8( aText ) );
36  return *this;
37 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:109
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

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

◆ Report() [2/2]

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

Function Report is a pure virtual function to override in the derived object.

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 40 of file reporter.cpp.

41 {
42  wxCHECK_MSG( m_textCtrl != NULL, *this,
43  wxT( "No wxTextCtrl object defined in WX_TEXT_CTRL_REPORTER." ) );
44 
45  m_textCtrl->AppendText( aText );
46  return *this;
47 }
wxTextCtrl * m_textCtrl
Definition: reporter.h:138
#define NULL

References m_textCtrl, and NULL.

◆ ReportHead()

virtual REPORTER& REPORTER::ReportHead ( const wxString &  aText,
SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED 
)
inlinevirtualinherited

Function ReportHead Places the report at the beginning of the list for objects that support ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 103 of file reporter.h.

104  {
105  return Report( aText, aSeverity );
106  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_NETLIST::loadNetlist(), BACK_ANNOTATE::processNetNameChange(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ ReportTail()

virtual REPORTER& REPORTER::ReportTail ( const wxString &  aText,
SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED 
)
inlinevirtualinherited

Function ReportTail Places the report at the end of the list, for objects that support report ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 94 of file reporter.h.

95  {
96  return Report( aText, aSeverity );
97  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References REPORTER::Report().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), BACK_ANNOTATE::BackAnnotateSymbols(), BACK_ANNOTATE::checkForUnusedSymbols(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), BACK_ANNOTATE::getChangeList(), GERBER_JOBFILE_READER::ReadGerberJobFile(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().

Member Data Documentation

◆ m_textCtrl

wxTextCtrl* WX_TEXT_CTRL_REPORTER::m_textCtrl
private

Definition at line 138 of file reporter.h.

Referenced by HasMessage(), and Report().


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