KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
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:
LAYER_BOX_SELECTOR LAYER_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 (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 37 of file pcb_layer_box_selector.cpp.

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(), PCB_BASE_FRAME::GetBoard(), BOARD::GetEnabledLayers(), 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 DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_SHAPE_PROPERTIES::enableNetInfo(), DIALOG_SHAPE_PROPERTIES::enableTechLayers(), GRID_CELL_LAYER_SELECTOR::EndEdit(), DIALOG_TRACK_VIA_PROPERTIES::getLayerDepth(), DIALOG_OUTSET_ITEMS::OnLayerDefaultClick(), DIALOG_SHAPE_PROPERTIES::onLayerSelection(), DIALOG_TRACK_VIA_PROPERTIES::onTrackEdit(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), FOOTPRINT_EDIT_FRAME::SelectLayer(), DIALOG_OUTSET_ITEMS::TransferDataFromWindow(), DIALOG_REFERENCE_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_IMPORT_GRAPHICS::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::~DIALOG_GLOBAL_EDIT_TEARDROPS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::~DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), and DIALOG_IMPORT_GRAPHICS::~DIALOG_IMPORT_GRAPHICS().

◆ 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::AllLayersMask(), getEnabledLayers(), TOOL_ACTION::GetHotKey(), IS_COMMENT, PCB_ACTIONS::LayerIDToAction(), LAYER_SELECTOR::m_layerhotkeys, m_layerPresentation, m_showNotEnabledBrdlayers, m_undefinedLayerName, scale, LSET::UIOrder(), and UNDEFINED_LAYER.

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_OUTSET_ITEMS::DIALOG_OUTSET_ITEMS(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), and PCB_EDIT_FRAME::ReCreateLayerBox().

◆ 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 DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), GRID_CELL_LAYER_SELECTOR::Create(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_OUTSET_ITEMS::DIALOG_OUTSET_ITEMS(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), and FOOTPRINT_EDIT_FRAME::ReCreateHToolbar().

◆ 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(), DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), DIALOG_TRACK_VIA_PROPERTIES::onViaEdit(), GRID_CELL_LAYER_SELECTOR::Reset(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_OUTSET_ITEMS::TransferDataToWindow(), DIALOG_REFERENCE_IMAGE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ SetLayersHotkeys()

bool LAYER_SELECTOR::SetLayersHotkeys ( bool  value)
inherited

Definition at line 43 of file layer_box_selector.cpp.

References LAYER_SELECTOR::m_layerhotkeys.

Referenced by DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), GRID_CELL_LAYER_SELECTOR::Create(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_OUTSET_ITEMS::DIALOG_OUTSET_ITEMS(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), and DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES().

◆ SetNotAllowedLayerSet()

void PCB_LAYER_BOX_SELECTOR::SetNotAllowedLayerSet ( LSET  aMask)
inline

Definition at line 57 of file pcb_layer_box_selector.h.

References m_layerMaskDisable.

Referenced by DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), GRID_CELL_LAYER_SELECTOR::Create(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), and FOOTPRINT_EDIT_FRAME::ReCreateHToolbar().

◆ 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.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), and DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES().

◆ 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(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_OUTSET_ITEMS::DIALOG_OUTSET_ITEMS(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES().

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(), 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::LAYER_SELECTOR(), Resync(), and LAYER_SELECTOR::SetLayersHotkeys().

◆ m_layerMaskDisable

LSET PCB_LAYER_BOX_SELECTOR::m_layerMaskDisable
private

Definition at line 78 of file pcb_layer_box_selector.h.

Referenced by 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 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 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: