KiCad PCB EDA Suite
LAYER_WIDGET Class Referenceabstract

LAYER_WIDGET is abstract and is used to manage a list of layers, with the notion of a "current" layer, and layer specific visibility control. More...

#include <layer_widget.h>

Inheritance diagram for LAYER_WIDGET:
GERBER_LAYER_WIDGET PCB_LAYER_WIDGET

Classes

struct  ROW
 Struct ROW provides all the data needed to add a row to a LAYER_WIDGET. More...
 

Public Member Functions

 LAYER_WIDGET (wxWindow *aParent, wxWindow *aFocusOwner, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL)
 Constructor. More...
 
virtual ~LAYER_WIDGET ()
 
wxSize GetBestSize () const
 Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic content. More...
 
int GetLayerRowCount () const
 Function GetLayerRowCount returns the number of rows in the layer tab. More...
 
int GetRenderRowCount () const
 Function GetRenderRowCount returns the number of rows in the render tab. More...
 
void AppendLayerRow (const ROW &aRow)
 Function AppendLayerRow appends a new row in the layer portion of the widget. More...
 
void AppendLayerRows (const ROW *aRowsArray, int aRowCount)
 Function AppendLayerRows appends new rows in the layer portion of the widget. More...
 
void ClearLayerRows ()
 Function ClearLayerRows empties out the layer rows. More...
 
void AppendRenderRow (const ROW &aRow)
 Function AppendRenderRow appends a new row in the render portion of the widget. More...
 
void AppendRenderRows (const ROW *aRowsArray, int aRowCount)
 Function AppendRenderRows appends new rows in the render portion of the widget. More...
 
void ClearRenderRows ()
 Function ClearRenderRows empties out the render rows. More...
 
void SelectLayerRow (int aRow)
 Function SelectLayerRow changes the row selection in the layer list to the given row. More...
 
void SelectLayer (LAYER_NUM aLayer)
 Function SelectLayer changes the row selection in the layer list to aLayer provided. More...
 
LAYER_NUM GetSelectedLayer ()
 Function GetSelectedLayer returns the selected layer or -1 if none. More...
 
void SetLayerVisible (LAYER_NUM aLayer, bool isVisible)
 Function SetLayerVisible sets aLayer visible or not. More...
 
bool IsLayerVisible (LAYER_NUM aLayer)
 Function IsLayerVisible returns the visible state of the layer ROW associated with aLayer id. More...
 
void SetLayerColor (LAYER_NUM aLayer, COLOR4D aColor)
 Function SetLayerColor changes the color of aLayer. More...
 
COLOR4D GetLayerColor (LAYER_NUM aLayer) const
 Function GetLayerColor returns the color of the layer ROW associated with aLayer id. More...
 
void SetRenderState (int aId, bool isSet)
 Function SetRenderState sets the state of the checkbox associated with aId within the Render tab group of the widget. More...
 
bool GetRenderState (int aId)
 Function GetRenderState returns the state of the checkbox associated with aId. More...
 
void UpdateLayouts ()
 
void UpdateLayerIcons ()
 Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or clearing a layer because they change, and the indicator arrow icon needs to be updated. More...
 
virtual void OnLayerColorChange (int aLayer, COLOR4D aColor)=0
 Function OnLayerColorChange is called to notify client code about a layer color change. More...
 
virtual bool OnLayerSelect (int aLayer)=0
 Function OnLayerSelect is called to notify client code whenever the user selects a different layer. More...
 
virtual void OnLayerVisible (LAYER_NUM aLayer, bool isVisible, bool isFinal=true)=0
 Function OnLayerVisible is called to notify client code about a layer visibility change. More...
 
virtual void OnLayerRightClick (wxMenu &aMenu)=0
 Function OnLayerRightClick is called to notify client code about a layer being right-clicked. More...
 
virtual void OnRenderColorChange (int aId, COLOR4D aColor)=0
 Function OnRenderColorChange is called to notify client code whenever the user changes a rendering color. More...
 
virtual void OnRenderEnable (int aId, bool isEnabled)=0
 Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable in one of the rendering checkboxes. More...
 

Static Public Attributes

static const wxEventType EVT_LAYER_COLOR_CHANGE = wxNewEventType()
 

Protected Types

enum  POPUP_ID { ID_CHANGE_LAYER_COLOR = wxID_HIGHEST, ID_CHANGE_RENDER_COLOR, ID_LAST_VALUE }
 

Protected Member Functions

virtual bool useAlternateBitmap (int aRow)
 Virtual Function useAlternateBitmap. More...
 
virtual COLOR4D getBackgroundLayerColor ()
 Subclasses can override this to provide accurate representation of transparent colour swatches. More...
 
void OnLeftDownLayers (wxMouseEvent &event)
 
void OnRightDownLayer (wxMouseEvent &event, COLOR_SWATCH *aColorSwatch, const wxString &aLayerName)
 Function OnRightDownLayer Called when user right-clicks a layer. More...
 
void OnLayerSwatchChanged (wxCommandEvent &aEvent)
 Function OnSwatchChanged() is called when a user changes a swatch color. More...
 
void OnLayerCheckBox (wxCommandEvent &event)
 Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the client's notification function. More...
 
void OnRightDownRender (wxMouseEvent &aEvent, COLOR_SWATCH *aColorSwatch, const wxString &aRenderName)
 Function OnRightDownRender Called when user right-clicks a render option. More...
 
void OnRenderSwatchChanged (wxCommandEvent &aEvent)
 Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry. More...
 
void OnRenderCheckBox (wxCommandEvent &event)
 
void OnTabChange (wxNotebookEvent &event)
 
wxWindow * getLayerComp (int aRow, int aColumn) const
 Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL if these parameters are out of range. More...
 
wxWindow * getRenderComp (int aRow, int aColumn) const
 
int findLayerRow (LAYER_NUM aLayer) const
 Function findLayerRow returns the row index that aLayer resides in, or -1 if not found. More...
 
int findRenderRow (int aId) const
 
void insertLayerRow (int aRow, const ROW &aSpec)
 Function insertLayerRow appends or inserts a new row in the layer portion of the widget. More...
 
void insertRenderRow (int aRow, const ROW &aSpec)
 
void setLayerCheckbox (LAYER_NUM aLayer, bool isVisible)
 
void updateLayerRow (int aRow, const wxString &aName)
 
void passOnFocus ()
 Function passOnFocus gives away the keyboard focus up to the main parent window. More...
 

Static Protected Member Functions

static int encodeId (int aColumn, int aId)
 Function encodeId is here to allow saving a layer index within a control as its wxControl id, but to do so in a way that all child wxControl ids within a wxWindow are unique, since this is required by Windows. More...
 
static LAYER_NUM getDecodedId (int aControlId)
 Function getDecodedId decodes aControlId to original un-encoded value. More...
 

Protected Attributes

wxAuiNotebook * m_notebook
 
wxPanel * m_LayerPanel
 
wxScrolledWindow * m_LayerScrolledWindow
 
wxFlexGridSizer * m_LayersFlexGridSizer
 
wxPanel * m_RenderingPanel
 
wxScrolledWindow * m_RenderScrolledWindow
 
wxFlexGridSizer * m_RenderFlexGridSizer
 
wxWindow * m_FocusOwner
 
int m_CurrentRow
 selected row of layer list More...
 
int m_PointSize
 
ROW_ICON_PROVIDERm_IconProvider
 

Detailed Description

LAYER_WIDGET is abstract and is used to manage a list of layers, with the notion of a "current" layer, and layer specific visibility control.

You must derive from it to use it so you can implement the abstract functions which recieve the events. Each layer is given its own color, and that color can be changed within the UI provided here. This widget knows nothing of the client code, meaning it has no knowledge of a BOARD or anything. To use it you must derive from this class and implement the abstract functions:

void OnLayerColorChange( int aLayer, int aColor );

bool OnLayerSelect( int aLayer );

void OnLayerVisible( int aLayer, bool isVisible );

void OnRenderColorChange( int id, int aColor );

void OnRenderEnable( int id, bool isEnabled );

Please note that even if designed toward layers, it is used to contain other stuff, too (the second page in pcbnew contains render items, for example)

Definition at line 79 of file layer_widget.h.

Member Enumeration Documentation

◆ POPUP_ID

enum LAYER_WIDGET::POPUP_ID
protected
Enumerator
ID_CHANGE_LAYER_COLOR 
ID_CHANGE_RENDER_COLOR 
ID_LAST_VALUE 

Definition at line 250 of file layer_widget.h.

Constructor & Destructor Documentation

◆ LAYER_WIDGET()

LAYER_WIDGET::LAYER_WIDGET ( wxWindow *  aParent,
wxWindow *  aFocusOwner,
wxWindowID  id = wxID_ANY,
const wxPoint pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = wxTAB_TRAVERSAL 
)

Constructor.

Parameters
aParentis the parent window
aFocusOwneris the window that should be sent the focus after
idis the wxWindow id ( default = wxID_ANY)
posis the window position
sizeis the window size
styleis the window style every operation.

Definition at line 478 of file layer_widget.cpp.

479  :
480  wxPanel( aParent, id, pos, size, style )
481 {
482  int indicatorSize = ConvertDialogToPixels( wxSize( 6, 6 ) ).x;
483  m_IconProvider = new ROW_ICON_PROVIDER( indicatorSize );
484 
485  int pointSize = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ).GetPointSize();
486  int screenHeight = wxSystemSettings::GetMetric( wxSYS_SCREEN_Y );
487 
488  if( screenHeight <= 900 && pointSize >= indicatorSize )
489  pointSize = pointSize * 8 / 10;
490 
491  m_PointSize = pointSize;
492 
493  wxBoxSizer* mainSizer = new wxBoxSizer( wxVERTICAL );
494 
495  m_notebook = new wxAuiNotebook( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxAUI_NB_TOP );
496 
497  wxFont font = m_notebook->GetFont();
498 
499  // change the font size on the notebook's tabs to match aPointSize
500  font.SetPointSize( pointSize );
501  m_notebook->SetFont( font );
502  m_notebook->SetNormalFont( font );
503  m_notebook->SetSelectedFont( font );
504  m_notebook->SetMeasuringFont( font );
505 
506  m_LayerPanel = new wxPanel( m_notebook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
507 
508  wxBoxSizer* layerPanelSizer;
509  layerPanelSizer = new wxBoxSizer( wxVERTICAL );
510 
511  m_LayerScrolledWindow = new wxScrolledWindow( m_LayerPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER );
512  m_LayerScrolledWindow->SetScrollRate( 5, 5 );
513  m_LayersFlexGridSizer = new wxFlexGridSizer( 0, LYR_COLUMN_COUNT, 0, 1 );
514  m_LayersFlexGridSizer->SetFlexibleDirection( wxHORIZONTAL );
515  m_LayersFlexGridSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_NONE );
516 
518  m_LayerScrolledWindow->Layout();
520  layerPanelSizer->Add( m_LayerScrolledWindow, 1, wxBOTTOM|wxEXPAND|wxLEFT|wxTOP, 2 );
521 
522  m_LayerPanel->SetSizer( layerPanelSizer );
523  m_LayerPanel->Layout();
524  layerPanelSizer->Fit( m_LayerPanel );
525  m_notebook->AddPage( m_LayerPanel, _( "Layers" ), true );
526  m_RenderingPanel = new wxPanel( m_notebook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
527 
528  wxBoxSizer* renderPanelSizer;
529  renderPanelSizer = new wxBoxSizer( wxVERTICAL );
530 
531  m_RenderScrolledWindow = new wxScrolledWindow( m_RenderingPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER );
532  m_RenderScrolledWindow->SetScrollRate( 5, 5 );
533  m_RenderFlexGridSizer = new wxFlexGridSizer( 0, RND_COLUMN_COUNT, 0, 1 );
534  m_RenderFlexGridSizer->SetFlexibleDirection( wxHORIZONTAL );
535  m_RenderFlexGridSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_NONE );
536 
538  m_RenderScrolledWindow->Layout();
540  renderPanelSizer->Add( m_RenderScrolledWindow, 1, wxALL|wxEXPAND, 5 );
541 
542  m_RenderingPanel->SetSizer( renderPanelSizer );
543  m_RenderingPanel->Layout();
544  renderPanelSizer->Fit( m_RenderingPanel );
545  m_notebook->AddPage( m_RenderingPanel, _( "Items" ), false );
546 
547  mainSizer->Add( m_notebook, 1, wxEXPAND, 5 );
548 
549  SetSizer( mainSizer );
550 
551  m_FocusOwner = aFocusOwner;
552 
553  m_CurrentRow = -1; // hide the arrow initially
554 
555  // trap the tab changes so that we can call passOnFocus().
556  m_notebook->Bind( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, &LAYER_WIDGET::OnTabChange, this );
557 
558  Layout();
559 }
wxAuiNotebook * m_notebook
Definition: layer_widget.h:127
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:136
Icon provider for the "standard" row indicators, for example in layer selection lists.
void OnTabChange(wxNotebookEvent &event)
wxScrolledWindow * m_RenderScrolledWindow
Definition: layer_widget.h:132
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:50
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133
wxPanel * m_RenderingPanel
Definition: layer_widget.h:131
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:129
wxWindow * m_FocusOwner
Definition: layer_widget.h:135
#define _(s)
Definition: 3d_actions.cpp:33
ROW_ICON_PROVIDER * m_IconProvider
Definition: layer_widget.h:139
wxPanel * m_LayerPanel
Definition: layer_widget.h:128

References _, LYR_COLUMN_COUNT, m_CurrentRow, m_FocusOwner, m_IconProvider, m_LayerPanel, m_LayerScrolledWindow, m_LayersFlexGridSizer, m_notebook, m_PointSize, m_RenderFlexGridSizer, m_RenderingPanel, m_RenderScrolledWindow, OnTabChange(), and RND_COLUMN_COUNT.

◆ ~LAYER_WIDGET()

LAYER_WIDGET::~LAYER_WIDGET ( )
virtual

Definition at line 562 of file layer_widget.cpp.

563 {
564  delete m_IconProvider;
565 }
ROW_ICON_PROVIDER * m_IconProvider
Definition: layer_widget.h:139

References m_IconProvider.

Member Function Documentation

◆ AppendLayerRow()

void LAYER_WIDGET::AppendLayerRow ( const ROW aRow)

Function AppendLayerRow appends a new row in the layer portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 637 of file layer_widget.cpp.

638 {
639  int nextRow = GetLayerRowCount();
640  insertLayerRow( nextRow, aRow );
641 }
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
void insertLayerRow(int aRow, const ROW &aSpec)
Function insertLayerRow appends or inserts a new row in the layer portion of the widget.

References GetLayerRowCount(), and insertLayerRow().

Referenced by AppendLayerRows(), PCB_LAYER_WIDGET::ReFill(), and GERBER_LAYER_WIDGET::ReFill().

◆ AppendLayerRows()

void LAYER_WIDGET::AppendLayerRows ( const ROW aRowsArray,
int  aRowCount 
)
inline

Function AppendLayerRows appends new rows in the layer portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 306 of file layer_widget.h.

307  {
308  for( int row=0; row<aRowCount; ++row )
309  AppendLayerRow( aRowsArray[row] );
310 
311  UpdateLayouts();
312  }
void UpdateLayouts()
void AppendLayerRow(const ROW &aRow)
Function AppendLayerRow appends a new row in the layer portion of the widget.

References AppendLayerRow(), and UpdateLayouts().

◆ AppendRenderRow()

void LAYER_WIDGET::AppendRenderRow ( const ROW aRow)

Function AppendRenderRow appends a new row in the render portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 650 of file layer_widget.cpp.

651 {
652  int nextRow = GetRenderRowCount();
653  insertRenderRow( nextRow, aRow );
654 }
void insertRenderRow(int aRow, const ROW &aSpec)
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.

References GetRenderRowCount(), and insertRenderRow().

Referenced by AppendRenderRows(), and PCB_LAYER_WIDGET::ReFillRender().

◆ AppendRenderRows()

void LAYER_WIDGET::AppendRenderRows ( const ROW aRowsArray,
int  aRowCount 
)
inline

Function AppendRenderRows appends new rows in the render portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 332 of file layer_widget.h.

333  {
334  for( int row=0; row<aRowCount; ++row )
335  AppendRenderRow( aRowsArray[row] );
336 
337  UpdateLayouts();
338  }
void UpdateLayouts()
void AppendRenderRow(const ROW &aRow)
Function AppendRenderRow appends a new row in the render portion of the widget.

References AppendRenderRow(), and UpdateLayouts().

Referenced by GERBER_LAYER_WIDGET::ReFillRender().

◆ ClearLayerRows()

void LAYER_WIDGET::ClearLayerRows ( )

Function ClearLayerRows empties out the layer rows.

Definition at line 644 of file layer_widget.cpp.

645 {
646  m_LayersFlexGridSizer->Clear( true );
647 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130

References m_LayersFlexGridSizer.

Referenced by PCB_LAYER_WIDGET::ReFill().

◆ ClearRenderRows()

void LAYER_WIDGET::ClearRenderRows ( )

Function ClearRenderRows empties out the render rows.

Definition at line 657 of file layer_widget.cpp.

658 {
659  m_RenderFlexGridSizer->Clear( true );
660 }
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133

References m_RenderFlexGridSizer.

Referenced by PCB_LAYER_WIDGET::ReFillRender(), and GERBER_LAYER_WIDGET::ReFillRender().

◆ encodeId()

int LAYER_WIDGET::encodeId ( int  aColumn,
int  aId 
)
staticprotected

Function encodeId is here to allow saving a layer index within a control as its wxControl id, but to do so in a way that all child wxControl ids within a wxWindow are unique, since this is required by Windows.

See also
getDecodedId()

Definition at line 63 of file layer_widget.cpp.

64 {
65  int id = aId * LYR_COLUMN_COUNT + aColumn;
66  return id;
67 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49

References LYR_COLUMN_COUNT.

Referenced by insertLayerRow(), and insertRenderRow().

◆ findLayerRow()

int LAYER_WIDGET::findLayerRow ( LAYER_NUM  aLayer) const
protected

Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.

Definition at line 268 of file layer_widget.cpp.

269 {
270  int count = GetLayerRowCount();
271 
272  for( int row = 0; row < count; ++row )
273  {
274  // column 0 in the layer scroll window has a wxStaticBitmap, get its ID.
275  wxWindow* w = getLayerComp( row, 0 );
276  wxASSERT( w );
277 
278  if( aLayer == getDecodedId( w->GetId() ))
279  return row;
280  }
281 
282  return -1;
283 }
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.

References getDecodedId(), getLayerComp(), and GetLayerRowCount().

Referenced by GetLayerColor(), IsLayerVisible(), OnLeftDownLayers(), GERBER_LAYER_WIDGET::ReFill(), SelectLayer(), setLayerCheckbox(), and SetLayerColor().

◆ findRenderRow()

int LAYER_WIDGET::findRenderRow ( int  aId) const
protected

Definition at line 297 of file layer_widget.cpp.

298 {
299  int count = GetRenderRowCount();
300 
301  for( int row = 0; row < count; ++row )
302  {
303  // column 0 in the layer scroll window has a wxStaticBitmap, get its ID.
304  wxWindow* w = getRenderComp( row, 0 );
305  wxASSERT( w );
306 
307  if( aId == getDecodedId( w->GetId() ))
308  return row;
309  }
310 
311  return -1;
312 }
wxWindow * getRenderComp(int aRow, int aColumn) const
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.

References getDecodedId(), getRenderComp(), and GetRenderRowCount().

Referenced by GetRenderState(), and SetRenderState().

◆ getBackgroundLayerColor()

virtual COLOR4D LAYER_WIDGET::getBackgroundLayerColor ( )
inlineprotectedvirtual

Subclasses can override this to provide accurate representation of transparent colour swatches.

Reimplemented in PCB_LAYER_WIDGET.

Definition at line 155 of file layer_widget.h.

155 { return COLOR4D::BLACK; }
Definition: color4d.h:44

References BLACK.

Referenced by insertLayerRow(), and insertRenderRow().

◆ GetBestSize()

wxSize LAYER_WIDGET::GetBestSize ( ) const

Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic content.

Nothing in wxWidgets was reliable enough so this overrides one of their functions.

Definition at line 568 of file layer_widget.cpp.

569 {
570  // size of m_LayerScrolledWindow --------------
571  wxArrayInt widths = m_LayersFlexGridSizer->GetColWidths();
572  int totWidth = 0;
573 
574  if( widths.GetCount() )
575  {
576  for( int i = 0; i < LYR_COLUMN_COUNT; ++i )
577  {
578  totWidth += widths[i] + m_LayersFlexGridSizer->GetHGap();
579  // printf("widths[%d]:%d\n", i, widths[i] );
580  }
581  }
582 
583  // Account for the parent's frame:
584  totWidth += 15;
585 
586 
587  /* The minimum height is a small size to properly force computation
588  * of the panel's scrollbars (otherwise it will assume it *has* all
589  * this space) */
590  unsigned totHeight = 32;
591 
592  wxSize layerz( totWidth, totHeight );
593 
594  layerz += m_LayerPanel->GetWindowBorderSize();
595 
596 
597  // size of m_RenderScrolledWindow --------------
598  widths = m_RenderFlexGridSizer->GetColWidths();
599  totWidth = 0;
600 
601  if( widths.GetCount() )
602  {
603  for( int i = 0; i < RND_COLUMN_COUNT; ++i )
604  {
605  totWidth += widths[i] + m_RenderFlexGridSizer->GetHGap();
606  // printf("widths[%d]:%d\n", i, widths[i] );
607  }
608  }
609  // account for the parent's frame, this one has void space of 10 PLUS a border:
610  totWidth += 15;
611 
612  // For totHeight re-use the previous small one
613  wxSize renderz( totWidth, totHeight );
614 
615  renderz += m_RenderingPanel->GetWindowBorderSize();
616 
617  wxSize clientz( std::max(renderz.x,layerz.x), std::max(renderz.y,layerz.y) );
618 
619  return clientz;
620 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:50
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133
wxPanel * m_RenderingPanel
Definition: layer_widget.h:131
wxPanel * m_LayerPanel
Definition: layer_widget.h:128

References LYR_COLUMN_COUNT, m_LayerPanel, m_LayersFlexGridSizer, m_RenderFlexGridSizer, m_RenderingPanel, and RND_COLUMN_COUNT.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::ReFillLayerWidget(), and GERBVIEW_FRAME::ReFillLayerWidget().

◆ getDecodedId()

LAYER_NUM LAYER_WIDGET::getDecodedId ( int  aControlId)
staticprotected

Function getDecodedId decodes aControlId to original un-encoded value.

This of course holds iff encodedId was called with a LAYER_NUM (this box is used for other things than layers, too)

Definition at line 70 of file layer_widget.cpp.

71 {
72  int id = aControlId / LYR_COLUMN_COUNT; // rounding is OK.
73  return id;
74 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49

References LYR_COLUMN_COUNT.

Referenced by findLayerRow(), findRenderRow(), GetSelectedLayer(), OnLayerCheckBox(), OnLayerSwatchChanged(), OnLeftDownLayers(), GERBER_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), OnRenderCheckBox(), OnRenderSwatchChanged(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), PCB_LAYER_WIDGET::SyncLayerColors(), and PCB_LAYER_WIDGET::SyncLayerVisibilities().

◆ GetLayerColor()

COLOR4D LAYER_WIDGET::GetLayerColor ( LAYER_NUM  aLayer) const

Function GetLayerColor returns the color of the layer ROW associated with aLayer id.

Definition at line 762 of file layer_widget.cpp.

763 {
764  int row = findLayerRow( aLayer );
765  if( row >= 0 )
766  {
767  int col = 1; // bitmap button is column 1
768  auto swatch = static_cast<COLOR_SWATCH*>( getLayerComp( row, col ) );
769  wxASSERT( swatch );
770 
771  return swatch->GetSwatchColor();
772  }
773 
774  return COLOR4D::UNSPECIFIED; // it's caller fault, gave me a bad layer
775 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...

References findLayerRow(), and getLayerComp().

◆ getLayerComp()

wxWindow * LAYER_WIDGET::getLayerComp ( int  aRow,
int  aColumn 
) const
protected

Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL if these parameters are out of range.

Parameters
aRowis the row index
aColumnis the column
Returns
wxWindow - the component installed within the sizer at given grid coordinate.

Definition at line 257 of file layer_widget.cpp.

258 {
259  unsigned ndx = aRow * LYR_COLUMN_COUNT + aColumn;
260 
261  if( ndx < m_LayersFlexGridSizer->GetChildren().GetCount() )
262  return m_LayersFlexGridSizer->GetChildren()[ndx]->GetWindow();
263 
264  return NULL;
265 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130
#define NULL

References LYR_COLUMN_COUNT, m_LayersFlexGridSizer, and NULL.

Referenced by findLayerRow(), GetLayerColor(), GetSelectedLayer(), IsLayerVisible(), OnLeftDownLayers(), GERBER_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), OnRenderSwatchChanged(), PCB_LAYER_WIDGET::ReFill(), SelectLayerRow(), setLayerCheckbox(), SetLayerColor(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), PCB_LAYER_WIDGET::SyncLayerColors(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), UpdateLayerIcons(), and updateLayerRow().

◆ GetLayerRowCount()

int LAYER_WIDGET::GetLayerRowCount ( ) const

Function GetLayerRowCount returns the number of rows in the layer tab.

Definition at line 623 of file layer_widget.cpp.

624 {
625  int controlCount = m_LayersFlexGridSizer->GetChildren().GetCount();
626  return controlCount / LYR_COLUMN_COUNT;
627 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130

References LYR_COLUMN_COUNT, and m_LayersFlexGridSizer.

Referenced by AppendLayerRow(), findLayerRow(), OnLeftDownLayers(), GERBER_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), OnRenderSwatchChanged(), PCB_LAYER_WIDGET::ReFill(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), PCB_LAYER_WIDGET::SyncLayerColors(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), and UpdateLayerIcons().

◆ getRenderComp()

wxWindow * LAYER_WIDGET::getRenderComp ( int  aRow,
int  aColumn 
) const
protected

Definition at line 286 of file layer_widget.cpp.

287 {
288  int ndx = aRow * RND_COLUMN_COUNT + aColumn;
289 
290  if( (unsigned) ndx < m_RenderFlexGridSizer->GetChildren().GetCount() )
291  return m_RenderFlexGridSizer->GetChildren()[ndx]->GetWindow();
292 
293  return NULL;
294 }
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:50
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133
#define NULL

References m_RenderFlexGridSizer, NULL, and RND_COLUMN_COUNT.

Referenced by findRenderRow(), GetRenderState(), OnRenderSwatchChanged(), SetRenderState(), and PCB_LAYER_WIDGET::SyncLayerColors().

◆ GetRenderRowCount()

int LAYER_WIDGET::GetRenderRowCount ( ) const

Function GetRenderRowCount returns the number of rows in the render tab.

Definition at line 630 of file layer_widget.cpp.

631 {
632  int controlCount = m_RenderFlexGridSizer->GetChildren().GetCount();
633  return controlCount / RND_COLUMN_COUNT;
634 }
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:50
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133

References m_RenderFlexGridSizer, and RND_COLUMN_COUNT.

Referenced by AppendRenderRow(), findRenderRow(), OnRenderSwatchChanged(), and PCB_LAYER_WIDGET::SyncLayerColors().

◆ GetRenderState()

bool LAYER_WIDGET::GetRenderState ( int  aId)

Function GetRenderState returns the state of the checkbox associated with aId.

Returns
bool - true if checked, else false.

Definition at line 792 of file layer_widget.cpp.

793 {
794  int row = findRenderRow( aId );
795 
796  if( row >= 0 )
797  {
798  int col = 1; // checkbox is column 1
799  wxCheckBox* cb = (wxCheckBox*) getRenderComp( row, col );
800  wxASSERT( cb );
801  return cb->GetValue();
802  }
803 
804  return false; // the value of a non-existent row
805 }
int findRenderRow(int aId) const
wxWindow * getRenderComp(int aRow, int aColumn) const

References findRenderRow(), and getRenderComp().

◆ GetSelectedLayer()

LAYER_NUM LAYER_WIDGET::GetSelectedLayer ( )

Function GetSelectedLayer returns the selected layer or -1 if none.

Definition at line 706 of file layer_widget.cpp.

707 {
708  wxWindow* w = getLayerComp( m_CurrentRow, 0 );
709  if( w )
710  return getDecodedId( w->GetId() );
711 
712  return UNDEFINED_LAYER;
713 }
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:136
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.

References getDecodedId(), getLayerComp(), m_CurrentRow, and UNDEFINED_LAYER.

◆ insertLayerRow()

void LAYER_WIDGET::insertLayerRow ( int  aRow,
const ROW aSpec 
)
protected

Function insertLayerRow appends or inserts a new row in the layer portion of the widget.

Definition at line 315 of file layer_widget.cpp.

316 {
317  wxASSERT( aRow >= 0 );
318 
319  int col;
320  int index = aRow * LYR_COLUMN_COUNT;
321  const int flags = wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT;
322 
323  // column 0
324  col = COLUMN_ICON_ACTIVE;
326  ROW_ICON_PROVIDER::STATE::OFF, encodeId( col, aSpec.id ) );
327  sbm->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
328  m_LayersFlexGridSizer->wxSizer::Insert( index+col, sbm, 0, flags );
329 
330  // column 1 (COLUMN_COLORBM)
331  col = COLUMN_COLORBM;
332 
333  auto bmb = new COLOR_SWATCH( m_LayerScrolledWindow, aSpec.color, encodeId( col, aSpec.id ),
334  getBackgroundLayerColor(), aSpec.defaultColor, false );
335  bmb->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
336  bmb->Bind( COLOR_SWATCH_CHANGED, &LAYER_WIDGET::OnLayerSwatchChanged, this );
337  bmb->SetToolTip( _("Left double click or middle click for color change, right click for menu" ) );
338  m_LayersFlexGridSizer->wxSizer::Insert( index+col, bmb, 0, flags );
339 
340  // column 2 (COLUMN_COLOR_LYR_CB)
341  col = COLUMN_COLOR_LYR_CB;
342  wxCheckBox* cb = new wxCheckBox( m_LayerScrolledWindow, encodeId( col, aSpec.id ), wxEmptyString );
343  cb->SetValue( aSpec.state );
344  cb->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED, &LAYER_WIDGET::OnLayerCheckBox, this );
345  cb->SetToolTip( _( "Enable this for visibility" ) );
346  m_LayersFlexGridSizer->wxSizer::Insert( index+col, cb, 0, flags );
347 
348  // column 3 (COLUMN_COLOR_LYRNAME)
349  col = COLUMN_COLOR_LYRNAME;
350  wxStaticText* st = new wxStaticText( m_LayerScrolledWindow, encodeId( col, aSpec.id ), aSpec.rowName );
351  shrinkFont( st, m_PointSize );
352  st->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
353  st->SetToolTip( aSpec.tooltip );
354  m_LayersFlexGridSizer->wxSizer::Insert( index+col, st, 0, flags );
355 
356  // column 4 (COLUMN_ALPHA_INDICATOR)
359  ROW_ICON_PROVIDER::STATE::OFF, wxID_ANY );
360  m_LayersFlexGridSizer->wxSizer::Insert( index+col, sbm, 0, flags );
361 
362  // Bind right click eventhandler to all columns
363  wxString layerName( aSpec.rowName );
364 
365  sbm->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt )
366  {
367  OnRightDownLayer( aEvt, bmb, layerName );
368  } );
369  bmb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt )
370  {
371  OnRightDownLayer( aEvt, bmb, layerName );
372  } );
373  cb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt )
374  {
375  OnRightDownLayer( aEvt, bmb, layerName );
376  } );
377  st->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt )
378  {
379  OnRightDownLayer( aEvt, bmb, layerName );
380  } );
381 }
#define COLUMN_COLOR_LYRNAME
Definition: layer_widget.h:55
void OnLeftDownLayers(wxMouseEvent &event)
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:49
#define COLUMN_ALPHA_INDICATOR
Definition: layer_widget.h:56
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130
static void shrinkFont(wxWindow *aControl, int aPointSize)
Function shrinkFont reduces the size of the wxFont associated with aControl.
void OnLayerCheckBox(wxCommandEvent &event)
Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the clie...
static int encodeId(int aColumn, int aId)
Function encodeId is here to allow saving a layer index within a control as its wxControl id,...
representing a row indicator icon for use in places like the layer widget
#define COLUMN_ICON_ACTIVE
Definition: layer_widget.h:52
#define COLUMN_COLORBM
Definition: layer_widget.h:53
#define OFF
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:129
void OnRightDownLayer(wxMouseEvent &event, COLOR_SWATCH *aColorSwatch, const wxString &aLayerName)
Function OnRightDownLayer Called when user right-clicks a layer.
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:54
#define _(s)
Definition: 3d_actions.cpp:33
virtual COLOR4D getBackgroundLayerColor()
Subclasses can override this to provide accurate representation of transparent colour swatches.
Definition: layer_widget.h:155
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
void OnLayerSwatchChanged(wxCommandEvent &aEvent)
Function OnSwatchChanged() is called when a user changes a swatch color.
ROW_ICON_PROVIDER * m_IconProvider
Definition: layer_widget.h:139

References _, LAYER_WIDGET::ROW::color, COLUMN_ALPHA_INDICATOR, COLUMN_COLOR_LYR_CB, COLUMN_COLOR_LYRNAME, COLUMN_COLORBM, COLUMN_ICON_ACTIVE, LAYER_WIDGET::ROW::defaultColor, encodeId(), getBackgroundLayerColor(), LAYER_WIDGET::ROW::id, LYR_COLUMN_COUNT, m_IconProvider, m_LayerScrolledWindow, m_LayersFlexGridSizer, m_PointSize, OFF, OnLayerCheckBox(), OnLayerSwatchChanged(), OnLeftDownLayers(), OnRightDownLayer(), LAYER_WIDGET::ROW::rowName, shrinkFont(), LAYER_WIDGET::ROW::state, and LAYER_WIDGET::ROW::tooltip.

Referenced by AppendLayerRow().

◆ insertRenderRow()

void LAYER_WIDGET::insertRenderRow ( int  aRow,
const ROW aSpec 
)
protected

Definition at line 405 of file layer_widget.cpp.

406 {
407  wxASSERT( aRow >= 0 );
408 
409  int col;
410  int index = aRow * RND_COLUMN_COUNT;
411  const int flags = wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT;
412 
413  wxString renderName( aSpec.rowName );
414  wxCheckBox* cb = nullptr;
415 
416  // column 1
417  if( !aSpec.spacer )
418  {
419  col = 1;
420  cb = new wxCheckBox( m_RenderScrolledWindow, encodeId( col, aSpec.id ),
421  aSpec.rowName, wxDefaultPosition, wxDefaultSize, wxALIGN_LEFT );
422  shrinkFont( cb, m_PointSize );
423  cb->SetValue( aSpec.state );
424  cb->Enable( aSpec.changeable );
425  cb->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED, &LAYER_WIDGET::OnRenderCheckBox, this );
426  cb->SetToolTip( aSpec.tooltip );
427  }
428 
429  // column 0
430  col = 0;
431  if( aSpec.color != COLOR4D::UNSPECIFIED )
432  {
433  auto bmb = new COLOR_SWATCH( m_RenderScrolledWindow, aSpec.color, encodeId( col, aSpec.id ),
434  getBackgroundLayerColor(), aSpec.defaultColor, false );
435  bmb->Bind( COLOR_SWATCH_CHANGED, &LAYER_WIDGET::OnRenderSwatchChanged, this );
436  bmb->SetToolTip( _( "Left double click or middle click for color change" ) );
437  m_RenderFlexGridSizer->wxSizer::Insert( index+col, bmb, 0, flags );
438 
439  bmb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, renderName] ( wxMouseEvent& aEvt ) {
440  OnRightDownRender( aEvt, bmb, renderName );
441  } );
442  cb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, renderName] ( wxMouseEvent& aEvt ) {
443  OnRightDownRender( aEvt, bmb, renderName );
444  } );
445 
446  // could add a left click handler on the color button that toggles checkbox.
447  }
448  else // == -1, no color selection wanted
449  {
450  // need a place holder within the sizer to keep grid full.
451  wxPanel* invisible = new wxPanel( m_RenderScrolledWindow, encodeId( col, aSpec.id ) );
452  m_RenderFlexGridSizer->wxSizer::Insert( index+col, invisible, 0, flags );
453  }
454 
455  // Items have to be inserted in order
456  col = 1;
457 
458  if( aSpec.spacer )
459  {
460  wxPanel* invisible = new wxPanel( m_RenderScrolledWindow, wxID_ANY );
461  m_RenderFlexGridSizer->wxSizer::Insert( index+col, invisible, 0, flags );
462  }
463  else
464  {
465  m_RenderFlexGridSizer->wxSizer::Insert( index+col, cb, 0, flags );
466  }
467 }
wxScrolledWindow * m_RenderScrolledWindow
Definition: layer_widget.h:132
static void shrinkFont(wxWindow *aControl, int aPointSize)
Function shrinkFont reduces the size of the wxFont associated with aControl.
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:50
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133
void OnRenderCheckBox(wxCommandEvent &event)
static int encodeId(int aColumn, int aId)
Function encodeId is here to allow saving a layer index within a control as its wxControl id,...
void OnRightDownRender(wxMouseEvent &aEvent, COLOR_SWATCH *aColorSwatch, const wxString &aRenderName)
Function OnRightDownRender Called when user right-clicks a render option.
void OnRenderSwatchChanged(wxCommandEvent &aEvent)
Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry.
#define _(s)
Definition: 3d_actions.cpp:33
virtual COLOR4D getBackgroundLayerColor()
Subclasses can override this to provide accurate representation of transparent colour swatches.
Definition: layer_widget.h:155
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38

References _, LAYER_WIDGET::ROW::changeable, LAYER_WIDGET::ROW::color, LAYER_WIDGET::ROW::defaultColor, encodeId(), getBackgroundLayerColor(), LAYER_WIDGET::ROW::id, m_PointSize, m_RenderFlexGridSizer, m_RenderScrolledWindow, OnRenderCheckBox(), OnRenderSwatchChanged(), OnRightDownRender(), RND_COLUMN_COUNT, LAYER_WIDGET::ROW::rowName, shrinkFont(), LAYER_WIDGET::ROW::spacer, LAYER_WIDGET::ROW::state, and LAYER_WIDGET::ROW::tooltip.

Referenced by AppendRenderRow().

◆ IsLayerVisible()

bool LAYER_WIDGET::IsLayerVisible ( LAYER_NUM  aLayer)

Function IsLayerVisible returns the visible state of the layer ROW associated with aLayer id.

Definition at line 735 of file layer_widget.cpp.

736 {
737  int row = findLayerRow( aLayer );
738  if( row >= 0 )
739  {
740  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
741  wxASSERT( cb );
742  return cb->GetValue();
743  }
744  return false;
745 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:54

References COLUMN_COLOR_LYR_CB, findLayerRow(), and getLayerComp().

Referenced by GERBVIEW_FRAME::IsLayerVisible().

◆ OnLayerCheckBox()

void LAYER_WIDGET::OnLayerCheckBox ( wxCommandEvent &  event)
protected

Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the client's notification function.

Definition at line 166 of file layer_widget.cpp.

167 {
168  wxCheckBox* eventSource = (wxCheckBox*) event.GetEventObject();
169  LAYER_NUM layer = getDecodedId( eventSource->GetId() );
170  OnLayerVisible( layer, eventSource->IsChecked() );
171  passOnFocus();
172 }
virtual void OnLayerVisible(LAYER_NUM aLayer, bool isVisible, bool isFinal=true)=0
Function OnLayerVisible is called to notify client code about a layer visibility change.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.

References getDecodedId(), OnLayerVisible(), and passOnFocus().

Referenced by insertLayerRow().

◆ OnLayerColorChange()

virtual void LAYER_WIDGET::OnLayerColorChange ( int  aLayer,
COLOR4D  aColor 
)
pure virtual

Function OnLayerColorChange is called to notify client code about a layer color change.

Derived es will handle this accordingly.

Parameters
aLayeris the board layer to change
aColoris the new color

Implemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Referenced by OnLayerSwatchChanged().

◆ OnLayerRightClick()

virtual void LAYER_WIDGET::OnLayerRightClick ( wxMenu &  aMenu)
pure virtual

Function OnLayerRightClick is called to notify client code about a layer being right-clicked.

Parameters
aMenuis the right-click menu containing layer-scoped options. It can be used to add extra, wider scoped menu items.

Implemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Referenced by OnRightDownLayer().

◆ OnLayerSelect()

virtual bool LAYER_WIDGET::OnLayerSelect ( int  aLayer)
pure virtual

Function OnLayerSelect is called to notify client code whenever the user selects a different layer.

Derived classes will handle this accordingly, and can deny the change by returning false.

Parameters
aLayeris the board layer to select

Implemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Referenced by OnLeftDownLayers().

◆ OnLayerSwatchChanged()

void LAYER_WIDGET::OnLayerSwatchChanged ( wxCommandEvent &  aEvent)
protected

Function OnSwatchChanged() is called when a user changes a swatch color.

Definition at line 149 of file layer_widget.cpp.

150 {
151  COLOR_SWATCH* eventSource = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
152  COLOR4D newColor = eventSource->GetSwatchColor();
153  LAYER_NUM layer = getDecodedId( eventSource->GetId() );
154 
155  // tell the client code.
156  OnLayerColorChange( layer, newColor );
157 
158  // notify others
159  wxCommandEvent event( EVT_LAYER_COLOR_CHANGE );
160  wxPostEvent( this, event );
161 
162  passOnFocus();
163 }
KIGFX::COLOR4D GetSwatchColor() const
static const wxEventType EVT_LAYER_COLOR_CHANGE
Definition: layer_widget.h:123
virtual void OnLayerColorChange(int aLayer, COLOR4D aColor)=0
Function OnLayerColorChange is called to notify client code about a layer color change.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References EVT_LAYER_COLOR_CHANGE, getDecodedId(), COLOR_SWATCH::GetSwatchColor(), OnLayerColorChange(), and passOnFocus().

Referenced by insertLayerRow().

◆ OnLayerVisible()

virtual void LAYER_WIDGET::OnLayerVisible ( LAYER_NUM  aLayer,
bool  isVisible,
bool  isFinal = true 
)
pure virtual

Function OnLayerVisible is called to notify client code about a layer visibility change.

Parameters
aLayeris the board layer to select
isVisibleis the new visible state
isFinalis true when this is the last of potentially several such calls, and can be used to decide when to update the screen only one time instead of several times in the midst of a multiple layer change.

Implemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Referenced by OnLayerCheckBox(), and SetLayerVisible().

◆ OnLeftDownLayers()

void LAYER_WIDGET::OnLeftDownLayers ( wxMouseEvent &  event)
protected

Definition at line 77 of file layer_widget.cpp.

78 {
79  int row;
80  LAYER_NUM layer;
81 
82  wxWindow* eventSource = (wxWindow*) event.GetEventObject();
83 
84  // if mouse event is coming from the m_LayerScrolledWindow and not one
85  // of its children, we have to find the row manually based on y coord.
86  if( eventSource == m_LayerScrolledWindow )
87  {
88  int y = event.GetY();
89 
90  wxArrayInt heights = m_LayersFlexGridSizer->GetRowHeights();
91 
92  int height = 0;
93 
94  int rowCount = GetLayerRowCount();
95  for( row = 0; row<rowCount; ++row )
96  {
97  if( y < height + heights[row] )
98  break;
99 
100  height += heights[row];
101  }
102 
103  if( row >= rowCount )
104  row = rowCount - 1;
105 
106  layer = getDecodedId( getLayerComp( row, 0 )->GetId() );
107  }
108 
109  else
110  {
111  // all nested controls on a given row will have their ID encoded with
112  // encodeId(), and the corresponding decoding is getDecodedId()
113  int id = eventSource->GetId();
114  layer = getDecodedId( id );
115  row = findLayerRow( layer );
116  }
117 
118  if( OnLayerSelect( layer ) ) // if client allows this change.
119  SelectLayerRow( row );
120 
121  passOnFocus();
122 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:129
void SelectLayerRow(int aRow)
Function SelectLayerRow changes the row selection in the layer list to the given row.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
virtual bool OnLayerSelect(int aLayer)=0
Function OnLayerSelect is called to notify client code whenever the user selects a different layer.

References findLayerRow(), getDecodedId(), getLayerComp(), GetLayerRowCount(), m_LayerScrolledWindow, m_LayersFlexGridSizer, OnLayerSelect(), passOnFocus(), and SelectLayerRow().

Referenced by insertLayerRow().

◆ OnRenderCheckBox()

void LAYER_WIDGET::OnRenderCheckBox ( wxCommandEvent &  event)
protected

Definition at line 239 of file layer_widget.cpp.

240 {
241  wxCheckBox* eventSource = (wxCheckBox*) event.GetEventObject();
242  LAYER_NUM id = getDecodedId( eventSource->GetId() );
243  OnRenderEnable( id, eventSource->IsChecked() );
244  passOnFocus();
245 }
virtual void OnRenderEnable(int aId, bool isEnabled)=0
Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.

References getDecodedId(), OnRenderEnable(), and passOnFocus().

Referenced by insertRenderRow().

◆ OnRenderColorChange()

virtual void LAYER_WIDGET::OnRenderColorChange ( int  aId,
COLOR4D  aColor 
)
pure virtual

Function OnRenderColorChange is called to notify client code whenever the user changes a rendering color.

Parameters
aIdis the same id that was established in a Rendering row via the AddRenderRow() function.
aColoris the new color

Implemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Referenced by OnRenderSwatchChanged().

◆ OnRenderEnable()

virtual void LAYER_WIDGET::OnRenderEnable ( int  aId,
bool  isEnabled 
)
pure virtual

Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable in one of the rendering checkboxes.

Parameters
aIdis the same id that was established in a Rendering row via the AddRenderRow() function.
isEnabledis the state of the checkbox, true if checked.

Implemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Referenced by OnRenderCheckBox().

◆ OnRenderSwatchChanged()

void LAYER_WIDGET::OnRenderSwatchChanged ( wxCommandEvent &  aEvent)
protected

Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry.

Definition at line 197 of file layer_widget.cpp.

198 {
199  auto eventSource = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
200 
201  COLOR4D newColor = eventSource->GetSwatchColor();
202 
203  LAYER_NUM id = getDecodedId( eventSource->GetId() );
204 
205  if( id == LAYER_PCB_BACKGROUND )
206  {
207  // Update all swatch backgrounds
208  int count = GetLayerRowCount();
209  int row;
210  int col = 1; // bitmap button is column 1 in layers tab
211 
212  for( row = 0; row < count; ++row )
213  {
214  COLOR_SWATCH* swatch = dynamic_cast<COLOR_SWATCH*>( getLayerComp( row, col ) );
215 
216  if( swatch )
217  swatch->SetSwatchBackground( newColor );
218  }
219 
220  count = GetRenderRowCount();
221  col = 0; // bitmap button is column 0 in render tab
222 
223  for( row = 0; row < count; ++row )
224  {
225  COLOR_SWATCH* swatch = dynamic_cast<COLOR_SWATCH*>( getRenderComp( row, col ) );
226 
227  if( swatch )
228  swatch->SetSwatchBackground( newColor );
229  }
230  }
231 
232  // tell the client code.
233  OnRenderColorChange( id, newColor );
234 
235  passOnFocus();
236 }
virtual void OnRenderColorChange(int aId, COLOR4D aColor)=0
Function OnRenderColorChange is called to notify client code whenever the user changes a rendering co...
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
void SetSwatchBackground(KIGFX::COLOR4D aBackground)
Set the swatch background color.
wxWindow * getRenderComp(int aRow, int aColumn) const
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References getDecodedId(), getLayerComp(), GetLayerRowCount(), getRenderComp(), GetRenderRowCount(), LAYER_PCB_BACKGROUND, OnRenderColorChange(), passOnFocus(), and COLOR_SWATCH::SetSwatchBackground().

Referenced by insertRenderRow().

◆ OnRightDownLayer()

void LAYER_WIDGET::OnRightDownLayer ( wxMouseEvent &  event,
COLOR_SWATCH aColorSwatch,
const wxString &  aLayerName 
)
protected

Function OnRightDownLayer Called when user right-clicks a layer.

Definition at line 125 of file layer_widget.cpp.

126 {
127  wxMenu menu;
128 
130  _( "Change Layer Color for " ) + aLayerName,
132  menu.AppendSeparator();
133 
134  OnLayerRightClick( menu );
135 
136  menu.Bind( wxEVT_COMMAND_MENU_SELECTED, [aColorSwatch]( wxCommandEvent& event ) {
137  if ( event.GetId() == ID_CHANGE_LAYER_COLOR ) {
138  aColorSwatch->GetNewSwatchColor();
139  } else {
140  event.Skip();
141  }
142  } );
143 
144  PopupMenu( &menu );
145  passOnFocus();
146 }
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Function AddMenuItem is an inline helper function to create and insert a menu item with an icon into ...
Definition: bitmap.cpp:232
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
const BITMAP_OPAQUE setcolor_copper_xpm[1]
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
#define _(s)
Definition: 3d_actions.cpp:33
virtual void OnLayerRightClick(wxMenu &aMenu)=0
Function OnLayerRightClick is called to notify client code about a layer being right-clicked.
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.

References _, AddMenuItem(), COLOR_SWATCH::GetNewSwatchColor(), ID_CHANGE_LAYER_COLOR, KiBitmap(), OnLayerRightClick(), passOnFocus(), and setcolor_copper_xpm.

Referenced by insertLayerRow().

◆ OnRightDownRender()

void LAYER_WIDGET::OnRightDownRender ( wxMouseEvent &  aEvent,
COLOR_SWATCH aColorSwatch,
const wxString &  aRenderName 
)
protected

Function OnRightDownRender Called when user right-clicks a render option.

Definition at line 175 of file layer_widget.cpp.

176 {
177  wxMenu menu;
178 
180  _( "Change Render Color for " ) + aRenderName,
182 
183  menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
184  [aColorSwatch]( wxCommandEvent& event )
185  {
186  if( event.GetId() == ID_CHANGE_RENDER_COLOR )
187  aColorSwatch->GetNewSwatchColor();
188  else
189  event.Skip();
190  } );
191 
192  PopupMenu( &menu );
193  passOnFocus();
194 }
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Function AddMenuItem is an inline helper function to create and insert a menu item with an icon into ...
Definition: bitmap.cpp:232
const BITMAP_OPAQUE setcolor_board_body_xpm[1]
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
#define _(s)
Definition: 3d_actions.cpp:33
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.

References _, AddMenuItem(), COLOR_SWATCH::GetNewSwatchColor(), ID_CHANGE_RENDER_COLOR, KiBitmap(), passOnFocus(), and setcolor_board_body_xpm.

Referenced by insertRenderRow().

◆ OnTabChange()

void LAYER_WIDGET::OnTabChange ( wxNotebookEvent &  event)
protected

Definition at line 248 of file layer_widget.cpp.

249 {
250 // wxFocusEvent event( wxEVT_SET_FOCUS );
251 // m_FocusOwner->AddPendingEvent( event );
252 
253  passOnFocus(); // does not work in this context, probably because we have receive control here too early.
254 }
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.

References passOnFocus().

Referenced by LAYER_WIDGET().

◆ passOnFocus()

void LAYER_WIDGET::passOnFocus ( )
protected

Function passOnFocus gives away the keyboard focus up to the main parent window.

Definition at line 470 of file layer_widget.cpp.

471 {
472  m_FocusOwner->SetFocus();
473 }
wxWindow * m_FocusOwner
Definition: layer_widget.h:135

References m_FocusOwner.

Referenced by OnLayerCheckBox(), OnLayerSwatchChanged(), OnLeftDownLayers(), OnRenderCheckBox(), OnRenderSwatchChanged(), OnRightDownLayer(), GERBER_LAYER_WIDGET::onRightDownLayers(), PCB_LAYER_WIDGET::onRightDownLayers(), OnRightDownRender(), OnTabChange(), and SelectLayerRow().

◆ SelectLayer()

void LAYER_WIDGET::SelectLayer ( LAYER_NUM  aLayer)

Function SelectLayer changes the row selection in the layer list to aLayer provided.

Definition at line 699 of file layer_widget.cpp.

700 {
701  int row = findLayerRow( aLayer );
702  SelectLayerRow( row );
703 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
void SelectLayerRow(int aRow)
Function SelectLayerRow changes the row selection in the layer list to the given row.

References findLayerRow(), and SelectLayerRow().

Referenced by GERBVIEW_FRAME::SetActiveLayer(), GERBVIEW_FRAME::syncLayerWidget(), and FOOTPRINT_EDIT_FRAME::UpdateUserInterface().

◆ SelectLayerRow()

void LAYER_WIDGET::SelectLayerRow ( int  aRow)

Function SelectLayerRow changes the row selection in the layer list to the given row.

Definition at line 663 of file layer_widget.cpp.

664 {
665  // enable the layer tab at index 0
666  m_notebook->SetSelection( 0 );
667 
668  INDICATOR_ICON* oldIndicator = (INDICATOR_ICON*) getLayerComp( m_CurrentRow, 0 );
669 
670  if( oldIndicator )
671  {
673  oldIndicator->SetIndicatorState( ROW_ICON_PROVIDER::STATE::DIMMED );
674  else
676  }
677 
678  INDICATOR_ICON* newIndicator = (INDICATOR_ICON*) getLayerComp( aRow, 0 );
679 
680  if( newIndicator )
681  {
683 
684  // Make sure the desired layer row is visible.
685  // It seems that as of 2.8.2, setting the focus does this.
686  // I don't expect the scrolling to be needed at all because
687  // the minimum window size may end up being established so that the
688  // scroll bars will not be visible.
689  getLayerComp( aRow, 1 )->SetFocus();
690  }
691 
692  m_CurrentRow = aRow;
693 
694  // give the focus back to the app.
695  passOnFocus();
696 }
void SetIndicatorState(ICON_ID aIconId)
Sets the row indiciator to the given state.
wxAuiNotebook * m_notebook
Definition: layer_widget.h:127
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:136
#define ON
virtual bool useAlternateBitmap(int aRow)
Virtual Function useAlternateBitmap.
Definition: layer_widget.h:149
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
representing a row indicator icon for use in places like the layer widget
#define OFF
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.

References getLayerComp(), m_CurrentRow, m_notebook, OFF, ON, passOnFocus(), INDICATOR_ICON::SetIndicatorState(), and useAlternateBitmap().

Referenced by OnLeftDownLayers(), and SelectLayer().

◆ setLayerCheckbox()

void LAYER_WIDGET::setLayerCheckbox ( LAYER_NUM  aLayer,
bool  isVisible 
)
protected

Definition at line 723 of file layer_widget.cpp.

724 {
725  int row = findLayerRow( aLayer );
726  if( row >= 0 )
727  {
728  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
729  wxASSERT( cb );
730  cb->SetValue( isVisible ); // does not fire an event
731  }
732 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:54

References COLUMN_COLOR_LYR_CB, findLayerRow(), and getLayerComp().

Referenced by SetLayerVisible(), and PCB_LAYER_WIDGET::SyncLayerVisibilities().

◆ SetLayerColor()

void LAYER_WIDGET::SetLayerColor ( LAYER_NUM  aLayer,
COLOR4D  aColor 
)

Function SetLayerColor changes the color of aLayer.

Definition at line 748 of file layer_widget.cpp.

749 {
750  int row = findLayerRow( aLayer );
751  if( row >= 0 )
752  {
753  int col = 1; // bitmap button is column 1
754  auto swatch = static_cast<COLOR_SWATCH*>( getLayerComp( row, col ) );
755  wxASSERT( swatch );
756 
757  swatch->SetSwatchColor( aColor, false );
758  }
759 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...

References findLayerRow(), and getLayerComp().

◆ SetLayerVisible()

void LAYER_WIDGET::SetLayerVisible ( LAYER_NUM  aLayer,
bool  isVisible 
)

Function SetLayerVisible sets aLayer visible or not.

This does not invoke OnLayerVisible().

Definition at line 716 of file layer_widget.cpp.

717 {
718  setLayerCheckbox( aLayer, isVisible );
719  OnLayerVisible( aLayer, isVisible );
720 }
virtual void OnLayerVisible(LAYER_NUM aLayer, bool isVisible, bool isFinal=true)=0
Function OnLayerVisible is called to notify client code about a layer visibility change.
void setLayerCheckbox(LAYER_NUM aLayer, bool isVisible)

References OnLayerVisible(), and setLayerCheckbox().

Referenced by DIALOG_DRC::OnDRCItemSelected(), and ROUTER_TOOL::prepareInteractive().

◆ SetRenderState()

void LAYER_WIDGET::SetRenderState ( int  aId,
bool  isSet 
)

Function SetRenderState sets the state of the checkbox associated with aId within the Render tab group of the widget.

Does not fire an event, i.e. does not invoke OnRenderEnable().

Parameters
aIdis the same unique id used when adding a ROW to the Render tab.
isSet= the new checkbox state

Definition at line 778 of file layer_widget.cpp.

779 {
780  int row = findRenderRow( aId );
781 
782  if( row >= 0 )
783  {
784  int col = 1; // checkbox is column 1
785  wxCheckBox* cb = (wxCheckBox*) getRenderComp( row, col );
786  wxASSERT( cb );
787  cb->SetValue( isSet ); // does not fire an event
788  }
789 }
int findRenderRow(int aId) const
wxWindow * getRenderComp(int aRow, int aColumn) const

References findRenderRow(), and getRenderComp().

Referenced by GERBVIEW_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), PCB_BASE_EDIT_FRAME::SetGridVisibility(), and GERBVIEW_FRAME::SetGridVisibility().

◆ UpdateLayerIcons()

void LAYER_WIDGET::UpdateLayerIcons ( )

Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or clearing a layer because they change, and the indicator arrow icon needs to be updated.

Definition at line 818 of file layer_widget.cpp.

819 {
820  int rowCount = GetLayerRowCount();
821 
822  for( int row = 0; row < rowCount ; row++ )
823  {
825 
826  if( indicator )
827  {
829 
830  if( row == m_CurrentRow )
832  else if( useAlternateBitmap( row ) )
833  state = ROW_ICON_PROVIDER::STATE::DIMMED;
834  else
836 
837  indicator->SetIndicatorState( state );
838  }
839  }
840 }
void SetIndicatorState(ICON_ID aIconId)
Sets the row indiciator to the given state.
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:136
#define ON
virtual bool useAlternateBitmap(int aRow)
Virtual Function useAlternateBitmap.
Definition: layer_widget.h:149
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
representing a row indicator icon for use in places like the layer widget
#define COLUMN_ICON_ACTIVE
Definition: layer_widget.h:52
#define OFF
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
STATE
State constants to select the right icons

References COLUMN_ICON_ACTIVE, getLayerComp(), GetLayerRowCount(), m_CurrentRow, OFF, ON, INDICATOR_ICON::SetIndicatorState(), and useAlternateBitmap().

Referenced by GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), and GERBVIEW_FRAME::LoadZipArchiveFile().

◆ updateLayerRow()

void LAYER_WIDGET::updateLayerRow ( int  aRow,
const wxString &  aName 
)
protected

Definition at line 384 of file layer_widget.cpp.

385 {
386  wxStaticText* label = dynamic_cast<wxStaticText*>( getLayerComp( aRow, COLUMN_COLOR_LYRNAME ) );
387 
388  if( label )
389  label->SetLabel( aName );
390 
391  INDICATOR_ICON* indicator = (INDICATOR_ICON*) getLayerComp( aRow, 0 );
392 
393  if( indicator )
394  {
395  if( aRow == m_CurrentRow )
397  if( useAlternateBitmap( aRow ) )
398  indicator->SetIndicatorState( ROW_ICON_PROVIDER::STATE::DIMMED );
399  else
401  }
402 }
#define COLUMN_COLOR_LYRNAME
Definition: layer_widget.h:55
void SetIndicatorState(ICON_ID aIconId)
Sets the row indiciator to the given state.
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:136
#define ON
virtual bool useAlternateBitmap(int aRow)
Virtual Function useAlternateBitmap.
Definition: layer_widget.h:149
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
representing a row indicator icon for use in places like the layer widget
#define OFF

References COLUMN_COLOR_LYRNAME, getLayerComp(), m_CurrentRow, OFF, ON, INDICATOR_ICON::SetIndicatorState(), and useAlternateBitmap().

Referenced by GERBER_LAYER_WIDGET::ReFill().

◆ UpdateLayouts()

void LAYER_WIDGET::UpdateLayouts ( )

Definition at line 808 of file layer_widget.cpp.

809 {
810  m_LayersFlexGridSizer->Layout();
811  m_RenderFlexGridSizer->Layout();
812  m_LayerPanel->Layout();
813  m_RenderingPanel->Layout();
814  FitInside();
815 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:130
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:133
wxPanel * m_RenderingPanel
Definition: layer_widget.h:131
wxPanel * m_LayerPanel
Definition: layer_widget.h:128

References m_LayerPanel, m_LayersFlexGridSizer, m_RenderFlexGridSizer, and m_RenderingPanel.

Referenced by AppendLayerRows(), AppendRenderRows(), PCB_LAYER_WIDGET::ReFill(), GERBER_LAYER_WIDGET::ReFill(), and PCB_LAYER_WIDGET::ReFillRender().

◆ useAlternateBitmap()

virtual bool LAYER_WIDGET::useAlternateBitmap ( int  aRow)
inlineprotectedvirtual

Virtual Function useAlternateBitmap.

Returns
true if bitmaps shown in Render layer list are alternate bitmaps, or false if they are "normal" bitmaps This is a virtual function because Pcbnew uses normal bitmaps but GerbView uses both bitmaps (alternate bitmaps to show layers in use, normal fo others)

Reimplemented in GERBER_LAYER_WIDGET.

Definition at line 149 of file layer_widget.h.

149 { return false; }

Referenced by SelectLayerRow(), UpdateLayerIcons(), and updateLayerRow().

Member Data Documentation

◆ EVT_LAYER_COLOR_CHANGE

const wxEventType LAYER_WIDGET::EVT_LAYER_COLOR_CHANGE = wxNewEventType()
static

Definition at line 123 of file layer_widget.h.

Referenced by OnLayerSwatchChanged().

◆ m_CurrentRow

int LAYER_WIDGET::m_CurrentRow
protected

selected row of layer list

Definition at line 136 of file layer_widget.h.

Referenced by GetSelectedLayer(), LAYER_WIDGET(), SelectLayerRow(), UpdateLayerIcons(), and updateLayerRow().

◆ m_FocusOwner

wxWindow* LAYER_WIDGET::m_FocusOwner
protected

Definition at line 135 of file layer_widget.h.

Referenced by LAYER_WIDGET(), and passOnFocus().

◆ m_IconProvider

ROW_ICON_PROVIDER* LAYER_WIDGET::m_IconProvider
protected

Definition at line 139 of file layer_widget.h.

Referenced by insertLayerRow(), LAYER_WIDGET(), and ~LAYER_WIDGET().

◆ m_LayerPanel

wxPanel* LAYER_WIDGET::m_LayerPanel
protected

Definition at line 128 of file layer_widget.h.

Referenced by GetBestSize(), LAYER_WIDGET(), and UpdateLayouts().

◆ m_LayerScrolledWindow

wxScrolledWindow* LAYER_WIDGET::m_LayerScrolledWindow
protected

◆ m_LayersFlexGridSizer

wxFlexGridSizer* LAYER_WIDGET::m_LayersFlexGridSizer
protected

◆ m_notebook

wxAuiNotebook* LAYER_WIDGET::m_notebook
protected

◆ m_PointSize

int LAYER_WIDGET::m_PointSize
protected

Definition at line 137 of file layer_widget.h.

Referenced by insertLayerRow(), insertRenderRow(), and LAYER_WIDGET().

◆ m_RenderFlexGridSizer

wxFlexGridSizer* LAYER_WIDGET::m_RenderFlexGridSizer
protected

◆ m_RenderingPanel

wxPanel* LAYER_WIDGET::m_RenderingPanel
protected

Definition at line 131 of file layer_widget.h.

Referenced by GetBestSize(), LAYER_WIDGET(), and UpdateLayouts().

◆ m_RenderScrolledWindow

wxScrolledWindow* LAYER_WIDGET::m_RenderScrolledWindow
protected

Definition at line 132 of file layer_widget.h.

Referenced by insertRenderRow(), and LAYER_WIDGET().


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