KiCad PCB EDA Suite
layer_widget.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef LAYERWIDGET_H_
26 #define LAYERWIDGET_H_
27 
28 #include <wx/intl.h>
29 #include <wx/wx.h>
30 #include <wx/statbmp.h>
31 #include <wx/string.h>
32 #include <wx/aui/auibook.h>
33 #include <wx/notebook.h>
34 #include <wx/sizer.h>
35 #include <wx/gdicmn.h>
36 #include <wx/scrolwin.h>
37 #include <wx/font.h>
38 #include <wx/colour.h>
39 #include <wx/settings.h>
40 #include <wx/panel.h>
41 #include <wx/bitmap.h>
42 #include <wx/image.h>
43 #include <wx/icon.h>
45 #include <gal/color4d.h>
46 #include <widgets/color_swatch.h>
47 #include <widgets/indicator_icon.h>
48 
49 #define LYR_COLUMN_COUNT 5
50 #define RND_COLUMN_COUNT 2
51 
52 #define COLUMN_ICON_ACTIVE 0
53 #define COLUMN_COLORBM 1
54 #define COLUMN_COLOR_LYR_CB 2
55 #define COLUMN_COLOR_LYRNAME 3
56 #define COLUMN_ALPHA_INDICATOR 4
57 
58 using KIGFX::COLOR4D;
59 
79 class LAYER_WIDGET : public wxPanel
80 {
81 public:
87  struct ROW
88  {
89  wxString rowName;
90  int id;
92  bool state;
93  wxString tooltip;
94  bool changeable;
95  bool spacer;
96 
97  ROW( const wxString& aRowName, int aId, COLOR4D aColor = COLOR4D::UNSPECIFIED,
98  const wxString& aTooltip = wxEmptyString, bool aState = true, bool aChangeable = true )
99  {
100  rowName = aRowName;
101  id = aId;
102  color = aColor;
103  state = aState;
104  tooltip = aTooltip;
105  changeable = aChangeable;
106  spacer = false;
107  }
108 
109  ROW()
110  {
111  spacer = true;
112  color = COLOR4D::UNSPECIFIED;
113  id = 0;
114  }
115  };
116 
117  static const wxEventType EVT_LAYER_COLOR_CHANGE;
118 
119 protected:
120 
121  wxAuiNotebook* m_notebook;
122  wxPanel* m_LayerPanel;
123  wxScrolledWindow* m_LayerScrolledWindow;
124  wxFlexGridSizer* m_LayersFlexGridSizer;
126  wxScrolledWindow* m_RenderScrolledWindow;
127  wxFlexGridSizer* m_RenderFlexGridSizer;
128 
129  wxWindow* m_FocusOwner;
132 
134 
143  virtual bool useAlternateBitmap(int aRow) { return false; }
144 
149  virtual bool AreArbitraryColorsAllowed() { return false; }
150 
156 
164  static int encodeId( int aColumn, int aId );
165 
172  static LAYER_NUM getDecodedId( int aControlId );
173 
174  void OnLeftDownLayers( wxMouseEvent& event );
175 
180  void OnRightDownLayer( wxMouseEvent& event, COLOR_SWATCH* aColorSwatch, const wxString& aLayerName );
181 
186  void OnLayerSwatchChanged( wxCommandEvent& aEvent );
187 
193  void OnLayerCheckBox( wxCommandEvent& event );
194 
199  void OnRightDownRender( wxMouseEvent& aEvent, COLOR_SWATCH* aColorSwatch, const wxString& aRenderName );
200 
205  void OnRenderSwatchChanged( wxCommandEvent& aEvent );
206 
207  void OnRenderCheckBox( wxCommandEvent& event );
208 
209  void OnTabChange( wxNotebookEvent& event );
210 
211 
221  wxWindow* getLayerComp( int aRow, int aColumn ) const;
222  wxWindow* getRenderComp( int aRow, int aColumn ) const;
223 
228  int findLayerRow( LAYER_NUM aLayer ) const;
229  int findRenderRow( int aId ) const;
230 
235  void insertLayerRow( int aRow, const ROW& aSpec );
236 
237  void insertRenderRow( int aRow, const ROW& aSpec );
238 
243  void passOnFocus();
244 
245  // popup menu ids.
246  enum POPUP_ID
247  {
248  ID_CHANGE_LAYER_COLOR = wxID_HIGHEST,
251  };
252 
253 public:
254 
267  LAYER_WIDGET( wxWindow* aParent, wxWindow* aFocusOwner, int aPointSize = -1,
268  wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
269  const wxSize& size = wxDefaultSize, long style = wxTAB_TRAVERSAL );
270 
271  virtual ~LAYER_WIDGET();
272 
279  wxSize GetBestSize() const;
280 
285  int GetLayerRowCount() const;
286 
291  int GetRenderRowCount() const;
292 
298  void AppendLayerRow( const ROW& aRow );
299 
305  void AppendLayerRows( const ROW* aRowsArray, int aRowCount )
306  {
307  for( int row=0; row<aRowCount; ++row )
308  AppendLayerRow( aRowsArray[row] );
309  }
310 
315  void ClearLayerRows();
316 
322  void AppendRenderRow( const ROW& aRow );
323 
329  void AppendRenderRows( const ROW* aRowsArray, int aRowCount )
330  {
331  for( int row=0; row<aRowCount; ++row )
332  AppendRenderRow( aRowsArray[row] );
333  }
334 
339  void ClearRenderRows();
340 
345  void SelectLayerRow( int aRow );
346 
351  void SelectLayer( LAYER_NUM aLayer );
352 
358 
363  void SetLayerVisible( LAYER_NUM aLayer, bool isVisible );
364 
369  bool IsLayerVisible( LAYER_NUM aLayer );
370 
375  void SetLayerColor( LAYER_NUM aLayer, COLOR4D aColor );
376 
381  COLOR4D GetLayerColor( LAYER_NUM aLayer ) const;
382 
392  void SetRenderState( int aId, bool isSet );
393 
399  bool GetRenderState( int aId );
400 
401  void UpdateLayouts();
402 
409  void UpdateLayerIcons();
410 
411 /* did not help:
412  void Freeze()
413  {
414  LAYER_PANEL_BASE::Freeze();
415  m_LayerScrolledWindow->Freeze();
416  m_RenderScrolledWindow->Freeze();
417  }
418 
419  void Thaw()
420  {
421  m_RenderScrolledWindow->Thaw();
422  m_LayerScrolledWindow->Thaw();
423  LAYER_PANEL_BASE::Thaw();
424  }
425 */
426 
427  //-----<abstract functions>-------------------------------------------
428 
436  virtual void OnLayerColorChange( int aLayer, COLOR4D aColor ) = 0;
437 
445  virtual bool OnLayerSelect( int aLayer ) = 0;
446 
457  virtual void OnLayerVisible( LAYER_NUM aLayer, bool isVisible, bool isFinal = true ) = 0;
458 
466  virtual void OnLayerRightClick( wxMenu& aMenu ) = 0;
467 
476  virtual void OnRenderColorChange( int aId, COLOR4D aColor ) = 0;
477 
486  virtual void OnRenderEnable( int aId, bool isEnabled ) = 0;
487 
488  //-----</abstract functions>------------------------------------------
489 };
490 
491 #endif // LAYERWIDGET_H_
void OnLeftDownLayers(wxMouseEvent &event)
wxAuiNotebook * m_notebook
Definition: layer_widget.h:121
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:130
void insertRenderRow(int aRow, const ROW &aSpec)
Icon provider for the "standard" row indicators, for example in layer selection lists.
Struct ROW provides all the data needed to add a row to a LAYER_WIDGET.
Definition: layer_widget.h:87
int findRenderRow(int aId) const
bool spacer
if true, this row is a spacer
Definition: layer_widget.h:95
virtual void OnRenderColorChange(int aId, COLOR4D aColor)=0
Function OnRenderColorChange is called to notify client code whenever the user changes a rendering co...
bool GetRenderState(int aId)
Function GetRenderState returns the state of the checkbox associated with aId.
void UpdateLayouts()
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.
ROW(const wxString &aRowName, int aId, COLOR4D aColor=COLOR4D::UNSPECIFIED, const wxString &aTooltip=wxEmptyString, bool aState=true, bool aChangeable=true)
Definition: layer_widget.h:97
void OnTabChange(wxNotebookEvent &event)
bool changeable
if true, the state can be changed
Definition: layer_widget.h:94
static const wxEventType EVT_LAYER_COLOR_CHANGE
Definition: layer_widget.h:117
COLOR4D GetLayerColor(LAYER_NUM aLayer) const
Function GetLayerColor returns the color of the layer ROW associated with aLayer id.
wxScrolledWindow * m_RenderScrolledWindow
Definition: layer_widget.h:126
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:124
virtual bool useAlternateBitmap(int aRow)
Virtual Function useAlternateBitmap.
Definition: layer_widget.h:143
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxSize GetBestSize() const
Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic conten...
void AppendLayerRows(const ROW *aRowsArray, int aRowCount)
Function AppendLayerRows appends new rows in the layer portion of the widget.
Definition: layer_widget.h:305
void ClearRenderRows()
Function ClearRenderRows empties out the render rows.
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:127
bool state
initial wxCheckBox state
Definition: layer_widget.h:92
void ClearLayerRows()
Function ClearLayerRows empties out the layer rows.
wxString tooltip
if not empty, use this tooltip on row
Definition: layer_widget.h:93
virtual void OnLayerColorChange(int aLayer, COLOR4D aColor)=0
Function OnLayerColorChange is called to notify client code about a layer color change.
void OnRenderCheckBox(wxCommandEvent &event)
void OnLayerCheckBox(wxCommandEvent &event)
Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the clie...
void AppendRenderRow(const ROW &aRow)
Function AppendRenderRow appends a new row in the render portion of the widget.
static int encodeId(int aColumn, int aId)
Function encodeId is here to allow saving a layer index within a control as its wxControl id...
COLOR4D color
COLOR4D::UNSPECIFIED if none.
Definition: layer_widget.h:91
void OnRightDownRender(wxMouseEvent &aEvent, COLOR_SWATCH *aColorSwatch, const wxString &aRenderName)
Function OnRightDownRender Called when user right-clicks a render option.
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.
void SetLayerColor(LAYER_NUM aLayer, COLOR4D aColor)
Function SetLayerColor changes the color of aLayer.
virtual bool AreArbitraryColorsAllowed()
Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPick...
Definition: layer_widget.h:149
wxPanel * m_RenderingPanel
Definition: layer_widget.h:125
void AppendLayerRow(const ROW &aRow)
Function AppendLayerRow appends a new row in the layer portion of the widget.
void UpdateLayerIcons()
Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or ...
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:123
virtual void OnRenderEnable(int aId, bool isEnabled)=0
Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable...
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.
void AppendRenderRows(const ROW *aRowsArray, int aRowCount)
Function AppendRenderRows appends new rows in the render portion of the widget.
Definition: layer_widget.h:329
void OnRenderSwatchChanged(wxCommandEvent &aEvent)
Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
virtual ~LAYER_WIDGET()
wxWindow * m_FocusOwner
Definition: layer_widget.h:129
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.
LAYER_NUM GetSelectedLayer()
Function GetSelectedLayer returns the selected layer or -1 if none.
bool IsLayerVisible(LAYER_NUM aLayer)
Function IsLayerVisible returns the visible state of the layer ROW associated with aLayer id...
Class LAYER_WIDGET is abstract and is used to manage a list of layers, with the notion of a "current"...
Definition: layer_widget.h:79
Board layer functions and definitions.
void OnRightDownLayer(wxMouseEvent &event, COLOR_SWATCH *aColorSwatch, const wxString &aLayerName)
Function OnRightDownLayer Called when user right-clicks a layer.
wxString rowName
the prompt or layername
Definition: layer_widget.h:89
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
virtual void OnLayerRightClick(wxMenu &aMenu)=0
Function OnLayerRightClick is called to notify client code about a layer being right-clicked.
void insertLayerRow(int aRow, const ROW &aSpec)
Function insertLayerRow appends or inserts a new row in the layer portion of the widget.
Definition: colors.h:45
void SetLayerVisible(LAYER_NUM aLayer, bool isVisible)
Function SetLayerVisible sets aLayer visible or not.
void OnLayerSwatchChanged(wxCommandEvent &aEvent)
Function OnSwatchChanged() is called when a user changes a swatch color.
virtual bool OnLayerSelect(int aLayer)=0
Function OnLayerSelect is called to notify client code whenever the user selects a different layer...
void SetRenderState(int aId, bool isSet)
Function SetRenderState sets the state of the checkbox associated with aId within the Render tab grou...
void SelectLayer(LAYER_NUM aLayer)
Function SelectLayer changes the row selection in the layer list to aLayer provided.
int id
either a layer or "visible element" id
Definition: layer_widget.h:90
ROW_ICON_PROVIDER * m_IconProvider
Definition: layer_widget.h:133
wxPanel * m_LayerPanel
Definition: layer_widget.h:122
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.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
wxWindow * getRenderComp(int aRow, int aColumn) const