PCB_LAYER_BOX_SELECTOR Class Reference

Class to display a pcb layer list in a wxBitmapComboBox. More...

#include <pcb_layer_box_selector.h>

Inheritance diagram for PCB_LAYER_BOX_SELECTOR:

Public Member Functions
	PCB_LAYER_BOX_SELECTOR (wxWindow *parent, wxWindowID id, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, int n=0, const wxString choices[]=nullptr, int style=0)
void	SetBoardFrame (PCB_BASE_FRAME *aFrame)
void	SetNotAllowedLayerSet (const LSET &aMask)
void	SetUndefinedLayerName (const wxString &aName)
void	Resync () override
void	ShowNonActivatedLayers (bool aShow)
int	GetLayerSelection () const
int	SetLayerSelection (int layer)
bool	SetLayersHotkeys (bool value)

Protected Attributes
bool	m_layerhotkeys

Private Member Functions
bool	isLayerEnabled (int aLayer) const override
	Return true if the layer id is enabled (i.e. is it should be displayed).
LSET	getEnabledLayers () const

Private Attributes
PCB_BASE_FRAME *	m_boardFrame
LSET	m_layerMaskDisable
bool	m_showNotEnabledBrdlayers
wxString	m_undefinedLayerName
std::unique_ptr< PCB_LAYER_PRESENTATION >	m_layerPresentation

Detailed Description

Class to display a pcb layer list in a wxBitmapComboBox.

Definition at line 40 of file pcb_layer_box_selector.h.

Constructor & Destructor Documentation

PCB_LAYER_BOX_SELECTOR()

PCB_LAYER_BOX_SELECTOR::PCB_LAYER_BOX_SELECTOR	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	value = wxEmptyString,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		int	n = 0,
		const wxString	choices[] = nullptr,
		int	style = 0 )

Definition at line 38 of file pcb_layer_box_selector.cpp.

References LAYER_BOX_SELECTOR::LAYER_BOX_SELECTOR(), m_boardFrame, m_layerPresentation, and m_showNotEnabledBrdlayers.

Member Function Documentation

getEnabledLayers()

LSET PCB_LAYER_BOX_SELECTOR::getEnabledLayers ( ) const

private

Definition at line 132 of file pcb_layer_box_selector.cpp.

References LSET::AllLayersMask(), and m_boardFrame.

Referenced by isLayerEnabled(), and Resync().

GetLayerSelection()

int LAYER_BOX_SELECTOR::GetLayerSelection ( ) const

inherited

Definition at line 71 of file layer_box_selector.cpp.

References UNDEFINED_LAYER.

Referenced by GRID_CELL_LAYER_SELECTOR::EndEdit().

isLayerEnabled()

bool PCB_LAYER_BOX_SELECTOR::isLayerEnabled ( int aLayer ) const

overrideprivatevirtual

Return true if the layer id is enabled (i.e. is it should be displayed).

Implements LAYER_SELECTOR.

Definition at line 126 of file pcb_layer_box_selector.cpp.

References getEnabledLayers().

Resync()

void PCB_LAYER_BOX_SELECTOR::Resync ( )

overridevirtual

Implements LAYER_BOX_SELECTOR.

Definition at line 57 of file pcb_layer_box_selector.cpp.

References _, AddHotkeyName(), LSET::AllCuMask(), LSET::AllNonCuMask(), getEnabledLayers(), TOOL_ACTION::GetHotKey(), IS_COMMENT, PCB_ACTIONS::LayerIDToAction(), LAYER_SELECTOR::m_layerhotkeys, m_layerMaskDisable, m_layerPresentation, m_showNotEnabledBrdlayers, m_undefinedLayerName, scale, LSET::UIOrder(), and UNDEFINED_LAYER.

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit().

SetBoardFrame()

void PCB_LAYER_BOX_SELECTOR::SetBoardFrame

(

PCB_BASE_FRAME *

aFrame

)

Definition at line 49 of file pcb_layer_box_selector.cpp.

References m_boardFrame, and m_layerPresentation.

Referenced by GRID_CELL_LAYER_SELECTOR::Create().

SetLayerSelection()

int LAYER_BOX_SELECTOR::SetLayerSelection ( int layer )

inherited

Definition at line 80 of file layer_box_selector.cpp.

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), and GRID_CELL_LAYER_SELECTOR::Reset().

SetLayersHotkeys()

bool LAYER_SELECTOR::SetLayersHotkeys ( bool value )

inherited

Definition at line 43 of file layer_box_selector.cpp.

References m_layerhotkeys.

Referenced by GRID_CELL_LAYER_SELECTOR::Create().

SetNotAllowedLayerSet()

void PCB_LAYER_BOX_SELECTOR::SetNotAllowedLayerSet ( const LSET & aMask )

inline

Definition at line 57 of file pcb_layer_box_selector.h.

References m_layerMaskDisable.

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), and GRID_CELL_LAYER_SELECTOR::Create().

SetUndefinedLayerName()

void PCB_LAYER_BOX_SELECTOR::SetUndefinedLayerName ( const wxString & aName )

inline

Definition at line 61 of file pcb_layer_box_selector.h.

References m_undefinedLayerName.

ShowNonActivatedLayers()

void PCB_LAYER_BOX_SELECTOR::ShowNonActivatedLayers ( bool aShow )

inline

Definition at line 68 of file pcb_layer_box_selector.h.

References m_showNotEnabledBrdlayers.

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), and GRID_CELL_LAYER_SELECTOR::Create().

Member Data Documentation

m_boardFrame

PCB_BASE_FRAME* PCB_LAYER_BOX_SELECTOR::m_boardFrame

private

Definition at line 76 of file pcb_layer_box_selector.h.

Referenced by getEnabledLayers(), PCB_LAYER_BOX_SELECTOR(), and SetBoardFrame().

m_layerhotkeys

bool LAYER_SELECTOR::m_layerhotkeys

protectedinherited

Definition at line 47 of file layer_box_selector.h.

Referenced by GBR_LAYER_BOX_SELECTOR::GBR_LAYER_BOX_SELECTOR(), LAYER_SELECTOR(), PCB_LAYER_BOX_SELECTOR::Resync(), and SetLayersHotkeys().

m_layerMaskDisable

LSET PCB_LAYER_BOX_SELECTOR::m_layerMaskDisable

private

Definition at line 78 of file pcb_layer_box_selector.h.

Referenced by Resync(), and SetNotAllowedLayerSet().

m_layerPresentation

std::unique_ptr<PCB_LAYER_PRESENTATION> PCB_LAYER_BOX_SELECTOR::m_layerPresentation

private

Definition at line 85 of file pcb_layer_box_selector.h.

Referenced by PCB_LAYER_BOX_SELECTOR(), Resync(), and SetBoardFrame().

m_showNotEnabledBrdlayers

bool PCB_LAYER_BOX_SELECTOR::m_showNotEnabledBrdlayers

private

Definition at line 80 of file pcb_layer_box_selector.h.

Referenced by PCB_LAYER_BOX_SELECTOR(), Resync(), and ShowNonActivatedLayers().

m_undefinedLayerName

wxString PCB_LAYER_BOX_SELECTOR::m_undefinedLayerName

private

Definition at line 82 of file pcb_layer_box_selector.h.

Referenced by Resync(), and SetUndefinedLayerName().

---

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

• pcb_layer_box_selector.h
• pcb_layer_box_selector.cpp