#include <kistatusbar.h>

Inheritance diagram for KISTATUSBAR:

Public Types
enum	STYLE_FLAGS : int { NONE_STYLE = 0x00 , NOTIFICATION_ICON = 0x01 , CANCEL_BUTTON = 0x02 , WARNING_ICON = 0x04 }

Public Member Functions
	KISTATUSBAR (int aNumberFields, wxWindow *parent, wxWindowID id, STYLE_FLAGS aFlags=DEFAULT_STYLE)

	~KISTATUSBAR ()

void	SetEllipsedTextField (const wxString &aText, int aFieldId)
	Set the text in a field using wxELLIPSIZE_MIDDLE option to adjust the text size to the field size.

void	ShowBackgroundProgressBar (bool aCancellable=false)
	Show the background progress bar.

void	HideBackgroundProgressBar ()
	Hide the background progress bar.

void	SetBackgroundProgress (int aAmount)
	Set the current progress of the progress bar.

void	SetBackgroundProgressMax (int aAmount)
	Set the max progress of the progress bar.

void	SetBackgroundStatusText (const wxString &aTxt)
	Set the status text that displays next to the progress bar.

void	SetNotificationCount (int aCount)
	Set the notification count on the notifications button.

void	ClearWarningMessages (const wxString &aSource=wxEmptyString)
	Clears all warning messages from the given source (or all sources if aSource is empty)

void	AddWarningMessages (const wxString &aSource, const wxString &aMessages)
	Add warning/error messages (not thread-safe, use the std::vector<LOAD_MESSAGE> variant from other threads)

void	AddWarningMessages (const wxString &aSource, const std::vector< LOAD_MESSAGE > &aMessages)
	Add warning/error messages thread-safely.

size_t	GetLoadWarningCount () const
	Get current message count (thread-safe).

Static Public Attributes
static constexpr auto	DEFAULT_STYLE

Private Types
enum class	FIELD { BGJOB_LABEL , BGJOB_GAUGE , BGJOB_CANCEL , WARNING , NOTIFICATION }

Private Member Functions
void	onSize (wxSizeEvent &aEvent)

void	onBackgroundProgressClick (wxMouseEvent &aEvent)

void	onNotificationsIconClick (wxCommandEvent &aEvent)

void	onLoadWarningsIconClick (wxCommandEvent &aEvent)

void	updateWarningUI ()
	Update warning button visibility and badge (main thread only)

void	updateAuxFieldWidths ()

void	updateBackgroundText ()

void	layoutControls ()

std::optional< int >	fieldIndex (FIELD aField) const

Private Attributes
wxGauge *	m_backgroundProgressBar

wxButton *	m_backgroundStopButton

wxStaticText *	m_backgroundTxt

BITMAP_BUTTON *	m_notificationsButton

BITMAP_BUTTON *	m_warningButton

std::mutex	m_warningMutex
	Protects m_warningMessages.

std::unordered_map< wxString, std::vector< LOAD_MESSAGE > >	m_warningMessages

int	m_normalFieldsCount

STYLE_FLAGS	m_styleFlags

wxString	m_savedStatusText
	Saved text from adjacent field during background jobs.

wxString	m_backgroundRawText
	Unellipsized background status text.

std::vector< int >	m_fieldWidths

Detailed Description

Definition at line 60 of file kistatusbar.h.

Member Enumeration Documentation

◆ FIELD

enum class KISTATUSBAR::FIELD

strongprivate

Enumerator
BGJOB_LABEL
BGJOB_GAUGE
BGJOB_CANCEL
WARNING
NOTIFICATION

Definition at line 151 of file kistatusbar.h.

◆ STYLE_FLAGS

enum KISTATUSBAR::STYLE_FLAGS : int

Enumerator
NONE_STYLE
NOTIFICATION_ICON
CANCEL_BUTTON
WARNING_ICON

Definition at line 63 of file kistatusbar.h.

Constructor & Destructor Documentation

◆ KISTATUSBAR()

KISTATUSBAR::KISTATUSBAR	(	int	aNumberFields,
		wxWindow *	parent,
		wxWindowID	id,
		STYLE_FLAGS	aFlags = DEFAULT_STYLE )

◆ ~KISTATUSBAR()

KISTATUSBAR::~KISTATUSBAR ( )

Definition at line 174 of file kistatusbar.cpp.

References m_backgroundProgressBar, m_notificationsButton, m_warningButton, onBackgroundProgressClick(), onLoadWarningsIconClick(), onNotificationsIconClick(), and onSize().

Member Function Documentation

◆ AddWarningMessages() [1/2]

void KISTATUSBAR::AddWarningMessages	(	const wxString &	aSource,
		const std::vector< LOAD_MESSAGE > &	aMessages )

Add warning/error messages thread-safely.

Can be called from any thread. UI update is deferred to main thread.

Definition at line 440 of file kistatusbar.cpp.

References end, m_warningMessages, m_warningMutex, traceLibraries, and updateWarningUI().

◆ AddWarningMessages() [2/2]

void KISTATUSBAR::AddWarningMessages	(	const wxString &	aSource,
		const wxString &	aMessages )

Add warning/error messages (not thread-safe, use the std::vector<LOAD_MESSAGE> variant from other threads)

Definition at line 420 of file kistatusbar.cpp.

References m_warningMessages, m_warningMutex, LOAD_MESSAGE::message, RPT_SEVERITY_WARNING, LOAD_MESSAGE::severity, and updateWarningUI().

Referenced by STATUSBAR_WARNING_REPORTER::Report().

◆ ClearWarningMessages()

void KISTATUSBAR::ClearWarningMessages ( const wxString & aSource = wxEmptyString )

Clears all warning messages from the given source (or all sources if aSource is empty)

Definition at line 530 of file kistatusbar.cpp.

References m_warningMessages, m_warningMutex, and updateWarningUI().

◆ fieldIndex()

std::optional< int > KISTATUSBAR::fieldIndex ( FIELD aField ) const

private

Definition at line 591 of file kistatusbar.cpp.

References BGJOB_CANCEL, BGJOB_GAUGE, BGJOB_LABEL, CANCEL_BUTTON, m_styleFlags, NOTIFICATION, NOTIFICATION_ICON, WARNING, and WARNING_ICON.

Referenced by layoutControls(), onBackgroundProgressClick(), onNotificationsIconClick(), updateAuxFieldWidths(), and updateBackgroundText().

◆ GetLoadWarningCount()

size_t KISTATUSBAR::GetLoadWarningCount ( ) const

Get current message count (thread-safe).

Definition at line 466 of file kistatusbar.cpp.

References m_warningMessages, and m_warningMutex.

◆ HideBackgroundProgressBar()

void KISTATUSBAR::HideBackgroundProgressBar ( )

Hide the background progress bar.

Definition at line 295 of file kistatusbar.cpp.

References m_backgroundProgressBar, m_backgroundStopButton, and updateAuxFieldWidths().

Referenced by KISTATUSBAR().

◆ layoutControls()

void KISTATUSBAR::layoutControls ( )

private

Definition at line 225 of file kistatusbar.cpp.

References BGJOB_GAUGE, BGJOB_LABEL, fieldIndex(), KIUI::GetTextSize(), m_backgroundProgressBar, m_backgroundStopButton, m_backgroundTxt, m_normalFieldsCount, m_notificationsButton, m_warningButton, NOTIFICATION, updateBackgroundText(), and WARNING.

Referenced by onSize(), and updateAuxFieldWidths().

◆ onBackgroundProgressClick()

void KISTATUSBAR::onBackgroundProgressClick ( wxMouseEvent & aEvent )

private

Definition at line 204 of file kistatusbar.cpp.

References BGJOB_GAUGE, fieldIndex(), PGM_BASE::GetBackgroundJobMonitor(), m_backgroundProgressBar, m_normalFieldsCount, Pgm(), and BACKGROUND_JOBS_MONITOR::ShowList().

Referenced by KISTATUSBAR(), and ~KISTATUSBAR().

◆ onLoadWarningsIconClick()

void KISTATUSBAR::onLoadWarningsIconClick ( wxCommandEvent & aEvent )

private

Definition at line 545 of file kistatusbar.cpp.

References WX_HTML_REPORT_BOX::Flush(), DIALOG_HTML_REPORTER::m_Reporter, m_warningMessages, m_warningMutex, WX_HTML_REPORT_BOX::Report(), and DIALOG_SHIM::ShowModal().

Referenced by KISTATUSBAR(), and ~KISTATUSBAR().

◆ onNotificationsIconClick()

void KISTATUSBAR::onNotificationsIconClick ( wxCommandEvent & aEvent )

private

Definition at line 188 of file kistatusbar.cpp.

References fieldIndex(), PGM_BASE::GetNotificationsManager(), m_normalFieldsCount, m_notificationsButton, NOTIFICATION, Pgm(), and NOTIFICATIONS_MANAGER::ShowList().

Referenced by KISTATUSBAR(), and ~KISTATUSBAR().

◆ onSize()

void KISTATUSBAR::onSize ( wxSizeEvent & aEvent )

private

Definition at line 219 of file kistatusbar.cpp.

References layoutControls().

Referenced by KISTATUSBAR(), and ~KISTATUSBAR().

◆ SetBackgroundProgress()

void KISTATUSBAR::SetBackgroundProgress ( int aAmount )

Set the current progress of the progress bar.

Definition at line 306 of file kistatusbar.cpp.

References m_backgroundProgressBar.

◆ SetBackgroundProgressMax()

void KISTATUSBAR::SetBackgroundProgressMax ( int aAmount )

Set the max progress of the progress bar.

Definition at line 317 of file kistatusbar.cpp.

References m_backgroundProgressBar.

◆ SetBackgroundStatusText()

void KISTATUSBAR::SetBackgroundStatusText ( const wxString & aTxt )

Set the status text that displays next to the progress bar.

Definition at line 323 of file kistatusbar.cpp.

References m_backgroundRawText, m_normalFieldsCount, m_savedStatusText, and updateBackgroundText().

◆ SetEllipsedTextField()

void KISTATUSBAR::SetEllipsedTextField	(	const wxString &	aText,
		int	aFieldId )

Set the text in a field using wxELLIPSIZE_MIDDLE option to adjust the text size to the field size.

Note: Unfortunately, setting the wxStatusBar style to wxELLIPSIZE_MIDDLE does not work.

Definition at line 567 of file kistatusbar.cpp.

References KIUI::GetTextSize().

Referenced by PROJECT_TREE_PANE::FileWatcherReset(), KICAD_MANAGER_FRAME::OnSize(), and KICAD_MANAGER_FRAME::PrintPrjInfo().

◆ SetNotificationCount()

void KISTATUSBAR::SetNotificationCount ( int aCount )

Set the notification count on the notifications button.

A value of 0 will hide the count.

Definition at line 405 of file kistatusbar.cpp.

References m_notificationsButton.

Referenced by NOTIFICATIONS_MANAGER::RegisterStatusBar().

◆ ShowBackgroundProgressBar()

void KISTATUSBAR::ShowBackgroundProgressBar ( bool aCancellable = false )

Show the background progress bar.

Definition at line 284 of file kistatusbar.cpp.

References m_backgroundProgressBar, m_backgroundStopButton, and updateAuxFieldWidths().

◆ updateAuxFieldWidths()

void KISTATUSBAR::updateAuxFieldWidths ( )

private

Definition at line 350 of file kistatusbar.cpp.

References BGJOB_CANCEL, BGJOB_GAUGE, BGJOB_LABEL, fieldIndex(), layoutControls(), m_backgroundStopButton, m_fieldWidths, m_normalFieldsCount, m_notificationsButton, m_warningButton, NOTIFICATION, updateBackgroundText(), and WARNING.

Referenced by HideBackgroundProgressBar(), ShowBackgroundProgressBar(), and updateWarningUI().

◆ updateBackgroundText()

void KISTATUSBAR::updateBackgroundText ( )

private

Definition at line 385 of file kistatusbar.cpp.

References BGJOB_LABEL, fieldIndex(), KIUI::GetTextSize(), m_backgroundRawText, m_backgroundTxt, m_normalFieldsCount, and text.

Referenced by layoutControls(), SetBackgroundStatusText(), and updateAuxFieldWidths().

◆ updateWarningUI()

void KISTATUSBAR::updateWarningUI ( )

private

Update warning button visibility and badge (main thread only)

Definition at line 479 of file kistatusbar.cpp.

References _, m_warningButton, m_warningMessages, m_warningMutex, traceLibraries, and updateAuxFieldWidths().

Referenced by AddWarningMessages(), AddWarningMessages(), and ClearWarningMessages().

Member Data Documentation

◆ DEFAULT_STYLE

auto KISTATUSBAR::DEFAULT_STYLE

staticconstexpr

Initial value:

=

static_cast<STYLE_FLAGS>( NOTIFICATION_ICON | CANCEL_BUTTON )

KISTATUSBAR::STYLE_FLAGS

STYLE_FLAGS

Definition kistatusbar.h:64

KISTATUSBAR::NOTIFICATION_ICON

@ NOTIFICATION_ICON

Definition kistatusbar.h:66

KISTATUSBAR::CANCEL_BUTTON

@ CANCEL_BUTTON

Definition kistatusbar.h:67

Definition at line 71 of file kistatusbar.h.

◆ m_backgroundProgressBar

wxGauge* KISTATUSBAR::m_backgroundProgressBar

private

Definition at line 163 of file kistatusbar.h.

Referenced by HideBackgroundProgressBar(), KISTATUSBAR(), layoutControls(), onBackgroundProgressClick(), SetBackgroundProgress(), SetBackgroundProgressMax(), ShowBackgroundProgressBar(), and ~KISTATUSBAR().

◆ m_backgroundRawText

wxString KISTATUSBAR::m_backgroundRawText

private

Unellipsized background status text.

Definition at line 173 of file kistatusbar.h.

Referenced by SetBackgroundStatusText(), and updateBackgroundText().

◆ m_backgroundStopButton

wxButton* KISTATUSBAR::m_backgroundStopButton

private

Definition at line 164 of file kistatusbar.h.

Referenced by HideBackgroundProgressBar(), KISTATUSBAR(), layoutControls(), ShowBackgroundProgressBar(), and updateAuxFieldWidths().

◆ m_backgroundTxt

wxStaticText* KISTATUSBAR::m_backgroundTxt

private

Definition at line 165 of file kistatusbar.h.

Referenced by KISTATUSBAR(), layoutControls(), and updateBackgroundText().

◆ m_fieldWidths

std::vector<int> KISTATUSBAR::m_fieldWidths

private

Definition at line 174 of file kistatusbar.h.

Referenced by KISTATUSBAR(), and updateAuxFieldWidths().

◆ m_normalFieldsCount

int KISTATUSBAR::m_normalFieldsCount

private

Definition at line 170 of file kistatusbar.h.

Referenced by KISTATUSBAR(), layoutControls(), onBackgroundProgressClick(), onNotificationsIconClick(), SetBackgroundStatusText(), updateAuxFieldWidths(), and updateBackgroundText().

◆ m_notificationsButton

BITMAP_BUTTON* KISTATUSBAR::m_notificationsButton

private

Definition at line 166 of file kistatusbar.h.

Referenced by KISTATUSBAR(), layoutControls(), onNotificationsIconClick(), SetNotificationCount(), updateAuxFieldWidths(), and ~KISTATUSBAR().

◆ m_savedStatusText

wxString KISTATUSBAR::m_savedStatusText

private

Saved text from adjacent field during background jobs.

Definition at line 172 of file kistatusbar.h.

Referenced by SetBackgroundStatusText().

◆ m_styleFlags

STYLE_FLAGS KISTATUSBAR::m_styleFlags

private

Definition at line 171 of file kistatusbar.h.

Referenced by fieldIndex(), and KISTATUSBAR().

◆ m_warningButton

BITMAP_BUTTON* KISTATUSBAR::m_warningButton

private

Definition at line 167 of file kistatusbar.h.

Referenced by KISTATUSBAR(), layoutControls(), updateAuxFieldWidths(), updateWarningUI(), and ~KISTATUSBAR().

◆ m_warningMessages

std::unordered_map<wxString, std::vector<LOAD_MESSAGE> > KISTATUSBAR::m_warningMessages

private

Definition at line 169 of file kistatusbar.h.

Referenced by AddWarningMessages(), AddWarningMessages(), ClearWarningMessages(), GetLoadWarningCount(), onLoadWarningsIconClick(), and updateWarningUI().

◆ m_warningMutex

std::mutex KISTATUSBAR::m_warningMutex

mutableprivate

Protects m_warningMessages.

Definition at line 168 of file kistatusbar.h.

Referenced by AddWarningMessages(), AddWarningMessages(), ClearWarningMessages(), GetLoadWarningCount(), onLoadWarningsIconClick(), and updateWarningUI().

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

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ FIELD

◆ STYLE_FLAGS

Constructor & Destructor Documentation

◆ KISTATUSBAR()

◆ ~KISTATUSBAR()

Member Function Documentation

◆ AddWarningMessages() [1/2]

◆ AddWarningMessages() [2/2]

◆ ClearWarningMessages()

◆ fieldIndex()

◆ GetLoadWarningCount()

◆ HideBackgroundProgressBar()

◆ layoutControls()

◆ onBackgroundProgressClick()

◆ onLoadWarningsIconClick()

◆ onNotificationsIconClick()

◆ onSize()

◆ SetBackgroundProgress()

◆ SetBackgroundProgressMax()

◆ SetBackgroundStatusText()

◆ SetEllipsedTextField()

◆ SetNotificationCount()

◆ ShowBackgroundProgressBar()

◆ updateAuxFieldWidths()

◆ updateBackgroundText()

◆ updateWarningUI()

Member Data Documentation

◆ DEFAULT_STYLE

◆ m_backgroundProgressBar

◆ m_backgroundRawText

◆ m_backgroundStopButton

◆ m_backgroundTxt

◆ m_fieldWidths

◆ m_normalFieldsCount

◆ m_notificationsButton

◆ m_savedStatusText

◆ m_styleFlags

◆ m_warningButton

◆ m_warningMessages

◆ m_warningMutex