MODEL_ZONES_OVERVIEW Class Reference

#include <model_zones_overview.h>

Inheritance diagram for MODEL_ZONES_OVERVIEW:

Public Types
enum	{ NAME , NET , LAYERS , COL_COUNT }

Public Member Functions
	MODEL_ZONES_OVERVIEW (wxWindow *aParent, PCB_BASE_FRAME *aFrame, ZONE_SETTINGS_BAG &aZoneSettingsBag)
	~MODEL_ZONES_OVERVIEW () override=default
void	EnableFitterByName (bool aEnable)
void	EnableFitterByNet (bool aEnable)
void	SetLayerFilter (PCB_LAYER_ID aLayer)
void	GetValueByRow (wxVariant &aVariant, unsigned aRow, unsigned aCol) const override
bool	SetValueByRow (const wxVariant &aVariant, unsigned aRow, unsigned aCol) override
unsigned int	GetCount () const override
ZONE *	GetZone (wxDataViewItem const &item) const
wxDataViewItem	GetItemByZone (ZONE *) const
std::optional< unsigned >	MoveZoneIndex (unsigned aIndex, ZONE_INDEX_MOVEMENT aMovement)
	Move selected zone up/down.
std::optional< unsigned >	SwapZonePriority (unsigned aDragIndex, unsigned aDropIndex)
	Swap two zone while drag && drop.
wxDataViewItem	ApplyFilter (wxString const &aFilterText, wxDataViewItem aSelection)
	Filter the zones by the filter text.
wxDataViewItem	ClearFilter (wxDataViewItem aSelection)
	Clear up the filter.

Static Public Member Functions
static std::map< int, wxString >	GetColumnNames ()

Private Member Functions
void	SortFilteredZones ()
void	OnRowCountChange ()

Private Attributes
wxWindow *	m_parent
PCB_BASE_FRAME *	m_frame
ZONE_SETTINGS_BAG &	m_zoneSettingsBag
std::vector< ZONE * >	m_filteredZones
bool	m_sortByName
bool	m_sortByNet
PCB_LAYER_ID	m_layerFilter

Detailed Description

Definition at line 57 of file model_zones_overview.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NAME
NET
LAYERS
COL_COUNT

Definition at line 60 of file model_zones_overview.h.

Constructor & Destructor Documentation

MODEL_ZONES_OVERVIEW()

MODEL_ZONES_OVERVIEW::MODEL_ZONES_OVERVIEW	(	wxWindow *	aParent,
		PCB_BASE_FRAME *	aFrame,
		ZONE_SETTINGS_BAG &	aZoneSettingsBag )

Definition at line 95 of file model_zones_overview.cpp.

References m_filteredZones, m_frame, m_layerFilter, m_parent, m_sortByName, m_sortByNet, m_zoneSettingsBag, Reset(), and UNDEFINED_LAYER.

~MODEL_ZONES_OVERVIEW()

MODEL_ZONES_OVERVIEW::~MODEL_ZONES_OVERVIEW ( )

overridedefault

Member Function Documentation

ApplyFilter()

wxDataViewItem MODEL_ZONES_OVERVIEW::ApplyFilter	(	wxString const &	aFilterText,
		wxDataViewItem	aSelection )

Filter the zones by the filter text.

Parameters

aFilterText	Sub text matching zone name, net name or layer name
aSelection	Current selection

Returns

unsigned Selection after the filter is applied

Definition at line 279 of file model_zones_overview.cpp.

References ClearFilter(), GetCount(), GetItemByZone(), GetZone(), m_filteredZones, m_layerFilter, m_sortByName, m_sortByNet, m_zoneSettingsBag, OnRowCountChange(), Reset(), SortFilteredZones(), and UNDEFINED_LAYER.

ClearFilter()

wxDataViewItem MODEL_ZONES_OVERVIEW::ClearFilter

(

wxDataViewItem

aSelection

)

Clear up the filter.

Parameters

aSelection

Current selection

Returns

unsigned

Definition at line 311 of file model_zones_overview.cpp.

References GetCount(), GetItemByZone(), GetZone(), m_filteredZones, m_layerFilter, m_zoneSettingsBag, OnRowCountChange(), Reset(), SortFilteredZones(), and UNDEFINED_LAYER.

Referenced by ApplyFilter().

EnableFitterByName()

void MODEL_ZONES_OVERVIEW::EnableFitterByName

(

bool

aEnable

)

Definition at line 145 of file model_zones_overview.cpp.

References m_sortByName.

EnableFitterByNet()

void MODEL_ZONES_OVERVIEW::EnableFitterByNet

(

bool

aEnable

)

Definition at line 151 of file model_zones_overview.cpp.

References m_sortByNet.

GetColumnNames()

static std::map< int, wxString > MODEL_ZONES_OVERVIEW::GetColumnNames ( )

inlinestatic

Definition at line 69 of file model_zones_overview.h.

References _, LAYERS, NAME, and NET.

GetCount()

unsigned int MODEL_ZONES_OVERVIEW::GetCount ( ) const

override

Definition at line 169 of file model_zones_overview.cpp.

References m_filteredZones.

Referenced by ApplyFilter(), ClearFilter(), GetZone(), MoveZoneIndex(), OnRowCountChange(), and SwapZonePriority().

GetItemByZone()

wxDataViewItem MODEL_ZONES_OVERVIEW::GetItemByZone

(

ZONE *

aZone

)

const

Definition at line 189 of file model_zones_overview.cpp.

References m_filteredZones.

Referenced by ApplyFilter(), and ClearFilter().

GetValueByRow()

void MODEL_ZONES_OVERVIEW::GetValueByRow ( wxVariant & aVariant, unsigned aRow, unsigned aCol ) const

override

Definition at line 109 of file model_zones_overview.cpp.

References ZONE::GetLayerSet(), BOARD_CONNECTED_ITEM::GetNet(), NETINFO_ITEM::GetNetname(), ZONE::GetZoneName(), LAYER_BAR_HEIGHT, LAYER_BAR_WIDTH, LAYERS, m_filteredZones, m_frame, MakeBitmapForLayers(), NAME, NET, LSET::Seq(), and LSET::UIOrder().

GetZone()

ZONE * MODEL_ZONES_OVERVIEW::GetZone

(

wxDataViewItem const &

item

)

const

Definition at line 175 of file model_zones_overview.cpp.

References GetCount(), and m_filteredZones.

Referenced by ApplyFilter(), and ClearFilter().

MoveZoneIndex()

std::optional< unsigned > MODEL_ZONES_OVERVIEW::MoveZoneIndex	(	unsigned	aIndex,
		ZONE_INDEX_MOVEMENT	aMovement )

Move selected zone up/down.

Returns

std::optional<unsigned> the new index for selected one if success

Definition at line 204 of file model_zones_overview.cpp.

References GetCount(), MOVE_DOWN, MOVE_TO_BOTTOM, MOVE_TO_TOP, MOVE_UP, and SwapZonePriority().

OnRowCountChange()

void MODEL_ZONES_OVERVIEW::OnRowCountChange ( )

private

Definition at line 49 of file model_zones_overview.cpp.

References GetCount(), and m_parent.

Referenced by ApplyFilter(), and ClearFilter().

SetLayerFilter()

void MODEL_ZONES_OVERVIEW::SetLayerFilter

(

PCB_LAYER_ID

aLayer

)

Definition at line 157 of file model_zones_overview.cpp.

References m_layerFilter.

SetValueByRow()

bool MODEL_ZONES_OVERVIEW::SetValueByRow ( const wxVariant & aVariant, unsigned aRow, unsigned aCol )

override

Definition at line 163 of file model_zones_overview.cpp.

SortFilteredZones()

void MODEL_ZONES_OVERVIEW::SortFilteredZones ( )

private

Definition at line 39 of file model_zones_overview.cpp.

References m_filteredZones.

Referenced by ApplyFilter(), and ClearFilter().

SwapZonePriority()

std::optional< unsigned > MODEL_ZONES_OVERVIEW::SwapZonePriority	(	unsigned	aDragIndex,
		unsigned	aDropIndex )

Swap two zone while drag && drop.

Returns

std::optional<unsigned> the new index for the dragged one if success

Definition at line 258 of file model_zones_overview.cpp.

References GetCount(), m_filteredZones, and m_zoneSettingsBag.

Referenced by MoveZoneIndex().

Member Data Documentation

m_filteredZones

std::vector<ZONE*> MODEL_ZONES_OVERVIEW::m_filteredZones

private

Definition at line 141 of file model_zones_overview.h.

Referenced by ApplyFilter(), ClearFilter(), GetCount(), GetItemByZone(), GetValueByRow(), GetZone(), MODEL_ZONES_OVERVIEW(), SortFilteredZones(), and SwapZonePriority().

m_frame

PCB_BASE_FRAME* MODEL_ZONES_OVERVIEW::m_frame

private

Definition at line 139 of file model_zones_overview.h.

Referenced by GetValueByRow(), and MODEL_ZONES_OVERVIEW().

m_layerFilter

PCB_LAYER_ID MODEL_ZONES_OVERVIEW::m_layerFilter

private

Definition at line 144 of file model_zones_overview.h.

Referenced by ApplyFilter(), ClearFilter(), MODEL_ZONES_OVERVIEW(), and SetLayerFilter().

m_parent

wxWindow* MODEL_ZONES_OVERVIEW::m_parent

private

Definition at line 138 of file model_zones_overview.h.

Referenced by MODEL_ZONES_OVERVIEW(), and OnRowCountChange().

m_sortByName

bool MODEL_ZONES_OVERVIEW::m_sortByName

private

Definition at line 142 of file model_zones_overview.h.

Referenced by ApplyFilter(), EnableFitterByName(), and MODEL_ZONES_OVERVIEW().

m_sortByNet

bool MODEL_ZONES_OVERVIEW::m_sortByNet

private

Definition at line 143 of file model_zones_overview.h.

Referenced by ApplyFilter(), EnableFitterByNet(), and MODEL_ZONES_OVERVIEW().

m_zoneSettingsBag

ZONE_SETTINGS_BAG& MODEL_ZONES_OVERVIEW::m_zoneSettingsBag

private

Definition at line 140 of file model_zones_overview.h.

Referenced by ApplyFilter(), ClearFilter(), MODEL_ZONES_OVERVIEW(), and SwapZonePriority().

---

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

• model_zones_overview.h
• model_zones_overview.cpp