KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
KISTATUSBAR Class Reference

KISTATUSBAR is a wxStatusBar suitable for Kicad manager. More...

#include <kistatusbar.h>

Inheritance diagram for KISTATUSBAR:

Public Types

enum  STYLE_FLAGS : int { NONE_STYLE = 0x00 , NOTIFICATION_ICON = 0x01 , CANCEL_BUTTON = 0x02 }
 

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.
 

Static Public Attributes

static constexpr auto DEFAULT_STYLE
 

Private Types

enum class  FIELD { BGJOB_LABEL , BGJOB_GAUGE , BGJOB_CANCEL , NOTIFICATION }
 

Private Member Functions

void onSize (wxSizeEvent &aEvent)
 
void onBackgroundProgressClick (wxMouseEvent &aEvent)
 
void onNotificationsIconClick (wxCommandEvent &aEvent)
 
std::optional< int > fieldIndex (FIELD aField) const
 

Private Attributes

wxGauge * m_backgroundProgressBar
 
wxButton * m_backgroundStopButton
 
wxStaticText * m_backgroundTxt
 
BITMAP_BUTTON * m_notificationsButton
 
int m_normalFieldsCount
 
STYLE_FLAGS m_styleFlags
 

Detailed Description

KISTATUSBAR is a wxStatusBar suitable for Kicad manager.

It displays the fields needed by the caller, and room for 4 other fields (see kistatusbar.cpp) Background text (FIELD_OFFSET_BGJOB_TEXT offset id) Background gauge widget (FIELD_OFFSET_BGJOB_GAUGE offset id) Background background stop button (FIELD_OFFSET_BGJOB_CANCEL offset id) Background notifications button (FIELD_OFFSET_NOTIFICATION_BUTTON offset id)

Definition at line 45 of file kistatusbar.h.

Member Enumeration Documentation

◆ FIELD

enum class KISTATUSBAR::FIELD
strongprivate
Enumerator
BGJOB_LABEL 
BGJOB_GAUGE 
BGJOB_CANCEL 
NOTIFICATION 

Definition at line 108 of file kistatusbar.h.

◆ STYLE_FLAGS

enum KISTATUSBAR::STYLE_FLAGS : int
Enumerator
NONE_STYLE 
NOTIFICATION_ICON 
CANCEL_BUTTON 

Definition at line 48 of file kistatusbar.h.

Constructor & Destructor Documentation

◆ KISTATUSBAR()

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

Definition at line 41 of file kistatusbar.cpp.

References BGJOB_CANCEL, BGJOB_GAUGE, BGJOB_LABEL, CANCEL_BUTTON, fieldIndex(), HideBackgroundProgressBar(), KiBitmapBundle(), m_backgroundProgressBar, m_backgroundStopButton, m_backgroundTxt, m_normalFieldsCount, m_notificationsButton, m_styleFlags, NOTIFICATION, NOTIFICATION_ICON, notifications, onBackgroundProgressClick(), onNotificationsIconClick(), and onSize().

◆ ~KISTATUSBAR()

KISTATUSBAR::~KISTATUSBAR ( )

Definition at line 133 of file kistatusbar.cpp.

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

Member Function Documentation

◆ fieldIndex()

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

Definition at line 290 of file kistatusbar.cpp.

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

Referenced by KISTATUSBAR(), and onSize().

◆ HideBackgroundProgressBar()

void KISTATUSBAR::HideBackgroundProgressBar ( )

Hide the background progress bar.

Definition at line 224 of file kistatusbar.cpp.

References m_backgroundProgressBar, and m_backgroundStopButton.

Referenced by KISTATUSBAR().

◆ onBackgroundProgressClick()

void KISTATUSBAR::onBackgroundProgressClick ( wxMouseEvent & aEvent)
private

Definition at line 157 of file kistatusbar.cpp.

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

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

◆ onNotificationsIconClick()

void KISTATUSBAR::onNotificationsIconClick ( wxCommandEvent & aEvent)
private

Definition at line 144 of file kistatusbar.cpp.

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

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

◆ onSize()

void KISTATUSBAR::onSize ( wxSizeEvent & aEvent)
private

Definition at line 169 of file kistatusbar.cpp.

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

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

◆ SetBackgroundProgress()

void KISTATUSBAR::SetBackgroundProgress ( int aAmount)

Set the current progress of the progress bar.

Definition at line 233 of file kistatusbar.cpp.

References m_backgroundProgressBar.

◆ SetBackgroundProgressMax()

void KISTATUSBAR::SetBackgroundProgressMax ( int aAmount)

Set the max progress of the progress bar.

Definition at line 239 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 245 of file kistatusbar.cpp.

References m_backgroundTxt.

◆ 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 266 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 251 of file kistatusbar.cpp.

References m_notificationsButton, and Refresh().

Referenced by NOTIFICATIONS_MANAGER::RegisterStatusBar().

◆ ShowBackgroundProgressBar()

void KISTATUSBAR::ShowBackgroundProgressBar ( bool aCancellable = false)

Show the background progress bar.

Definition at line 215 of file kistatusbar.cpp.

References m_backgroundProgressBar, and m_backgroundStopButton.

Member Data Documentation

◆ DEFAULT_STYLE

auto KISTATUSBAR::DEFAULT_STYLE
staticconstexpr
Initial value:
=
static_cast<STYLE_FLAGS>( NOTIFICATION_ICON | CANCEL_BUTTON )

Definition at line 55 of file kistatusbar.h.

◆ m_backgroundProgressBar

wxGauge* KISTATUSBAR::m_backgroundProgressBar
private

Definition at line 119 of file kistatusbar.h.

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

◆ m_backgroundStopButton

wxButton* KISTATUSBAR::m_backgroundStopButton
private

Definition at line 120 of file kistatusbar.h.

Referenced by HideBackgroundProgressBar(), KISTATUSBAR(), onSize(), and ShowBackgroundProgressBar().

◆ m_backgroundTxt

wxStaticText* KISTATUSBAR::m_backgroundTxt
private

Definition at line 121 of file kistatusbar.h.

Referenced by KISTATUSBAR(), onSize(), and SetBackgroundStatusText().

◆ m_normalFieldsCount

int KISTATUSBAR::m_normalFieldsCount
private

Definition at line 123 of file kistatusbar.h.

Referenced by KISTATUSBAR(), onBackgroundProgressClick(), onNotificationsIconClick(), and onSize().

◆ m_notificationsButton

BITMAP_BUTTON* KISTATUSBAR::m_notificationsButton
private

Definition at line 122 of file kistatusbar.h.

Referenced by KISTATUSBAR(), onNotificationsIconClick(), onSize(), SetNotificationCount(), and ~KISTATUSBAR().

◆ m_styleFlags

STYLE_FLAGS KISTATUSBAR::m_styleFlags
private

Definition at line 124 of file kistatusbar.h.

Referenced by fieldIndex(), and KISTATUSBAR().

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