KiCad PCB EDA Suite
dialog_keepout_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-2019 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 <fctsys.h>
27 #include <kiface_i.h>
28 #include <confirm.h>
29 #include <pcb_edit_frame.h>
30 #include <class_zone.h>
31 #include <zones.h>
32 #include <zone_settings.h>
34 
35 
37 {
38 public:
40 
41 private:
43  wxConfigBase* m_config;
46 
48  bool TransferDataToWindow() override;
49  bool TransferDataFromWindow() override;
50 
51  void OnLayerSelection( wxDataViewEvent& event ) override;
52 };
53 
54 
56 {
57  DIALOG_KEEPOUT_AREA_PROPERTIES dlg( aCaller, aSettings );
58 
59  return dlg.ShowModal();
60 }
61 
62 
64  ZONE_SETTINGS* aSettings ) :
66 {
67  m_parent = aParent;
69 
70  m_ptr = aSettings;
71  m_zonesettings = *aSettings;
73 
74  m_sdbSizerButtonsOK->SetDefault();
75 
77 }
78 
79 
81 {
82  // Init keepout parameters:
86 
88 
90  {
91  case ZONE_CONTAINER::NO_HATCH: m_OutlineAppearanceCtrl->SetSelection( 0 ); break;
92  case ZONE_CONTAINER::DIAGONAL_EDGE: m_OutlineAppearanceCtrl->SetSelection( 1 ); break;
93  case ZONE_CONTAINER::DIAGONAL_FULL: m_OutlineAppearanceCtrl->SetSelection( 2 ); break;
94  }
95 
97 
98  return true;
99 }
100 
101 
103 {
104  if( event.GetColumn() != 0 )
105  return;
106 
107  int row = m_layers->ItemToRow( event.GetItem() );
108  wxVariant layerID;
109  m_layers->GetValue( layerID, row, 2 );
110  bool selected = m_layers->GetToggleValue( row, 0 );
111 
112  m_zonesettings.m_Layers.set( ToLAYER_ID( layerID.GetInteger() ), selected );
113 }
114 
115 
117 {
118  // Init keepout parameters:
123 
124  // Test for not allowed items: should have at least one item not allowed:
128  {
129  DisplayError( NULL, _("Tracks, vias, and pads are allowed. The keepout will have no effect." ) );
130  return false;
131  }
132 
133  if( m_zonesettings.m_Layers.count() == 0 )
134  {
135  DisplayError( NULL, _( "No layers selected." ) );
136  return false;
137  }
138 
139  switch( m_OutlineAppearanceCtrl->GetSelection() )
140  {
144  }
145 
146  if( m_config )
148 
150  m_zonesettings.m_ZonePriority = 0; // for a keepout, this param is not used.
151 
153  return true;
154 }
155 
156 
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
int m_Zone_HatchingStyle
Option to show the zone area (outlines only, short hatches or full hatches.
Definition: zone_settings.h:81
int InvokeKeepoutAreaEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeKeepoutAreaEditor invokes up a modal dialog window for copper zone editing.
This file is part of the common library.
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:118
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
void SetupLayersList(wxDataViewListCtrl *aList, PCB_BASE_FRAME *aFrame, bool aShowCopper)
A helper routine for the various zone dialogs (copper, non-copper, keepout).
void SetDoNotAllowVias(bool aEnable)
DIALOG_KEEPOUT_AREA_PROPERTIES(PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings)
int m_ZonePriority
Priority (0 ... N) of the zone.
Definition: zone_settings.h:62
void OnLayerSelection(wxDataViewEvent &event) override
void SetIsKeepout(bool aEnable)
const bool GetDoNotAllowVias() const
void SetDoNotAllowTracks(bool aEnable)
ZONE_SETTINGS * m_ptr
the pointer to the zone settings of the zone to edit
Class DIALOG_KEEPOUT_AREA_PROPERTIES_BASE.
#define _(s)
const bool GetDoNotAllowTracks() const
Class ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:49
const bool GetDoNotAllowCopperPour() const
void SetDoNotAllowCopperPour(bool aEnable)
#define ZONE_NET_OUTLINES_STYLE_KEY
Definition: zones.h:29
ZONE_SETTINGS m_zonesettings
the working copy of zone settings
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.