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

#include <reporter.h>

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

REPORTER &	Report (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...

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

virtual REPORTER &	ReportTail (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 REPORTER &	ReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Places the report at the beginning of the list for objects that support ordering. More...

REPORTER &	operator<< (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 308 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.

Constructor & Destructor Documentation

◆ STATUSBAR_REPORTER()

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

inline

Definition at line 311 of file reporter.h.

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.

◆ HasMessage()

bool STATUSBAR_REPORTER::HasMessage ( ) const

overridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 223 of file reporter.cpp.

References m_position, and m_statusBar.

◆ operator<<()

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

inlineinherited

Definition at line 116 of file reporter.h.

References REPORTER::Report().

◆ Report() [1/2]

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

inherited

Definition at line 38 of file reporter.cpp.

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

aText	is the string to report.
aSeverity	is an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Implements REPORTER.

Definition at line 214 of file reporter.cpp.

References m_position, and m_statusBar.

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