KiCad PCB EDA Suite
STATUS_TEXT_REPORTER Class Reference

Class STATUS_TEXT_REPORTER is a wrapper for reporting to a wxString in a wxFrame status text. More...

#include <status_text_reporter.h>

Inheritance diagram for STATUS_TEXT_REPORTER:
REPORTER

Public Types

enum  SEVERITY {
  RPT_UNDEFINED = 0x0, RPT_INFO = 0x1, RPT_WARNING = 0x2, RPT_ERROR = 0x4,
  RPT_ACTION = 0x8
}
 

Severity of the reported messages.

More...
 

Public Member Functions

 STATUS_TEXT_REPORTER (wxStatusBar *aParentStatusBar, int aPosition=0)
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
 Function Report is a pure virtual function to override in the derived object. More...
 
bool HasMessage () const
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_UNDEFINED)
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 

Private Attributes

wxStatusBar * m_parentStatusBar
 
int m_position
 
bool m_hasMessage
 

Detailed Description

Class STATUS_TEXT_REPORTER is a wrapper for reporting to a wxString in a wxFrame status text.

Definition at line 38 of file status_text_reporter.h.

Member Enumeration Documentation

enum REPORTER::SEVERITY
inherited

Severity of the reported messages.

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_WARNING 
RPT_ERROR 
RPT_ACTION 

Definition at line 65 of file reporter.h.

65  {
66  RPT_UNDEFINED = 0x0,
67  RPT_INFO = 0x1,
68  RPT_WARNING = 0x2,
69  RPT_ERROR = 0x4,
70  RPT_ACTION = 0x8
71  };

Constructor & Destructor Documentation

STATUS_TEXT_REPORTER::STATUS_TEXT_REPORTER ( wxStatusBar *  aParentStatusBar,
int  aPosition = 0 
)
inline

Definition at line 46 of file status_text_reporter.h.

46  :
47  REPORTER(),
48  m_parentStatusBar( aParentStatusBar ), m_position( aPosition )
49  {
50  m_hasMessage = false;
51  }
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
wxStatusBar * m_parentStatusBar

Member Function Documentation

bool STATUS_TEXT_REPORTER::HasMessage ( ) const
inline

Definition at line 64 of file status_text_reporter.h.

References m_hasMessage.

Referenced by EDA_3D_CANVAS::OnPaint().

64 { return m_hasMessage; }
REPORTER& REPORTER::operator<< ( const wxString &  aText)
inlineinherited

Definition at line 84 of file reporter.h.

References REPORTER::Report().

84 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( const wxChar *  aText)
inlineinherited

Definition at line 85 of file reporter.h.

References REPORTER::Report().

85 { return Report( wxString( aText ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( wxChar  aChar)
inlineinherited

Definition at line 86 of file reporter.h.

References REPORTER::Report().

86 { return Report( wxString( aChar ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( const char *  aText)
inlineinherited

Definition at line 87 of file reporter.h.

References REPORTER::Report().

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

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

Parameters
aTextis the string to report.

Implements REPORTER.

Definition at line 53 of file status_text_reporter.h.

Referenced by EDA_3D_CANVAS::OnPaint().

54  {
55  if( !aText.IsEmpty() )
56  m_hasMessage = true;
57 
58  if( m_parentStatusBar )
59  m_parentStatusBar->SetStatusText( aText, m_position );
60 
61  return *this;
62  }
wxStatusBar * m_parentStatusBar
REPORTER & REPORTER::Report ( const char *  aText,
REPORTER::SEVERITY  aSeverity = RPT_UNDEFINED 
)
inherited

Definition at line 32 of file reporter.cpp.

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

33 {
34  Report( FROM_UTF8( aText ) );
35  return *this;
36 }
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:53
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

Member Data Documentation

bool STATUS_TEXT_REPORTER::m_hasMessage
private

Definition at line 43 of file status_text_reporter.h.

Referenced by HasMessage().

wxStatusBar* STATUS_TEXT_REPORTER::m_parentStatusBar
private

Definition at line 41 of file status_text_reporter.h.

int STATUS_TEXT_REPORTER::m_position
private

Definition at line 42 of file status_text_reporter.h.


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