PANEL_SETUP_NET_CHAINS Class Reference

Schematic-Setup tab for managing committed net chains. More...

#include <panel_setup_net_chains.h>

Inheritance diagram for PANEL_SETUP_NET_CHAINS:

Classes
struct	CHAIN_ROW
struct	CLASS_ROW

Public Member Functions
	PANEL_SETUP_NET_CHAINS (wxWindow *aParent, SCH_EDIT_FRAME *aFrame)
	~PANEL_SETUP_NET_CHAINS () override
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
bool	Validate () override
bool	ApplyEdits ()
void	m_chainsSplitterOnIdle (wxIdleEvent &)

Protected Member Functions
void	OnDeleteChainClicked (wxCommandEvent &aEvent) override
void	OnChainGridSelectionChanged (wxGridEvent &aEvent) override
void	OnClassAddClicked (wxCommandEvent &aEvent) override
void	OnClassRenameClicked (wxCommandEvent &aEvent) override
void	OnClassDeleteClicked (wxCommandEvent &aEvent) override

Protected Attributes
wxNotebook *	m_notebook
wxPanel *	m_chainsTab
wxStaticText *	m_chainsHeader
wxSplitterWindow *	m_chainsSplitter
wxPanel *	m_chainsGridPanel
WX_GRID *	m_chainsGrid
wxPanel *	m_membersPanel
wxStaticText *	m_membersLabel
wxListBox *	m_membersListBox
STD_BITMAP_BUTTON *	m_deleteChainButton
wxPanel *	m_classesTab
wxStaticText *	m_classesHeader
WX_GRID *	m_classesGrid
STD_BITMAP_BUTTON *	m_addClassButton
STD_BITMAP_BUTTON *	m_renameClassButton
STD_BITMAP_BUTTON *	m_deleteClassButton

Private Types
enum	CHAIN_COL {   COL_NAME = 0 , COL_MEMBERS , COL_CHAIN_CLASS , COL_NET_CLASS ,   COL_COLOUR }
enum	CLASS_COL { CLASS_COL_NAME = 0 , CLASS_COL_MEMBERS }

Private Member Functions
void	loadFromModel ()
void	rebuildChainsGrid ()
void	rebuildClassesGrid ()
void	refreshChainClassDropdownChoices ()
void	refreshNetClassDropdownChoices ()
int	selectedChainRow () const
int	selectedClassRow () const
bool	nameInChainGridAlready (const wxString &aName, int aExceptRow) const
bool	nameInClassGridAlready (const wxString &aName, int aExceptRow) const
void	updateMembersDetail (int aRow)

Private Attributes
SCH_EDIT_FRAME *	m_frame
std::vector< CHAIN_ROW >	m_chainRows
std::vector< int >	m_gridToChainIdx
std::vector< CLASS_ROW >	m_classRows

Detailed Description

Schematic-Setup tab for managing committed net chains.

All edits are buffered in m_chainRows / m_classRows so that pressing Cancel in the parent dialog leaves the live model untouched. TransferDataFromWindow applies them in dependency order:

1. Rename committed chains (via RenameCommittedNetChain)
2. Update colour / netclass override on each committed chain
3. Apply chain-class assignments to NET_SETTINGS::m_netChainClasses
4. Delete committed chains (via DeleteCommittedNetChain)
5. Reconcile the chain-class master list against tab 2's edits

Definition at line 48 of file panel_setup_net_chains.h.

Member Enumeration Documentation

CHAIN_COL

enum PANEL_SETUP_NET_CHAINS::CHAIN_COL

private

Enumerator
COL_NAME
COL_MEMBERS
COL_CHAIN_CLASS
COL_NET_CLASS
COL_COLOUR

Definition at line 69 of file panel_setup_net_chains.h.

CLASS_COL

enum PANEL_SETUP_NET_CHAINS::CLASS_COL

private

Enumerator
CLASS_COL_NAME
CLASS_COL_MEMBERS

Definition at line 78 of file panel_setup_net_chains.h.

Constructor & Destructor Documentation

PANEL_SETUP_NET_CHAINS()

PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS	(	wxWindow *	aParent,
		SCH_EDIT_FRAME *	aFrame )

Definition at line 52 of file panel_setup_net_chains.cpp.

References _, CLASS_COL_MEMBERS, COL_COLOUR, COL_MEMBERS, COL_NAME, PAGED_DIALOG::GetDialog(), SCH_NETCHAIN::IsValidName(), KiBitmapBundle(), PANEL_SETUP_NET_CHAINS_BASE::m_addClassButton, m_chainRows, PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid, PANEL_SETUP_NET_CHAINS_BASE::m_classesGrid, PANEL_SETUP_NET_CHAINS_BASE::m_deleteChainButton, PANEL_SETUP_NET_CHAINS_BASE::m_deleteClassButton, m_frame, m_gridToChainIdx, PANEL_SETUP_NET_CHAINS_BASE::m_renameClassButton, PANEL_SETUP_NET_CHAINS_BASE::PANEL_SETUP_NET_CHAINS_BASE(), small_edit, small_plus, and small_trash.

~PANEL_SETUP_NET_CHAINS()

PANEL_SETUP_NET_CHAINS::~PANEL_SETUP_NET_CHAINS ( )

override

Definition at line 105 of file panel_setup_net_chains.cpp.

Member Function Documentation

ApplyEdits()

bool PANEL_SETUP_NET_CHAINS::ApplyEdits

(

)

Definition at line 410 of file panel_setup_net_chains.cpp.

References CONNECTION_GRAPH::DeleteCommittedNetChain(), m_chainRows, m_classRows, m_frame, and CONNECTION_GRAPH::RenameCommittedNetChain().

Referenced by TransferDataFromWindow().

loadFromModel()

void PANEL_SETUP_NET_CHAINS::loadFromModel ( )

private

Definition at line 110 of file panel_setup_net_chains.cpp.

References chain, CONNECTION_GRAPH::GetCommittedNetChains(), PANEL_SETUP_NET_CHAINS::CHAIN_ROW::livePtr, m_chainRows, m_classRows, m_frame, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::memberNets, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newChainClass, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newColor, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newName, PANEL_SETUP_NET_CHAINS::CLASS_ROW::newName, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newNetClass, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::origName, and PANEL_SETUP_NET_CHAINS::CLASS_ROW::origName.

Referenced by TransferDataToWindow().

m_chainsSplitterOnIdle()

void PANEL_SETUP_NET_CHAINS_BASE::m_chainsSplitterOnIdle ( wxIdleEvent & )

inlineinherited

Definition at line 75 of file panel_setup_net_chains_base.h.

References m_chainsSplitter, and m_chainsSplitterOnIdle().

Referenced by m_chainsSplitterOnIdle(), and PANEL_SETUP_NET_CHAINS_BASE().

nameInChainGridAlready()

bool PANEL_SETUP_NET_CHAINS::nameInChainGridAlready ( const wxString & aName, int aExceptRow ) const

private

Definition at line 573 of file panel_setup_net_chains.cpp.

References m_chainRows.

Referenced by Validate().

nameInClassGridAlready()

bool PANEL_SETUP_NET_CHAINS::nameInClassGridAlready ( const wxString & aName, int aExceptRow ) const

private

Definition at line 591 of file panel_setup_net_chains.cpp.

References m_classRows.

Referenced by OnClassAddClicked(), OnClassRenameClicked(), and Validate().

OnChainGridSelectionChanged()

void PANEL_SETUP_NET_CHAINS::OnChainGridSelectionChanged ( wxGridEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_SETUP_NET_CHAINS_BASE.

Definition at line 630 of file panel_setup_net_chains.cpp.

References m_gridToChainIdx, and updateMembersDetail().

OnClassAddClicked()

void PANEL_SETUP_NET_CHAINS::OnClassAddClicked ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_SETUP_NET_CHAINS_BASE.

Definition at line 670 of file panel_setup_net_chains.cpp.

References _, m_classRows, name, nameInClassGridAlready(), PANEL_SETUP_NET_CHAINS::CLASS_ROW::newName, PANEL_SETUP_NET_CHAINS::CLASS_ROW::origName, rebuildClassesGrid(), and refreshChainClassDropdownChoices().

OnClassDeleteClicked()

void PANEL_SETUP_NET_CHAINS::OnClassDeleteClicked ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_SETUP_NET_CHAINS_BASE.

Definition at line 735 of file panel_setup_net_chains.cpp.

References _, PANEL_SETUP_NET_CHAINS::CLASS_ROW::deletePending, m_chainRows, m_classRows, PANEL_SETUP_NET_CHAINS::CLASS_ROW::newName, rebuildChainsGrid(), rebuildClassesGrid(), refreshChainClassDropdownChoices(), and selectedClassRow().

OnClassRenameClicked()

void PANEL_SETUP_NET_CHAINS::OnClassRenameClicked ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_SETUP_NET_CHAINS_BASE.

Definition at line 696 of file panel_setup_net_chains.cpp.

References _, m_chainRows, m_classRows, name, nameInClassGridAlready(), PANEL_SETUP_NET_CHAINS::CLASS_ROW::newName, rebuildChainsGrid(), rebuildClassesGrid(), refreshChainClassDropdownChoices(), and selectedClassRow().

OnDeleteChainClicked()

void PANEL_SETUP_NET_CHAINS::OnDeleteChainClicked ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_SETUP_NET_CHAINS_BASE.

Definition at line 609 of file panel_setup_net_chains.cpp.

References _, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::deletePending, m_chainRows, m_gridToChainIdx, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newName, rebuildChainsGrid(), rebuildClassesGrid(), and selectedChainRow().

rebuildChainsGrid()

void PANEL_SETUP_NET_CHAINS::rebuildChainsGrid ( )

private

Definition at line 208 of file panel_setup_net_chains.cpp.

References _, COL_CHAIN_CLASS, COL_COLOUR, COL_MEMBERS, COL_NAME, COL_NET_CLASS, m_chainRows, PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid, PANEL_SETUP_NET_CHAINS_BASE::m_chainsHeader, m_gridToChainIdx, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::memberNets, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newChainClass, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newColor, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newName, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newNetClass, refreshChainClassDropdownChoices(), refreshNetClassDropdownChoices(), selectedChainRow(), KIGFX::COLOR4D::ToCSSString(), KIGFX::COLOR4D::UNSPECIFIED, and updateMembersDetail().

Referenced by OnClassDeleteClicked(), OnClassRenameClicked(), OnDeleteChainClicked(), and TransferDataToWindow().

rebuildClassesGrid()

void PANEL_SETUP_NET_CHAINS::rebuildClassesGrid ( )

private

Definition at line 257 of file panel_setup_net_chains.cpp.

References CLASS_COL_MEMBERS, CLASS_COL_NAME, PANEL_SETUP_NET_CHAINS::CLASS_ROW::deletePending, m_chainRows, PANEL_SETUP_NET_CHAINS_BASE::m_classesGrid, m_classRows, and PANEL_SETUP_NET_CHAINS::CLASS_ROW::newName.

Referenced by OnClassAddClicked(), OnClassDeleteClicked(), OnClassRenameClicked(), OnDeleteChainClicked(), and TransferDataToWindow().

refreshChainClassDropdownChoices()

void PANEL_SETUP_NET_CHAINS::refreshChainClassDropdownChoices ( )

private

Definition at line 169 of file panel_setup_net_chains.cpp.

References COL_CHAIN_CLASS, PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid, and m_classRows.

Referenced by OnClassAddClicked(), OnClassDeleteClicked(), OnClassRenameClicked(), and rebuildChainsGrid().

refreshNetClassDropdownChoices()

void PANEL_SETUP_NET_CHAINS::refreshNetClassDropdownChoices ( )

private

Definition at line 186 of file panel_setup_net_chains.cpp.

References COL_NET_CLASS, PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid, m_frame, and name.

Referenced by rebuildChainsGrid().

selectedChainRow()

int PANEL_SETUP_NET_CHAINS::selectedChainRow ( ) const

private

Definition at line 536 of file panel_setup_net_chains.cpp.

References cursor, and PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid.

Referenced by OnDeleteChainClicked(), and rebuildChainsGrid().

selectedClassRow()

int PANEL_SETUP_NET_CHAINS::selectedClassRow ( ) const

private

Definition at line 555 of file panel_setup_net_chains.cpp.

References cursor, and PANEL_SETUP_NET_CHAINS_BASE::m_classesGrid.

Referenced by OnClassDeleteClicked(), and OnClassRenameClicked().

TransferDataFromWindow()

bool PANEL_SETUP_NET_CHAINS::TransferDataFromWindow ( )

override

Definition at line 401 of file panel_setup_net_chains.cpp.

References ApplyEdits(), and Validate().

TransferDataToWindow()

bool PANEL_SETUP_NET_CHAINS::TransferDataToWindow ( )

override

Definition at line 295 of file panel_setup_net_chains.cpp.

References loadFromModel(), rebuildChainsGrid(), and rebuildClassesGrid().

updateMembersDetail()

void PANEL_SETUP_NET_CHAINS::updateMembersDetail ( int aRow )

private

Definition at line 640 of file panel_setup_net_chains.cpp.

References _, m_chainRows, PANEL_SETUP_NET_CHAINS_BASE::m_membersLabel, PANEL_SETUP_NET_CHAINS_BASE::m_membersListBox, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::memberNets, and PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newName.

Referenced by OnChainGridSelectionChanged(), and rebuildChainsGrid().

Validate()

bool PANEL_SETUP_NET_CHAINS::Validate ( )

override

Definition at line 304 of file panel_setup_net_chains.cpp.

References _, CLASS_COL_NAME, COL_CHAIN_CLASS, COL_COLOUR, COL_NAME, COL_NET_CLASS, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::deletePending, PANEL_SETUP_NET_CHAINS::CLASS_ROW::deletePending, SCH_NETCHAIN::IsValidName(), m_chainRows, PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid, PANEL_SETUP_NET_CHAINS_BASE::m_classesGrid, m_classRows, m_gridToChainIdx, nameInChainGridAlready(), nameInClassGridAlready(), PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newChainClass, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newColor, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newName, PANEL_SETUP_NET_CHAINS::CLASS_ROW::newName, PANEL_SETUP_NET_CHAINS::CHAIN_ROW::newNetClass, and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by TransferDataFromWindow().

Member Data Documentation

m_addClassButton

STD_BITMAP_BUTTON* PANEL_SETUP_NET_CHAINS_BASE::m_addClassButton

protectedinherited

Definition at line 57 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS(), PANEL_SETUP_NET_CHAINS_BASE(), and ~PANEL_SETUP_NET_CHAINS_BASE().

m_chainRows

std::vector<CHAIN_ROW> PANEL_SETUP_NET_CHAINS::m_chainRows

private

Definition at line 118 of file panel_setup_net_chains.h.

Referenced by ApplyEdits(), loadFromModel(), nameInChainGridAlready(), OnClassDeleteClicked(), OnClassRenameClicked(), OnDeleteChainClicked(), PANEL_SETUP_NET_CHAINS(), rebuildChainsGrid(), rebuildClassesGrid(), updateMembersDetail(), and Validate().

m_chainsGrid

WX_GRID* PANEL_SETUP_NET_CHAINS_BASE::m_chainsGrid

protectedinherited

Definition at line 49 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS(), PANEL_SETUP_NET_CHAINS_BASE(), PANEL_SETUP_NET_CHAINS::rebuildChainsGrid(), PANEL_SETUP_NET_CHAINS::refreshChainClassDropdownChoices(), PANEL_SETUP_NET_CHAINS::refreshNetClassDropdownChoices(), PANEL_SETUP_NET_CHAINS::selectedChainRow(), PANEL_SETUP_NET_CHAINS::Validate(), and ~PANEL_SETUP_NET_CHAINS_BASE().

m_chainsGridPanel

wxPanel* PANEL_SETUP_NET_CHAINS_BASE::m_chainsGridPanel

protectedinherited

Definition at line 48 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE().

m_chainsHeader

wxStaticText* PANEL_SETUP_NET_CHAINS_BASE::m_chainsHeader

protectedinherited

Definition at line 46 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE(), and PANEL_SETUP_NET_CHAINS::rebuildChainsGrid().

m_chainsSplitter

wxSplitterWindow* PANEL_SETUP_NET_CHAINS_BASE::m_chainsSplitter

protectedinherited

Definition at line 47 of file panel_setup_net_chains_base.h.

Referenced by m_chainsSplitterOnIdle(), and PANEL_SETUP_NET_CHAINS_BASE().

m_chainsTab

wxPanel* PANEL_SETUP_NET_CHAINS_BASE::m_chainsTab

protectedinherited

Definition at line 45 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE().

m_classesGrid

WX_GRID* PANEL_SETUP_NET_CHAINS_BASE::m_classesGrid

protectedinherited

Definition at line 56 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS(), PANEL_SETUP_NET_CHAINS_BASE(), PANEL_SETUP_NET_CHAINS::rebuildClassesGrid(), PANEL_SETUP_NET_CHAINS::selectedClassRow(), and PANEL_SETUP_NET_CHAINS::Validate().

m_classesHeader

wxStaticText* PANEL_SETUP_NET_CHAINS_BASE::m_classesHeader

protectedinherited

Definition at line 55 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE().

m_classesTab

wxPanel* PANEL_SETUP_NET_CHAINS_BASE::m_classesTab

protectedinherited

Definition at line 54 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE().

m_classRows

std::vector<CLASS_ROW> PANEL_SETUP_NET_CHAINS::m_classRows

private

Definition at line 120 of file panel_setup_net_chains.h.

Referenced by ApplyEdits(), loadFromModel(), nameInClassGridAlready(), OnClassAddClicked(), OnClassDeleteClicked(), OnClassRenameClicked(), rebuildClassesGrid(), refreshChainClassDropdownChoices(), and Validate().

m_deleteChainButton

STD_BITMAP_BUTTON* PANEL_SETUP_NET_CHAINS_BASE::m_deleteChainButton

protectedinherited

Definition at line 53 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS(), PANEL_SETUP_NET_CHAINS_BASE(), and ~PANEL_SETUP_NET_CHAINS_BASE().

m_deleteClassButton

STD_BITMAP_BUTTON* PANEL_SETUP_NET_CHAINS_BASE::m_deleteClassButton

protectedinherited

Definition at line 59 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS(), PANEL_SETUP_NET_CHAINS_BASE(), and ~PANEL_SETUP_NET_CHAINS_BASE().

m_frame

SCH_EDIT_FRAME* PANEL_SETUP_NET_CHAINS::m_frame

private

Definition at line 116 of file panel_setup_net_chains.h.

Referenced by ApplyEdits(), loadFromModel(), PANEL_SETUP_NET_CHAINS(), and refreshNetClassDropdownChoices().

m_gridToChainIdx

std::vector<int> PANEL_SETUP_NET_CHAINS::m_gridToChainIdx

private

Definition at line 119 of file panel_setup_net_chains.h.

Referenced by OnChainGridSelectionChanged(), OnDeleteChainClicked(), PANEL_SETUP_NET_CHAINS(), rebuildChainsGrid(), and Validate().

m_membersLabel

wxStaticText* PANEL_SETUP_NET_CHAINS_BASE::m_membersLabel

protectedinherited

Definition at line 51 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE(), and PANEL_SETUP_NET_CHAINS::updateMembersDetail().

m_membersListBox

wxListBox* PANEL_SETUP_NET_CHAINS_BASE::m_membersListBox

protectedinherited

Definition at line 52 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE(), and PANEL_SETUP_NET_CHAINS::updateMembersDetail().

m_membersPanel

wxPanel* PANEL_SETUP_NET_CHAINS_BASE::m_membersPanel

protectedinherited

Definition at line 50 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE().

m_notebook

wxNotebook* PANEL_SETUP_NET_CHAINS_BASE::m_notebook

protectedinherited

Definition at line 44 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS_BASE().

m_renameClassButton

STD_BITMAP_BUTTON* PANEL_SETUP_NET_CHAINS_BASE::m_renameClassButton

protectedinherited

Definition at line 58 of file panel_setup_net_chains_base.h.

Referenced by PANEL_SETUP_NET_CHAINS::PANEL_SETUP_NET_CHAINS(), PANEL_SETUP_NET_CHAINS_BASE(), and ~PANEL_SETUP_NET_CHAINS_BASE().

---

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

• panel_setup_net_chains.h
• panel_setup_net_chains.cpp