KiCad PCB EDA Suite
dialog_rule_area_properties.cpp
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) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <kiface_i.h>
27 #include <confirm.h>
28 #include <pcb_edit_frame.h>
29 #include <pcbnew_settings.h>
30 #include <footprint_edit_frame.h>
31 #include <zone_settings.h>
33 
34 #define LAYER_LIST_COLUMN_CHECK 0
35 #define LAYER_LIST_COLUMN_ICON 1
36 #define LAYER_LIST_COLUMN_NAME 2
37 #define LAYER_LIST_ROW_ALL_INNER_LAYERS 1
38 
39 
41 {
42 public:
44 
45 private:
49  bool m_isFpEditor;
51 
52  bool TransferDataToWindow() override;
53  bool TransferDataFromWindow() override;
54 
55  void OnLayerSelection( wxDataViewEvent& event ) override;
56 };
57 
58 
60 {
61  DIALOG_RULE_AREA_PROPERTIES dlg( aCaller, aSettings );
62 
63  return dlg.ShowModal();
64 }
65 
66 
68  ZONE_SETTINGS* aSettings ) :
70 {
71  m_parent = aParent;
72 
73  m_ptr = aSettings;
74  m_zonesettings = *aSettings;
75 
76  m_isFpEditor = dynamic_cast<FOOTPRINT_EDIT_FRAME*>( aParent ) != nullptr;
77 
78  bool fpEditorMode = m_parent->IsType( FRAME_FOOTPRINT_EDITOR );
79  m_zonesettings.SetupLayersList( m_layers, m_parent, true, fpEditorMode );
80 
81  m_sdbSizerButtonsOK->SetDefault();
82 
84 }
85 
86 
88 {
89  // Init keepout parameters:
95 
96  m_cbLocked->SetValue( m_zonesettings.m_Locked );
97 
99 
100  m_tcName->SetValue( m_zonesettings.m_Name );
101 
103  {
104  case ZONE_BORDER_DISPLAY_STYLE::NO_HATCH: m_OutlineDisplayCtrl->SetSelection( 0 ); break;
105  case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE: m_OutlineDisplayCtrl->SetSelection( 1 ); break;
106  case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL: m_OutlineDisplayCtrl->SetSelection( 2 ); break;
107  }
108 
110 
111  return true;
112 }
113 
114 
115 void DIALOG_RULE_AREA_PROPERTIES::OnLayerSelection( wxDataViewEvent& event )
116 {
117  if( event.GetColumn() != 0 )
118  return;
119 
120  int row = m_layers->ItemToRow( event.GetItem() );
121  wxVariant layerID;
122  m_layers->GetValue( layerID, row, LAYER_LIST_COLUMN_NAME );
123  bool selected = m_layers->GetToggleValue( row, LAYER_LIST_COLUMN_CHECK );
124 
125  // In footprint editor, we have only 3 possible layer selection: C_Cu, inner layers, B_Cu.
126  // So row LAYER_LIST_ROW_ALL_INNER_LAYERS selection is fp editor specific.
127  // in board editor, this row is a normal selection
129  {
130  if( selected )
132  else
133  m_zonesettings.m_Layers &= ~LSET::InternalCuMask();
134  }
135  else
136  {
137  m_zonesettings.m_Layers.set( ToLAYER_ID( layerID.GetInteger() ), selected );
138  }
139 }
140 
141 
143 {
144  // Init keepout parameters:
151 
152  if( m_zonesettings.m_Layers.count() == 0 )
153  {
154  DisplayError( this, _( "No layers selected." ) );
155  return false;
156  }
157 
158  switch( m_OutlineDisplayCtrl->GetSelection() )
159  {
160  case 0:
162  break;
163  case 1:
165  break;
166  case 2:
168  break;
169  }
170 
171  auto cfg = m_parent->GetPcbNewSettings();
173 
175  m_zonesettings.m_Locked = m_cbLocked->GetValue();
176  m_zonesettings.m_ZonePriority = 0; // for a keepout, this param is not used.
177 
178  m_zonesettings.m_Name = m_tcName->GetValue();
179 
181  return true;
182 }
183 
184 
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
Class DIALOG_RULE_AREA_PROPERTIES_BASE.
const bool GetDoNotAllowFootprints() const
This file is part of the common library.
#define LAYER_LIST_COLUMN_CHECK
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
Option to show the zone area (outlines only, short hatches or full hatches.
#define LAYER_LIST_COLUMN_NAME
wxString m_Name
Definition: zone_settings.h:95
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
void SetDoNotAllowFootprints(bool aEnable)
ZONE_SETTINGS m_zonesettings
the working copy of zone settings
void SetDoNotAllowVias(bool aEnable)
LSET is a set of PCB_LAYER_IDs.
void SetDoNotAllowPads(bool aEnable)
DIALOG_RULE_AREA_PROPERTIES(PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings)
static LSET InternalCuMask()
Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.
Definition: lset.cpp:710
#define LAYER_LIST_ROW_ALL_INNER_LAYERS
#define _(s)
const bool GetDoNotAllowVias() const
void SetDoNotAllowTracks(bool aEnable)
void SetIsRuleArea(bool aEnable)
const bool GetDoNotAllowTracks() const
int InvokeRuleAreaEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeRuleAreaEditor invokes up a modal dialog window for copper zone editing.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:67
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
const bool GetDoNotAllowPads() const
bool IsType(FRAME_T aType) const
const bool GetDoNotAllowCopperPour() const
PCBNEW_SETTINGS * GetPcbNewSettings() const
void OnLayerSelection(wxDataViewEvent &event) override
ZONE_SETTINGS * m_ptr
the pointer to the zone settings of the zone to edit
void SetDoNotAllowCopperPour(bool aEnable)
void SetupLayersList(wxDataViewListCtrl *aList, PCB_BASE_FRAME *aFrame, bool aShowCopper, bool aFpEditorMode=false)
A helper routine for the various zone dialogs (copper, non-copper, keepout).
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:905
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.