KiCad PCB EDA Suite: PANEL_PACKAGE Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <panel_package.h>

Inheritance diagram for PANEL_PACKAGE:

Public Member Functions
	PANEL_PACKAGE (wxWindow *parent, const ActionCallback &aCallback, const PinCallback &aPinCallback, const PACKAGE_VIEW_DATA &aData)
	Sets callback for OnClick action.

void	SetSelectCallback (const std::function< void()> &aCallback)
	Marks panel as selected.

void	SetSelected (bool aSelected)

void	OnButtonClicked (wxCommandEvent &event) override
	Changes state of the (un)install button.

void	SetState (PCM_PACKAGE_STATE aState, bool aPinned)
	Called when anywhere on the panel is clicked (except install button)

void	OnClick (wxMouseEvent &event) override

void	OnUninstallClick (wxCommandEvent &event)

void	OnPinVersionClick (wxCommandEvent &event)

void	OnSize (wxSizeEvent &event) override
	Get preferred version. If criteria are not met, return wxEmptyString.

wxString	GetPreferredVersion () const

const PACKAGE_VIEW_DATA &	GetPackageData () const

Protected Attributes
wxStaticBitmap *	m_bitmap

wxStaticText *	m_name

wxBoxSizer *	m_descSizer

wxStaticText *	m_desc

wxButton *	m_button

SPLIT_BUTTON *	m_splitButton

Private Member Functions
void	OnPaint (wxPaintEvent &event) override

Private Attributes
wxMenuItem *	m_pinVersionMenuItem

wxMenuItem *	m_actionMenuItem

std::function< void()>	m_selectCallback

bool	m_selected = false

const ActionCallback &	m_actionCallback

const PinCallback &	m_pinCallback

PACKAGE_VIEW_DATA	m_data

int	m_minHeight

Detailed Description

Definition at line 63 of file panel_package.h.

Constructor & Destructor Documentation

◆ PANEL_PACKAGE()

PANEL_PACKAGE::PANEL_PACKAGE	(	wxWindow *	parent,
		const ActionCallback &	aCallback,
		const PinCallback &	aPinCallback,
		const PACKAGE_VIEW_DATA &	aData )

Sets callback for OnClick action.

Definition at line 26 of file panel_package.cpp.

References _, KiROUND(), m_actionCallback, m_actionMenuItem, PANEL_PACKAGE_BASE::m_bitmap, m_data, PANEL_PACKAGE_BASE::m_desc, PANEL_PACKAGE_BASE::m_descSizer, m_minHeight, PANEL_PACKAGE_BASE::m_name, m_pinCallback, m_pinVersionMenuItem, PANEL_PACKAGE_BASE::m_splitButton, minSize, OnButtonClicked(), OnClick(), OnPinVersionClick(), PANEL_PACKAGE_BASE::PANEL_PACKAGE_BASE(), and SetState().

Member Function Documentation

◆ GetPackageData()

const PACKAGE_VIEW_DATA & PANEL_PACKAGE::GetPackageData ( ) const

inline

Definition at line 92 of file panel_package.h.

References m_data.

Referenced by PANEL_PACKAGES_VIEW::SetData().

◆ GetPreferredVersion()

wxString PANEL_PACKAGE::GetPreferredVersion ( ) const

Definition at line 264 of file panel_package.cpp.

References m_data.

Referenced by OnButtonClicked().

◆ OnButtonClicked()

void PANEL_PACKAGE::OnButtonClicked ( wxCommandEvent & event )

overridevirtual

Changes state of the (un)install button.

Reimplemented from PANEL_PACKAGE_BASE.

Definition at line 183 of file panel_package.cpp.

References GetPreferredVersion(), m_actionCallback, m_data, PPA_INSTALL, PPA_UNINSTALL, PPA_UPDATE, PPS_AVAILABLE, and PPS_UPDATE_AVAILABLE.

Referenced by PANEL_PACKAGE(), and SetState().

◆ OnClick()

void PANEL_PACKAGE::OnClick ( wxMouseEvent & event )

overridevirtual

Reimplemented from PANEL_PACKAGE_BASE.

Definition at line 234 of file panel_package.cpp.

References m_selectCallback.

Referenced by PANEL_PACKAGE(), and PANEL_PACKAGES_VIEW::updatePackageList().

◆ OnPaint()

void PANEL_PACKAGE::OnPaint ( wxPaintEvent & event )

overrideprivatevirtual

Reimplemented from PANEL_PACKAGE_BASE.

Definition at line 240 of file panel_package.cpp.

References m_selected.

◆ OnPinVersionClick()

void PANEL_PACKAGE::OnPinVersionClick ( wxCommandEvent & event )

Definition at line 205 of file panel_package.cpp.

References m_data, and m_pinCallback.

Referenced by PANEL_PACKAGE().

◆ OnSize()

void PANEL_PACKAGE::OnSize ( wxSizeEvent & event )

overridevirtual

Get preferred version. If criteria are not met, return wxEmptyString.

Reimplemented from PANEL_PACKAGE_BASE.

Definition at line 84 of file panel_package.cpp.

References KiROUND(), m_data, PANEL_PACKAGE_BASE::m_desc, PANEL_PACKAGE_BASE::m_descSizer, m_minHeight, PANEL_PACKAGE_BASE::m_name, and minSize.

◆ OnUninstallClick()

void PANEL_PACKAGE::OnUninstallClick ( wxCommandEvent & event )

Definition at line 213 of file panel_package.cpp.

References m_actionCallback, m_data, PPA_UNINSTALL, and PPS_UPDATE_AVAILABLE.

Referenced by SetState().

◆ SetSelectCallback()

void PANEL_PACKAGE::SetSelectCallback ( const std::function< void()> & aCallback )

Marks panel as selected.

Definition at line 228 of file panel_package.cpp.

References m_selectCallback.

Referenced by PANEL_PACKAGES_VIEW::SetData().

◆ SetSelected()

void PANEL_PACKAGE::SetSelected ( bool aSelected )

Definition at line 257 of file panel_package.cpp.

References m_selected, and Refresh().

Referenced by PANEL_PACKAGES_VIEW::SetData().

◆ SetState()

void PANEL_PACKAGE::SetState	(	PCM_PACKAGE_STATE	aState,
		bool	aPinned )

Called when anywhere on the panel is clicked (except install button)

Definition at line 100 of file panel_package.cpp.

References _, m_actionMenuItem, PANEL_PACKAGE_BASE::m_button, m_data, m_pinVersionMenuItem, PANEL_PACKAGE_BASE::m_splitButton, OnButtonClicked(), OnUninstallClick(), PPS_AVAILABLE, PPS_INSTALLED, PPS_PENDING_INSTALL, PPS_PENDING_UNINSTALL, PPS_PENDING_UPDATE, PPS_UNAVAILABLE, and PPS_UPDATE_AVAILABLE.

Referenced by PANEL_PACKAGE().

Member Data Documentation

◆ m_actionCallback

const ActionCallback& PANEL_PACKAGE::m_actionCallback

private

Definition at line 102 of file panel_package.h.

Referenced by OnButtonClicked(), OnUninstallClick(), and PANEL_PACKAGE().

◆ m_actionMenuItem

wxMenuItem* PANEL_PACKAGE::m_actionMenuItem

private

Definition at line 99 of file panel_package.h.

Referenced by PANEL_PACKAGE(), and SetState().

◆ m_bitmap

wxStaticBitmap* PANEL_PACKAGE_BASE::m_bitmap

protectedinherited

Definition at line 39 of file panel_package_base.h.

Referenced by PANEL_PACKAGE::PANEL_PACKAGE(), and PANEL_PACKAGE_BASE().

◆ m_button

wxButton* PANEL_PACKAGE_BASE::m_button

protectedinherited

Definition at line 43 of file panel_package_base.h.

Referenced by PANEL_PACKAGE_BASE(), PANEL_PACKAGE::SetState(), and ~PANEL_PACKAGE_BASE().

◆ m_data

PACKAGE_VIEW_DATA PANEL_PACKAGE::m_data

private

Definition at line 104 of file panel_package.h.

Referenced by GetPackageData(), GetPreferredVersion(), OnButtonClicked(), OnPinVersionClick(), OnSize(), OnUninstallClick(), PANEL_PACKAGE(), and SetState().

◆ m_desc

wxStaticText* PANEL_PACKAGE_BASE::m_desc

protectedinherited

Definition at line 42 of file panel_package_base.h.

Referenced by PANEL_PACKAGE::OnSize(), PANEL_PACKAGE::PANEL_PACKAGE(), and PANEL_PACKAGE_BASE().

◆ m_descSizer

wxBoxSizer* PANEL_PACKAGE_BASE::m_descSizer

protectedinherited

Definition at line 41 of file panel_package_base.h.

Referenced by PANEL_PACKAGE::OnSize(), PANEL_PACKAGE::PANEL_PACKAGE(), and PANEL_PACKAGE_BASE().

◆ m_minHeight

int PANEL_PACKAGE::m_minHeight

private

Definition at line 105 of file panel_package.h.

Referenced by OnSize(), and PANEL_PACKAGE().

◆ m_name

wxStaticText* PANEL_PACKAGE_BASE::m_name

protectedinherited

Definition at line 40 of file panel_package_base.h.

Referenced by PANEL_PACKAGE::OnSize(), PANEL_PACKAGE::PANEL_PACKAGE(), and PANEL_PACKAGE_BASE().

◆ m_pinCallback

const PinCallback& PANEL_PACKAGE::m_pinCallback

private

Definition at line 103 of file panel_package.h.

Referenced by OnPinVersionClick(), and PANEL_PACKAGE().

◆ m_pinVersionMenuItem

wxMenuItem* PANEL_PACKAGE::m_pinVersionMenuItem

private

Definition at line 98 of file panel_package.h.

Referenced by PANEL_PACKAGE(), and SetState().

◆ m_selectCallback

std::function<void()> PANEL_PACKAGE::m_selectCallback

private

Definition at line 100 of file panel_package.h.

Referenced by OnClick(), and SetSelectCallback().

◆ m_selected

bool PANEL_PACKAGE::m_selected = false

private

Definition at line 101 of file panel_package.h.

Referenced by OnPaint(), and SetSelected().

◆ m_splitButton

SPLIT_BUTTON* PANEL_PACKAGE_BASE::m_splitButton

protectedinherited

Definition at line 44 of file panel_package_base.h.

Referenced by PANEL_PACKAGE::PANEL_PACKAGE(), PANEL_PACKAGE_BASE(), and PANEL_PACKAGE::SetState().

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

PANEL_PACKAGE
Generated on Tue Nov 4 2025 00:07:11 for KiCad PCB EDA Suite by 1.13.2