KiCad PCB EDA Suite
LAYER_WIDGET Class Referenceabstract

Class 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, int aPointSize=-1, 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 bool AreArbitraryColorsAllowed ()
 Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPicker instead of DisplayColorFrame. 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 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
 

Detailed Description

Class 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 77 of file layer_widget.h.

Member Enumeration Documentation

enum LAYER_WIDGET::POPUP_ID
protected
Enumerator
ID_CHANGE_LAYER_COLOR 
ID_CHANGE_RENDER_COLOR 
ID_LAST_VALUE 

Definition at line 227 of file layer_widget.h.

Constructor & Destructor Documentation

LAYER_WIDGET::LAYER_WIDGET ( wxWindow *  aParent,
wxWindow *  aFocusOwner,
int  aPointSize = -1,
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
aPointSizeis the font point size to use within the widget. This effectively sets the overal size of the widget via the row height and bitmap button sizes.
idis the wxWindow id ( default = wxID_ANY)
posis the window position
sizeis the window size
styleis the window style every operation.

Definition at line 416 of file layer_widget.cpp.

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

417  :
418  wxPanel( aParent, id, pos, size, style )
419 {
420  wxBoxSizer* boxSizer = new wxBoxSizer( wxVERTICAL );
421 
422  m_notebook = new wxAuiNotebook( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxAUI_NB_TOP );
423 
424  wxFont font = m_notebook->GetFont();
425 
426  if( aPointSize == -1 )
427  {
428  m_PointSize = font.GetPointSize();
429  }
430  else
431  {
432  m_PointSize = aPointSize;
433 
434  // change the font size on the notebook's tabs to match aPointSize
435  font.SetPointSize( aPointSize );
436  m_notebook->SetFont( font );
437  m_notebook->SetNormalFont( font );
438  m_notebook->SetSelectedFont( font );
439  m_notebook->SetMeasuringFont( font );
440  }
441 
442  m_LayerPanel = new wxPanel( m_notebook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
443 
444  wxBoxSizer* bSizer3;
445  bSizer3 = new wxBoxSizer( wxVERTICAL );
446 
447  m_LayerScrolledWindow = new wxScrolledWindow( m_LayerPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER );
448  m_LayerScrolledWindow->SetScrollRate( 5, 5 );
449  m_LayersFlexGridSizer = new wxFlexGridSizer( 0, 4, 0, 1 );
450  m_LayersFlexGridSizer->SetFlexibleDirection( wxHORIZONTAL );
451  m_LayersFlexGridSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_NONE );
452 
454  m_LayerScrolledWindow->Layout();
456  bSizer3->Add( m_LayerScrolledWindow, 1, wxBOTTOM|wxEXPAND|wxLEFT|wxTOP, 2 );
457 
458  m_LayerPanel->SetSizer( bSizer3 );
459  m_LayerPanel->Layout();
460  bSizer3->Fit( m_LayerPanel );
461  m_notebook->AddPage( m_LayerPanel, _( "Layer" ), true );
462  m_RenderingPanel = new wxPanel( m_notebook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
463 
464  wxBoxSizer* bSizer4;
465  bSizer4 = new wxBoxSizer( wxVERTICAL );
466 
467  m_RenderScrolledWindow = new wxScrolledWindow( m_RenderingPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER );
468  m_RenderScrolledWindow->SetScrollRate( 5, 5 );
469  m_RenderFlexGridSizer = new wxFlexGridSizer( 0, 2, 0, 1 );
470  m_RenderFlexGridSizer->SetFlexibleDirection( wxHORIZONTAL );
471  m_RenderFlexGridSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_NONE );
472 
474  m_RenderScrolledWindow->Layout();
476  bSizer4->Add( m_RenderScrolledWindow, 1, wxALL|wxEXPAND, 5 );
477 
478  m_RenderingPanel->SetSizer( bSizer4 );
479  m_RenderingPanel->Layout();
480  bSizer4->Fit( m_RenderingPanel );
481  m_notebook->AddPage( m_RenderingPanel, _( "Render" ), false );
482 
483  boxSizer->Add( m_notebook, 1, wxEXPAND | wxALL, 5 );
484 
485  SetSizer( boxSizer );
486 
487  m_FocusOwner = aFocusOwner;
488 
489  m_CurrentRow = -1; // hide the arrow initially
490 
491  // trap the tab changes so that we can call passOnFocus().
492  m_notebook->Bind( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, &LAYER_WIDGET::OnTabChange, this );
493 
494  Layout();
495 }
wxAuiNotebook * m_notebook
Definition: layer_widget.h:110
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:119
void OnTabChange(wxNotebookEvent &event)
wxScrolledWindow * m_RenderScrolledWindow
Definition: layer_widget.h:115
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
wxPanel * m_RenderingPanel
Definition: layer_widget.h:114
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:112
wxWindow * m_FocusOwner
Definition: layer_widget.h:118
wxPanel * m_LayerPanel
Definition: layer_widget.h:111
LAYER_WIDGET::~LAYER_WIDGET ( )
virtual

Definition at line 498 of file layer_widget.cpp.

499 {
500 }

Member Function Documentation

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 572 of file layer_widget.cpp.

References GetLayerRowCount(), insertLayerRow(), and UpdateLayouts().

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

573 {
574  int nextRow = GetLayerRowCount();
575  insertLayerRow( nextRow, aRow );
576  UpdateLayouts();
577 }
void UpdateLayouts()
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.
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 286 of file layer_widget.h.

References AppendLayerRow().

287  {
288  for( int row=0; row<aRowCount; ++row )
289  AppendLayerRow( aRowsArray[row] );
290  }
void AppendLayerRow(const ROW &aRow)
Function AppendLayerRow appends a new row in the layer portion of the widget.
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 586 of file layer_widget.cpp.

References GetRenderRowCount(), insertRenderRow(), and UpdateLayouts().

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

587 {
588  int nextRow = GetRenderRowCount();
589  insertRenderRow( nextRow, aRow );
590  UpdateLayouts();
591 }
void insertRenderRow(int aRow, const ROW &aSpec)
void UpdateLayouts()
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.
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 310 of file layer_widget.h.

References AppendRenderRow().

Referenced by GERBER_LAYER_WIDGET::ReFillRender().

311  {
312  for( int row=0; row<aRowCount; ++row )
313  AppendRenderRow( aRowsArray[row] );
314  }
void AppendRenderRow(const ROW &aRow)
Function AppendRenderRow appends a new row in the render portion of the widget.
virtual bool LAYER_WIDGET::AreArbitraryColorsAllowed ( )
inlineprotectedvirtual

Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPicker instead of DisplayColorFrame.

Reimplemented in PCB_LAYER_WIDGET, and GERBER_LAYER_WIDGET.

Definition at line 136 of file layer_widget.h.

Referenced by insertLayerRow(), and insertRenderRow().

136 { return false; }
void LAYER_WIDGET::ClearLayerRows ( )

Function ClearLayerRows empties out the layer rows.

Definition at line 580 of file layer_widget.cpp.

References m_LayersFlexGridSizer.

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

581 {
582  m_LayersFlexGridSizer->Clear( true );
583 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
void LAYER_WIDGET::ClearRenderRows ( )

Function ClearRenderRows empties out the render rows.

Definition at line 594 of file layer_widget.cpp.

References m_RenderFlexGridSizer.

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

595 {
596  m_RenderFlexGridSizer->Clear( true );
597 }
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
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 68 of file layer_widget.cpp.

References LYR_COLUMN_COUNT.

Referenced by insertLayerRow(), and insertRenderRow().

69 {
70  int id = aId * LYR_COLUMN_COUNT + aColumn;
71  return id;
72 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
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 247 of file layer_widget.cpp.

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

Referenced by GetLayerColor(), IsLayerVisible(), OnLeftDownLayers(), SelectLayer(), SetLayerColor(), and SetLayerVisible().

248 {
249  int count = GetLayerRowCount();
250 
251  for( int row = 0; row < count; ++row )
252  {
253  // column 0 in the layer scroll window has a wxStaticBitmap, get its ID.
254  wxWindow* w = getLayerComp( row, 0 );
255  wxASSERT( w );
256 
257  if( aLayer == getDecodedId( w->GetId() ))
258  return row;
259  }
260 
261  return -1;
262 }
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_WIDGET::findRenderRow ( int  aId) const
protected

Definition at line 276 of file layer_widget.cpp.

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

Referenced by GetRenderState(), and SetRenderState().

277 {
278  int count = GetRenderRowCount();
279 
280  for( int row = 0; row < count; ++row )
281  {
282  // column 0 in the layer scroll window has a wxStaticBitmap, get its ID.
283  wxWindow* w = getRenderComp( row, 0 );
284  wxASSERT( w );
285 
286  if( aId == getDecodedId( w->GetId() ))
287  return row;
288  }
289 
290  return -1;
291 }
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
wxWindow * getRenderComp(int aRow, int aColumn) const
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 503 of file layer_widget.cpp.

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

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

504 {
505  // size of m_LayerScrolledWindow --------------
506  wxArrayInt widths = m_LayersFlexGridSizer->GetColWidths();
507  int totWidth = 0;
508 
509  if( widths.GetCount() )
510  {
511  for( int i = 0; i < LYR_COLUMN_COUNT; ++i )
512  {
513  totWidth += widths[i] + m_LayersFlexGridSizer->GetHGap();
514  // printf("widths[%d]:%d\n", i, widths[i] );
515  }
516  }
517 
518  // Account for the parent's frame:
519  totWidth += 10;
520 
521 
522  /* The minimum height is a small size to properly force computation
523  * of the panel's scrollbars (otherwise it will assume it *has* all
524  * this space) */
525  unsigned totHeight = 32;
526 
527  wxSize layerz( totWidth, totHeight );
528 
529  layerz += m_LayerPanel->GetWindowBorderSize();
530 
531 
532  // size of m_RenderScrolledWindow --------------
533  widths = m_RenderFlexGridSizer->GetColWidths();
534  totWidth = 0;
535 
536  if( widths.GetCount() )
537  {
538  for( int i = 0; i < RND_COLUMN_COUNT; ++i )
539  {
540  totWidth += widths[i] + m_RenderFlexGridSizer->GetHGap();
541  // printf("widths[%d]:%d\n", i, widths[i] );
542  }
543  }
544  // account for the parent's frame, this one has void space of 10 PLUS a border:
545  totWidth += 20;
546 
547  // For totHeight re-use the previous small one
548  wxSize renderz( totWidth, totHeight );
549 
550  renderz += m_RenderingPanel->GetWindowBorderSize();
551 
552  wxSize clientz( std::max(renderz.x,layerz.x), std::max(renderz.y,layerz.y) );
553 
554  return clientz;
555 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
wxPanel * m_RenderingPanel
Definition: layer_widget.h:114
#define max(a, b)
Definition: auxiliary.h:86
wxPanel * m_LayerPanel
Definition: layer_widget.h:111
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 75 of file layer_widget.cpp.

References LYR_COLUMN_COUNT.

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

76 {
77  int id = aControlId / LYR_COLUMN_COUNT; // rounding is OK.
78  return id;
79 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
COLOR4D LAYER_WIDGET::GetLayerColor ( LAYER_NUM  aLayer) const

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

Definition at line 685 of file layer_widget.cpp.

References ColorFromInt(), findLayerRow(), getLayerComp(), and TO_UTF8.

686 {
687  int row = findLayerRow( aLayer );
688  if( row >= 0 )
689  {
690  int col = 1; // bitmap button is column 1
691  wxBitmapButton* bmb = (wxBitmapButton*) getLayerComp( row, col );
692  wxASSERT( bmb );
693 
694  wxString colorTxt = bmb->GetName();
695  return ColorFromInt( strtoul( TO_UTF8(colorTxt), NULL, 0 ) );
696  }
697 
698  return COLOR4D::UNSPECIFIED; // it's caller fault, gave me a bad layer
699 }
EDA_COLOR_T ColorFromInt(int aColor)
Checked cast. Use only when necessary (usually I/O)
Definition: colors.h:81
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
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 236 of file layer_widget.cpp.

References LYR_COLUMN_COUNT, and m_LayersFlexGridSizer.

Referenced by findLayerRow(), GetLayerColor(), GetSelectedLayer(), IsLayerVisible(), OnLeftDownLayers(), GERBER_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::ReFill(), SelectLayerRow(), SetLayerColor(), SetLayerVisible(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), and UpdateLayerIcons().

237 {
238  unsigned ndx = aRow * LYR_COLUMN_COUNT + aColumn;
239 
240  if( ndx < m_LayersFlexGridSizer->GetChildren().GetCount() )
241  return m_LayersFlexGridSizer->GetChildren()[ndx]->GetWindow();
242 
243  return NULL;
244 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
int LAYER_WIDGET::GetLayerRowCount ( ) const

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

Definition at line 558 of file layer_widget.cpp.

References LYR_COLUMN_COUNT, and m_LayersFlexGridSizer.

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

559 {
560  int controlCount = m_LayersFlexGridSizer->GetChildren().GetCount();
561  return controlCount / LYR_COLUMN_COUNT;
562 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
wxWindow * LAYER_WIDGET::getRenderComp ( int  aRow,
int  aColumn 
) const
protected

Definition at line 265 of file layer_widget.cpp.

References m_RenderFlexGridSizer, and RND_COLUMN_COUNT.

Referenced by findRenderRow(), GetRenderState(), and SetRenderState().

266 {
267  int ndx = aRow * RND_COLUMN_COUNT + aColumn;
268 
269  if( (unsigned) ndx < m_RenderFlexGridSizer->GetChildren().GetCount() )
270  return m_RenderFlexGridSizer->GetChildren()[ndx]->GetWindow();
271 
272  return NULL;
273 }
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
int LAYER_WIDGET::GetRenderRowCount ( ) const

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

Definition at line 565 of file layer_widget.cpp.

References m_RenderFlexGridSizer, and RND_COLUMN_COUNT.

Referenced by AppendRenderRow(), and findRenderRow().

566 {
567  int controlCount = m_RenderFlexGridSizer->GetChildren().GetCount();
568  return controlCount / RND_COLUMN_COUNT;
569 }
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
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 716 of file layer_widget.cpp.

References findRenderRow(), and getRenderComp().

717 {
718  int row = findRenderRow( aId );
719 
720  if( row >= 0 )
721  {
722  int col = 1; // checkbox is column 1
723  wxCheckBox* cb = (wxCheckBox*) getRenderComp( row, col );
724  wxASSERT( cb );
725  return cb->GetValue();
726  }
727 
728  return false; // the value of a non-existent row
729 }
int findRenderRow(int aId) const
wxWindow * getRenderComp(int aRow, int aColumn) const
LAYER_NUM LAYER_WIDGET::GetSelectedLayer ( )

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

Definition at line 636 of file layer_widget.cpp.

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

637 {
638  wxWindow* w = getLayerComp( m_CurrentRow, 0 );
639  if( w )
640  return getDecodedId( w->GetId() );
641 
642  return UNDEFINED_LAYER;
643 }
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:119
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.
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 294 of file layer_widget.cpp.

References alternativeRowIcons, AreArbitraryColorsAllowed(), LAYER_WIDGET::ROW::color, COLUMN_COLOR_LYR_CB, COLUMN_COLOR_LYRNAME, COLUMN_COLORBM, COLUMN_ICON_ACTIVE, defaultRowIcons, encodeId(), LAYER_WIDGET::ROW::id, LYR_COLUMN_COUNT, m_LayerScrolledWindow, m_LayersFlexGridSizer, m_PointSize, OFF, OnLayerCheckBox(), OnLayerSwatchChanged(), OnLeftDownLayers(), OnRightDownLayer(), LAYER_WIDGET::ROW::rowName, shrinkFont(), LAYER_WIDGET::ROW::state, LAYER_WIDGET::ROW::tooltip, and useAlternateBitmap().

Referenced by AppendLayerRow().

295 {
296  wxASSERT( aRow >= 0 );
297 
298  int col;
299  int index = aRow * LYR_COLUMN_COUNT;
300  const int flags = wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT;
301 
302  auto& iconProvider = useAlternateBitmap(aRow) ? alternativeRowIcons : defaultRowIcons;
303 
304  // column 0
305  col = COLUMN_ICON_ACTIVE;
306  auto sbm = new INDICATOR_ICON( m_LayerScrolledWindow, iconProvider,
308  encodeId( col, aSpec.id ) );
309  sbm->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
310  m_LayersFlexGridSizer->wxSizer::Insert( index+col, sbm, 0, flags );
311 
312  // column 1 (COLUMN_COLORBM)
313  col = COLUMN_COLORBM;
314 
315  auto bmb = new COLOR_SWATCH( m_LayerScrolledWindow, aSpec.color, encodeId( col, aSpec.id ),
317  bmb->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
318  bmb->Bind( COLOR_SWATCH_CHANGED, &LAYER_WIDGET::OnLayerSwatchChanged, this );
319  bmb->SetToolTip( _("Left double click or middle click for color change, right click for menu" ) );
320  m_LayersFlexGridSizer->wxSizer::Insert( index+col, bmb, 0, flags );
321 
322  // column 2 (COLUMN_COLOR_LYR_CB)
323  col = COLUMN_COLOR_LYR_CB;
324  wxCheckBox* cb = new wxCheckBox( m_LayerScrolledWindow, encodeId( col, aSpec.id ), wxEmptyString );
325  cb->SetValue( aSpec.state );
326  cb->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED, &LAYER_WIDGET::OnLayerCheckBox, this );
327  cb->SetToolTip( _( "Enable this for visibility" ) );
328  m_LayersFlexGridSizer->wxSizer::Insert( index+col, cb, 0, flags );
329 
330  // column 3 (COLUMN_COLOR_LYRNAME)
331  col = COLUMN_COLOR_LYRNAME;
332  wxStaticText* st = new wxStaticText( m_LayerScrolledWindow, encodeId( col, aSpec.id ), aSpec.rowName );
333  shrinkFont( st, m_PointSize );
334  st->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
335  st->SetToolTip( aSpec.tooltip );
336  m_LayersFlexGridSizer->wxSizer::Insert( index+col, st, 0, flags );
337 
338  // Bind right click eventhandler to all columns
339  wxString layerName( aSpec.rowName );
340 
341  sbm->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
342  OnRightDownLayer( aEvt, bmb, layerName );
343  } );
344  bmb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
345  OnRightDownLayer( aEvt, bmb, layerName );
346  } );
347  cb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
348  OnRightDownLayer( aEvt, bmb, layerName );
349  } );
350  st->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
351  OnRightDownLayer( aEvt, bmb, layerName );
352  } );
353 }
#define COLUMN_COLOR_LYRNAME
Definition: layer_widget.h:54
void OnLeftDownLayers(wxMouseEvent &event)
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
#define OFF
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
virtual bool useAlternateBitmap(int aRow)
Virtual Function useAlternateBitmap.
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...
Class representing a row indicator icon for use in places like the layer widget.
#define COLUMN_ICON_ACTIVE
Definition: layer_widget.h:51
#define COLUMN_COLORBM
Definition: layer_widget.h:52
static ROW_ICON_PROVIDER alternativeRowIcons(true)
virtual bool AreArbitraryColorsAllowed()
Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPick...
Definition: layer_widget.h:136
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:112
static ROW_ICON_PROVIDER defaultRowIcons(false)
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:53
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.
void LAYER_WIDGET::insertRenderRow ( int  aRow,
const ROW aSpec 
)
protected

Definition at line 356 of file layer_widget.cpp.

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

Referenced by AppendRenderRow().

357 {
358  wxASSERT( aRow >= 0 );
359 
360  int col;
361  int index = aRow * RND_COLUMN_COUNT;
362  const int flags = wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT;
363 
364  wxString renderName( aSpec.rowName );
365 
366  // column 1
367  col = 1;
368  wxCheckBox* cb = new wxCheckBox( m_RenderScrolledWindow, encodeId( col, aSpec.id ),
369  aSpec.rowName, wxDefaultPosition, wxDefaultSize, wxALIGN_LEFT );
370  shrinkFont( cb, m_PointSize );
371  cb->SetValue( aSpec.state );
372  cb->Enable( aSpec.changeable );
373  cb->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED, &LAYER_WIDGET::OnRenderCheckBox, this );
374  cb->SetToolTip( aSpec.tooltip );
375 
376  // column 0
377  col = 0;
378  if( aSpec.color != COLOR4D::UNSPECIFIED )
379  {
380  auto bmb = new COLOR_SWATCH( m_RenderScrolledWindow, aSpec.color, encodeId( col, aSpec.id ),
382  bmb->Bind( COLOR_SWATCH_CHANGED, &LAYER_WIDGET::OnRenderSwatchChanged, this );
383  bmb->SetToolTip( _( "Left double click or middle click for color change" ) );
384  m_RenderFlexGridSizer->wxSizer::Insert( index+col, bmb, 0, flags );
385 
386  bmb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, renderName] ( wxMouseEvent& aEvt ) {
387  OnRightDownRender( aEvt, bmb, renderName );
388  } );
389  cb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, renderName] ( wxMouseEvent& aEvt ) {
390  OnRightDownRender( aEvt, bmb, renderName );
391  } );
392 
393  // could add a left click handler on the color button that toggles checkbox.
394  }
395  else // == -1, no color selection wanted
396  {
397  // need a place holder within the sizer to keep grid full.
398  wxPanel* invisible = new wxPanel( m_RenderScrolledWindow, encodeId( col, aSpec.id ) );
399  m_RenderFlexGridSizer->wxSizer::Insert( index+col, invisible, 0, flags );
400  }
401 
402  // Items have to be inserted in order
403  col = 1;
404  m_RenderFlexGridSizer->wxSizer::Insert( index+col, cb, 0, flags );
405 }
wxScrolledWindow * m_RenderScrolledWindow
Definition: layer_widget.h:115
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:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
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.
virtual bool AreArbitraryColorsAllowed()
Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPick...
Definition: layer_widget.h:136
void OnRenderSwatchChanged(wxCommandEvent &aEvent)
Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry...
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
bool LAYER_WIDGET::IsLayerVisible ( LAYER_NUM  aLayer)

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

Definition at line 658 of file layer_widget.cpp.

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

Referenced by GERBVIEW_FRAME::IsLayerVisible().

659 {
660  int row = findLayerRow( aLayer );
661  if( row >= 0 )
662  {
663  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
664  wxASSERT( cb );
665  return cb->GetValue();
666  }
667  return false;
668 }
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:53
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 173 of file layer_widget.cpp.

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

Referenced by insertLayerRow().

174 {
175  wxCheckBox* eventSource = (wxCheckBox*) event.GetEventObject();
176  LAYER_NUM layer = getDecodedId( eventSource->GetId() );
177  OnLayerVisible( layer, eventSource->IsChecked() );
178  passOnFocus();
179 }
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.
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 classes will handle this accordingly.

Parameters
aLayeris the board layer to change
aColoris the new color

Implemented in GERBER_LAYER_WIDGET, and PCB_LAYER_WIDGET.

Referenced by OnLayerSwatchChanged().

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().

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 GERBER_LAYER_WIDGET, and PCB_LAYER_WIDGET.

Referenced by OnLeftDownLayers().

void LAYER_WIDGET::OnLayerSwatchChanged ( wxCommandEvent &  aEvent)
protected

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

Definition at line 154 of file layer_widget.cpp.

References EVT_LAYER_COLOR_CHANGE, getDecodedId(), OnLayerColorChange(), and passOnFocus().

Referenced by insertLayerRow().

155 {
156  auto eventSource = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
157 
158  COLOR4D newColor = eventSource->GetSwatchColor();
159 
160  LAYER_NUM layer = getDecodedId( eventSource->GetId() );
161 
162  // tell the client code.
163  OnLayerColorChange( layer, newColor );
164 
165  // notify others
166  wxCommandEvent event( EVT_LAYER_COLOR_CHANGE );
167  wxPostEvent( this, event );
168 
169  passOnFocus();
170 }
static const wxEventType EVT_LAYER_COLOR_CHANGE
Definition: layer_widget.h:106
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
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
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 GERBER_LAYER_WIDGET, and PCB_LAYER_WIDGET.

Referenced by OnLayerCheckBox().

void LAYER_WIDGET::OnLeftDownLayers ( wxMouseEvent &  event)
protected

Definition at line 82 of file layer_widget.cpp.

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

Referenced by insertLayerRow().

83 {
84  int row;
85  LAYER_NUM layer;
86 
87  wxWindow* eventSource = (wxWindow*) event.GetEventObject();
88 
89  // if mouse event is coming from the m_LayerScrolledWindow and not one
90  // of its children, we have to find the row manually based on y coord.
91  if( eventSource == m_LayerScrolledWindow )
92  {
93  int y = event.GetY();
94 
95  wxArrayInt heights = m_LayersFlexGridSizer->GetRowHeights();
96 
97  int height = 0;
98 
99  int rowCount = GetLayerRowCount();
100  for( row = 0; row<rowCount; ++row )
101  {
102  if( y < height + heights[row] )
103  break;
104 
105  height += heights[row];
106  }
107 
108  if( row >= rowCount )
109  row = rowCount - 1;
110 
111  layer = getDecodedId( getLayerComp( row, 0 )->GetId() );
112  }
113 
114  else
115  {
116  // all nested controls on a given row will have their ID encoded with
117  // encodeId(), and the corresponding decoding is getDecodedId()
118  int id = eventSource->GetId();
119  layer = getDecodedId( id );
120  row = findLayerRow( layer );
121  }
122 
123  if( OnLayerSelect( layer ) ) // if client allows this change.
124  SelectLayerRow( row );
125 
126  passOnFocus();
127 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:112
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
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.
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...
void LAYER_WIDGET::OnRenderCheckBox ( wxCommandEvent &  event)
protected

Definition at line 218 of file layer_widget.cpp.

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

Referenced by insertRenderRow().

219 {
220  wxCheckBox* eventSource = (wxCheckBox*) event.GetEventObject();
221  LAYER_NUM id = getDecodedId( eventSource->GetId() );
222  OnRenderEnable( id, eventSource->IsChecked() );
223  passOnFocus();
224 }
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.
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 GERBER_LAYER_WIDGET, and PCB_LAYER_WIDGET.

Referenced by OnRenderSwatchChanged().

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 GERBER_LAYER_WIDGET, and PCB_LAYER_WIDGET.

Referenced by OnRenderCheckBox().

void LAYER_WIDGET::OnRenderSwatchChanged ( wxCommandEvent &  aEvent)
protected

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

Definition at line 203 of file layer_widget.cpp.

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

Referenced by insertRenderRow().

204 {
205  auto eventSource = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
206 
207  COLOR4D newColor = eventSource->GetSwatchColor();
208 
209  LAYER_NUM id = getDecodedId( eventSource->GetId() );
210 
211  // tell the client code.
212  OnRenderColorChange( id, newColor );
213 
214  passOnFocus();
215 }
virtual void OnRenderColorChange(int aId, COLOR4D aColor)=0
Function OnRenderColorChange is called to notify client code whenever the user changes a rendering co...
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
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
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 130 of file layer_widget.cpp.

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

Referenced by insertLayerRow().

131 {
132  wxMenu menu;
133 
135  _( "Change Layer Color for " ) + aLayerName,
136  KiBitmap( setcolor_copper_xpm ) );
137  menu.AppendSeparator();
138 
139  OnLayerRightClick( menu );
140 
141  menu.Bind( wxEVT_COMMAND_MENU_SELECTED, [this, aColorSwatch]( wxCommandEvent& event ) {
142  if ( event.GetId() == ID_CHANGE_LAYER_COLOR ) {
143  aColorSwatch->GetNewSwatchColor();
144  } else {
145  event.Skip();
146  }
147  } );
148 
149  PopupMenu( &menu );
150  passOnFocus();
151 }
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:55
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
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.
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 182 of file layer_widget.cpp.

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

Referenced by insertRenderRow().

183 {
184  wxMenu menu;
185 
187  _( "Change Render Color for " ) + aRenderName,
188  KiBitmap( setcolor_board_body_xpm ) );
189 
190  menu.Bind( wxEVT_COMMAND_MENU_SELECTED, [this, aColorSwatch]( wxCommandEvent& event ) {
191  if ( event.GetId() == ID_CHANGE_RENDER_COLOR ) {
192  aColorSwatch->GetNewSwatchColor();
193  } else {
194  event.Skip();
195  }
196  } );
197 
198  PopupMenu( &menu );
199  passOnFocus();
200 }
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:55
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.
void LAYER_WIDGET::OnTabChange ( wxNotebookEvent &  event)
protected

Definition at line 227 of file layer_widget.cpp.

References passOnFocus().

Referenced by LAYER_WIDGET().

228 {
229 // wxFocusEvent event( wxEVT_SET_FOCUS );
230 // m_FocusOwner->AddPendingEvent( event );
231 
232  passOnFocus(); // does not work in this context, probably because we have receive control here too early.
233 }
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void LAYER_WIDGET::passOnFocus ( )
protected

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

Definition at line 408 of file layer_widget.cpp.

References m_FocusOwner.

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

409 {
410  m_FocusOwner->SetFocus();
411 }
wxWindow * m_FocusOwner
Definition: layer_widget.h:118
void LAYER_WIDGET::SelectLayer ( LAYER_NUM  aLayer)

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

Definition at line 629 of file layer_widget.cpp.

References findLayerRow(), and SelectLayerRow().

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

630 {
631  int row = findLayerRow( aLayer );
632  SelectLayerRow( row );
633 }
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.
void LAYER_WIDGET::SelectLayerRow ( int  aRow)

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

Definition at line 600 of file layer_widget.cpp.

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

Referenced by OnLeftDownLayers(), and SelectLayer().

601 {
602  // enable the layer tab at index 0
603  m_notebook->SetSelection( 0 );
604 
605  INDICATOR_ICON* oldIndicator = (INDICATOR_ICON*) getLayerComp( m_CurrentRow, 0 );
606  if( oldIndicator )
608 
609  INDICATOR_ICON* newIndicator = (INDICATOR_ICON*) getLayerComp( aRow, 0 );
610  if( newIndicator )
611  {
613 
614  // Make sure the desired layer row is visible.
615  // It seems that as of 2.8.2, setting the focus does this.
616  // I don't expect the scrolling to be needed at all because
617  // the minimum window size may end up being established so that the
618  // scroll bars will not be visible.
619  getLayerComp( aRow, 1 )->SetFocus();
620  }
621 
622  m_CurrentRow = aRow;
623 
624  // give the focus back to the app.
625  passOnFocus();
626 }
void SetIndicatorState(ICON_ID aIconId)
Sets the row indiciator to the given state.
wxAuiNotebook * m_notebook
Definition: layer_widget.h:110
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:119
#define OFF
Class representing a row indicator icon for use in places like the layer widget.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
#define ON
void LAYER_WIDGET::SetLayerColor ( LAYER_NUM  aLayer,
COLOR4D  aColor 
)

Function SetLayerColor changes the color of aLayer.

Definition at line 671 of file layer_widget.cpp.

References findLayerRow(), and getLayerComp().

672 {
673  int row = findLayerRow( aLayer );
674  if( row >= 0 )
675  {
676  int col = 1; // bitmap button is column 1
677  auto bmb = static_cast<COLOR_SWATCH*>( getLayerComp( row, col ) );
678  wxASSERT( bmb );
679 
680  bmb->SetSwatchColor( aColor, false );
681  }
682 }
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...
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
void LAYER_WIDGET::SetLayerVisible ( LAYER_NUM  aLayer,
bool  isVisible 
)

Function SetLayerVisible sets aLayer visible or not.

This does not invoke OnLayerVisible().

Definition at line 646 of file layer_widget.cpp.

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

Referenced by PCB_LAYER_WIDGET::SyncLayerVisibilities().

647 {
648  int row = findLayerRow( aLayer );
649  if( row >= 0 )
650  {
651  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
652  wxASSERT( cb );
653  cb->SetValue( isVisible ); // does not fire an event
654  }
655 }
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:53
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 702 of file layer_widget.cpp.

References findRenderRow(), and getRenderComp().

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

703 {
704  int row = findRenderRow( aId );
705 
706  if( row >= 0 )
707  {
708  int col = 1; // checkbox is column 1
709  wxCheckBox* cb = (wxCheckBox*) getRenderComp( row, col );
710  wxASSERT( cb );
711  cb->SetValue( isSet ); // does not fire an event
712  }
713 }
int findRenderRow(int aId) const
wxWindow * getRenderComp(int aRow, int aColumn) const
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 742 of file layer_widget.cpp.

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

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

743 {
744  int rowCount = GetLayerRowCount();
745 
746  for( int row = 0; row < rowCount ; row++ )
747  {
749 
750  if( indicator )
751  {
752  auto state = ( row == m_CurrentRow ) ? ROW_ICON_PROVIDER::STATE::ON
754  indicator->SetIndicatorState( state );
755  }
756  }
757 }
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:119
#define OFF
Class representing a row indicator icon for use in places like the layer widget.
#define COLUMN_ICON_ACTIVE
Definition: layer_widget.h:51
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
#define ON
void LAYER_WIDGET::UpdateLayouts ( )

Definition at line 732 of file layer_widget.cpp.

References m_LayerPanel, m_LayersFlexGridSizer, m_RenderFlexGridSizer, and m_RenderingPanel.

Referenced by AppendLayerRow(), and AppendRenderRow().

733 {
734  m_LayersFlexGridSizer->Layout();
735  m_RenderFlexGridSizer->Layout();
736  m_LayerPanel->Layout();
737  m_RenderingPanel->Layout();
738  FitInside();
739 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
wxPanel * m_RenderingPanel
Definition: layer_widget.h:114
wxPanel * m_LayerPanel
Definition: layer_widget.h:111
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 130 of file layer_widget.h.

Referenced by insertLayerRow().

130 { return false; }

Member Data Documentation

const wxEventType LAYER_WIDGET::EVT_LAYER_COLOR_CHANGE = wxNewEventType()
static

Definition at line 106 of file layer_widget.h.

Referenced by OnLayerSwatchChanged().

int LAYER_WIDGET::m_CurrentRow
protected

selected row of layer list

Definition at line 119 of file layer_widget.h.

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

wxWindow* LAYER_WIDGET::m_FocusOwner
protected

Definition at line 118 of file layer_widget.h.

Referenced by LAYER_WIDGET(), and passOnFocus().

wxPanel* LAYER_WIDGET::m_LayerPanel
protected

Definition at line 111 of file layer_widget.h.

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

wxScrolledWindow* LAYER_WIDGET::m_LayerScrolledWindow
protected
wxFlexGridSizer* LAYER_WIDGET::m_LayersFlexGridSizer
protected
wxAuiNotebook* LAYER_WIDGET::m_notebook
protected
int LAYER_WIDGET::m_PointSize
protected

Definition at line 120 of file layer_widget.h.

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

wxFlexGridSizer* LAYER_WIDGET::m_RenderFlexGridSizer
protected
wxPanel* LAYER_WIDGET::m_RenderingPanel
protected

Definition at line 114 of file layer_widget.h.

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

wxScrolledWindow* LAYER_WIDGET::m_RenderScrolledWindow
protected

Definition at line 115 of file layer_widget.h.

Referenced by insertRenderRow(), and LAYER_WIDGET().


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