KiCad PCB EDA Suite
DIALOG_TRACK_VIA_PROPERTIES Class Reference

#include <dialog_track_via_properties.h>

Inheritance diagram for DIALOG_TRACK_VIA_PROPERTIES:
DIALOG_TRACK_VIA_PROPERTIES_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_TRACK_VIA_PROPERTIES (PCB_BASE_FRAME *aParent, const SELECTION &aItems)
 
bool Apply (COMMIT &aCommit)
 

Applies values from the dialog to the selected items.

More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Member Functions

void FinishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void FixOSXCancelButtonIssue ()
 A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms. More...
 

Protected Attributes

wxBoxSizer * m_MainSizer
 
wxStaticBoxSizer * m_sbCommonSizer
 
wxStaticText * m_staticText24
 
wxComboBox * m_NetComboBox
 
wxStaticLine * m_staticline3
 
wxCheckBox * m_lockedCbox
 
wxStaticBoxSizer * m_sbTrackSizer
 
wxStaticText * m_TrackStartXLabel
 
wxTextCtrl * m_TrackStartXCtrl
 
wxStaticText * m_TrackStartXUnit
 
wxStaticText * m_TrackStartYLabel
 
wxTextCtrl * m_TrackStartYCtrl
 
wxStaticText * m_TrackStartYUnit
 
wxStaticText * m_TrackEndXLabel
 
wxTextCtrl * m_TrackEndXCtrl
 
wxStaticText * m_TrackEndXUnit
 
wxStaticText * m_TrackEndYLabel
 
wxTextCtrl * m_TrackEndYCtrl
 
wxStaticText * m_TrackEndYUnit
 
wxStaticLine * m_trackStaticLine
 
wxStaticText * m_TrackWidthLabel
 
wxTextCtrl * m_TrackWidthCtrl
 
wxStaticText * m_TrackWidthUnit
 
wxCheckBox * m_trackNetclass
 
wxStaticText * m_TrackLayerLabel
 
PCB_LAYER_BOX_SELECTORm_TrackLayerCtrl
 
wxStaticBoxSizer * m_sbViaSizer
 
wxStaticText * m_ViaXLabel
 
wxTextCtrl * m_ViaXCtrl
 
wxStaticText * m_ViaXUnit
 
wxStaticText * m_ViaYLabel
 
wxTextCtrl * m_ViaYCtrl
 
wxStaticText * m_ViaYUnit
 
wxStaticLine * m_viaStaticLine
 
wxStaticText * m_ViaDiameterLabel
 
wxTextCtrl * m_ViaDiameterCtrl
 
wxStaticText * m_ViaDiameterUnit
 
wxStaticText * m_ViaDrillLabel
 
wxTextCtrl * m_ViaDrillCtrl
 
wxStaticText * m_ViaDrillUnit
 
wxStaticText * m_ViaTypeLabel
 
wxChoice * m_ViaTypeChoice
 
wxStaticText * m_ViaStartLayerLabel
 
PCB_LAYER_BOX_SELECTORm_ViaStartLayer
 
wxStaticText * m_ViaEndLayerLabel1
 
PCB_LAYER_BOX_SELECTORm_ViaEndLayer
 
wxCheckBox * m_viaNetclass
 
wxStdDialogButtonSizer * m_StdButtons
 
wxButton * m_StdButtonsOK
 
wxButton * m_StdButtonsCancel
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void onClose (wxCloseEvent &aEvent) override
 
void onTrackNetclassCheck (wxCommandEvent &aEvent) override
 
void onViaNetclassCheck (wxCommandEvent &aEvent) override
 
void onCancelClick (wxCommandEvent &aEvent) override
 
void onOkClick (wxCommandEvent &aEvent) override
 
void OnInitDlg (wxInitDialogEvent &event) override
 
bool check () const
 

Checks if the dialog values are correct.

More...
 
template<typename T >
void setCommonVal (const boost::optional< T > &aVal, wxTextCtrl *aTxtCtrl, WX_UNIT_BINDER &aBinder)
 

Sets wxTextCtrl to the value stored in boost::optional<T> or "<...>" if it is not available.

More...
 

Private Attributes

const SELECTIONm_items
 

Selected items to be modified.

More...
 
WX_UNIT_BINDER m_trackStartX
 
WX_UNIT_BINDER m_trackStartY
 
WX_UNIT_BINDER m_trackEndX
 
WX_UNIT_BINDER m_trackEndY
 
WX_UNIT_BINDER m_trackWidth
 
WX_UNIT_BINDER m_viaX
 
WX_UNIT_BINDER m_viaY
 
WX_UNIT_BINDER m_viaDiameter
 
WX_UNIT_BINDER m_viaDrill
 
bool m_tracks
 

Flag that determines if the dialog displays track properties.

More...
 
bool m_vias
 

Flag that determines if the dialog displays via properties.

More...
 

Detailed Description

Definition at line 35 of file dialog_track_via_properties.h.

Constructor & Destructor Documentation

DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES ( PCB_BASE_FRAME aParent,
const SELECTION aItems 
)

Definition at line 34 of file dialog_track_via_properties.cpp.

References LSET::AllNonCuMask(), SELECTION::Empty(), VIA::GetDrillValue(), TRACK::GetEnd(), BOARD_ITEM::GetLayer(), VIA::GetPosition(), TRACK::GetStart(), TRACK::GetWidth(), TRACK::IsLocked(), m_items, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_lockedCbox, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_MainSizer, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_sbTrackSizer, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_sbViaSizer, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_StdButtonsOK, m_trackEndX, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndXCtrl, m_trackEndY, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndYCtrl, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackLayerCtrl, m_tracks, m_trackStartX, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartXCtrl, m_trackStartY, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartYCtrl, m_trackWidth, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthCtrl, m_viaDiameter, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterCtrl, m_viaDrill, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillCtrl, m_vias, m_viaX, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaXCtrl, m_viaY, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaYCtrl, onOkClick(), PCB_TRACE_T, PCB_VIA_T, PCB_LAYER_BOX_SELECTOR::Resync(), PCB_LAYER_BOX_SELECTOR::SetBoardFrame(), setCommonVal(), LAYER_BOX_SELECTOR::SetLayerSelection(), PCB_LAYER_BOX_SELECTOR::SetLayerSet(), LAYER_SELECTOR::SetLayersHotkeys(), wxPoint::x, and wxPoint::y.

34  :
35  DIALOG_TRACK_VIA_PROPERTIES_BASE( aParent ), m_items( aItems ),
41  m_viaX( aParent, m_ViaXCtrl, m_ViaXUnit ), m_viaY( aParent, m_ViaYCtrl, m_ViaYUnit ),
44  m_tracks( false ), m_vias( false )
45 {
46  assert( !m_items.Empty() );
47 
48  // This is a way to trick gcc into considering these variables as initialized
49  boost::optional<int> trackStartX = boost::make_optional<int>( false, 0 );
50  boost::optional<int> trackStartY = boost::make_optional<int>( false, 0 );
51  boost::optional<int> trackEndX = boost::make_optional<int>( false, 0 );
52  boost::optional<int> trackEndY = boost::make_optional<int>( false, 0 );
53  boost::optional<int> trackWidth = boost::make_optional<int>( false, 0 );
54  boost::optional<PCB_LAYER_ID> trackLayer = boost::make_optional<PCB_LAYER_ID>( false, (PCB_LAYER_ID) 0 );
55  boost::optional<int> viaX, viaY, viaDiameter;
56  boost::optional<int> viaDrill = boost::make_optional<int>( false, 0 );
57 
58  bool hasLocked = false;
59  bool hasUnlocked = false;
60 
61  // Look for values that are common for every item that is selected
62  for( auto& item : m_items )
63  {
64  switch( item->Type() )
65  {
66  case PCB_TRACE_T:
67  {
68  const TRACK* t = static_cast<const TRACK*>( item );
69 
70  if( !m_tracks ) // first track in the list
71  {
72  trackStartX = t->GetStart().x;
73  trackStartY = t->GetStart().y;
74  trackEndX = t->GetEnd().x;
75  trackEndY = t->GetEnd().y;
76  trackWidth = t->GetWidth();
77  trackLayer = t->GetLayer();
78  m_tracks = true;
79  }
80  else // check if values are the same for every selected track
81  {
82  if( trackStartX && ( *trackStartX != t->GetStart().x ) )
83  trackStartX = boost::none;
84 
85  if( trackStartY && ( *trackStartY != t->GetStart().y ) )
86  trackStartY = boost::none;
87 
88  if( trackEndX && ( *trackEndX != t->GetEnd().x ) )
89  trackEndX = boost::none;
90 
91  if( trackEndY && ( *trackEndY != t->GetEnd().y ) )
92  trackEndY = boost::none;
93 
94  if( trackWidth && ( *trackWidth != t->GetWidth() ) )
95  trackWidth = boost::none;
96 
97  if( trackLayer && ( *trackLayer != t->GetLayer() ) )
98  trackLayer = boost::none;
99  }
100 
101  if( t->IsLocked() )
102  hasLocked = true;
103  else
104  hasUnlocked = true;
105 
106  break;
107  }
108 
109  case PCB_VIA_T:
110  {
111  const VIA* v = static_cast<const VIA*>( item );
112 
113  if( !m_vias ) // first via in the list
114  {
115  viaX = v->GetPosition().x;
116  viaY = v->GetPosition().y;
117  viaDiameter = v->GetWidth();
118  viaDrill = v->GetDrillValue();
119  m_vias = true;
120  }
121  else // check if values are the same for every selected via
122  {
123  if( viaX && ( *viaX != v->GetPosition().x ) )
124  viaX = boost::none;
125 
126  if( viaY && ( *viaY != v->GetPosition().y ) )
127  viaY = boost::none;
128 
129  if( viaDiameter && ( *viaDiameter != v->GetWidth() ) )
130  viaDiameter = boost::none;
131 
132  if( viaDrill && ( *viaDrill != v->GetDrillValue() ) )
133  viaDrill = boost::none;
134  }
135 
136  if( v->IsLocked() )
137  hasLocked = true;
138  else
139  hasUnlocked = true;
140 
141  break;
142  }
143 
144  default:
145  assert( false );
146  break;
147  }
148  }
149 
150  assert( m_tracks || m_vias );
151 
152  if( m_vias )
153  {
154  setCommonVal( viaX, m_ViaXCtrl, m_viaX );
155  setCommonVal( viaY, m_ViaYCtrl, m_viaY );
157  setCommonVal( viaDrill, m_ViaDrillCtrl, m_viaDrill );
158  m_ViaDiameterCtrl->SetFocus();
159  }
160  else
161  {
162  m_MainSizer->Hide( m_sbViaSizer, true );
163  }
164 
165  if( m_tracks )
166  {
172 
175  m_TrackLayerCtrl->SetBoardFrame( aParent );
177 
178  if( trackLayer )
179  m_TrackLayerCtrl->SetLayerSelection( *trackLayer );
180 
181  m_TrackWidthCtrl->SetFocus();
182  }
183  else
184  {
185  m_MainSizer->Hide( m_sbTrackSizer, true );
186  }
187 
188  if( hasLocked && hasUnlocked )
189  {
190  m_lockedCbox->Set3StateValue( wxCHK_UNDETERMINED );
191  }
192  else if( hasLocked )
193  {
194  m_lockedCbox->Set3StateValue( wxCHK_CHECKED );
195  }
196  else
197  {
198  m_lockedCbox->Set3StateValue( wxCHK_UNCHECKED );
199  }
200 
201  m_StdButtonsOK->SetDefault();
202 
203  // Pressing ENTER when any of the text input fields is active applies changes
204  Connect( wxEVT_TEXT_ENTER, wxCommandEventHandler( DIALOG_TRACK_VIA_PROPERTIES::onOkClick ), NULL, this );
205 }
bool IsLocked() const override
Function IsLocked.
Definition: class_track.h:136
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:106
void setCommonVal(const boost::optional< T > &aVal, wxTextCtrl *aTxtCtrl, WX_UNIT_BINDER &aBinder)
Sets wxTextCtrl to the value stored in boost::optional or "<...>" if it is not available...
const SELECTION & m_items
Selected items to be modified.
bool m_tracks
Flag that determines if the dialog displays track properties.
static LSET AllNonCuMask()
Function AllNonCuMask returns a mask holding all layer minus CU layers.
Definition: lset.cpp:662
bool m_vias
Flag that determines if the dialog displays via properties.
void SetBoardFrame(PCB_BASE_FRAME *aFrame)
const wxPoint & GetEnd() const
Definition: class_track.h:118
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:107
PCB_LAYER_ID
A quick note on layer IDs:
const wxPoint & GetStart() const
Definition: class_track.h:121
int SetLayerSelection(LAYER_NUM layer)
bool SetLayersHotkeys(bool value)
DIALOG_TRACK_VIA_PROPERTIES_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Track & Via Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(573, 437), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU)
PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
void onOkClick(wxCommandEvent &aEvent) override
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
int GetWidth() const
Definition: class_track.h:115
const wxPoint & GetPosition() const override
Definition: class_track.h:411
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:108

Member Function Documentation

bool DIALOG_TRACK_VIA_PROPERTIES::Apply ( COMMIT aCommit)

Applies values from the dialog to the selected items.

Definition at line 208 of file dialog_track_via_properties.cpp.

References check(), TRACK::GetEnd(), LAYER_BOX_SELECTOR::GetLayerSelection(), BOARD_CONNECTED_ITEM::GetNetClass(), VIA::GetPosition(), TRACK::GetStart(), WX_UNIT_BINDER::GetValue(), VIA::GetViaType(), m_items, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_lockedCbox, m_trackEndX, m_trackEndY, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackLayerCtrl, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_trackNetclass, m_tracks, m_trackStartX, m_trackStartY, m_trackWidth, m_viaDiameter, m_viaDrill, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_viaNetclass, m_vias, m_viaX, m_viaY, COMMIT::Modify(), PCB_TRACE_T, PCB_VIA_T, VIA::SetDrill(), TRACK::SetEnd(), BOARD_ITEM::SetLayer(), TRACK::SetLocked(), VIA::SetPosition(), TRACK::SetStart(), TRACK::SetWidth(), UNDEFINED_LAYER, WX_UNIT_BINDER::Valid(), VIA_BLIND_BURIED, VIA_MICROVIA, VIA_THROUGH, wxPoint::x, and wxPoint::y.

Referenced by EDIT_TOOL::Properties().

209 {
210  if( !check() )
211  return false;
212 
213  bool changeLock = m_lockedCbox->Get3StateValue() != wxCHK_UNDETERMINED;
214  bool setLock = m_lockedCbox->Get3StateValue() == wxCHK_CHECKED;
215 
216  for( auto item : m_items )
217  {
218  aCommit.Modify( item );
219 
220  switch( item->Type() )
221  {
222  case PCB_TRACE_T:
223  {
224  assert( m_tracks );
225  TRACK* t = static_cast<TRACK*>( item );
226 
228  {
229  wxPoint start = t->GetStart();
230 
231  if( m_trackStartX.Valid() )
232  start.x = m_trackStartX.GetValue();
233 
234  if( m_trackStartY.Valid() )
235  start.y = m_trackStartY.GetValue();
236 
237  t->SetStart( start );
238  }
239 
240  if( m_trackEndX.Valid() || m_trackEndY.Valid() )
241  {
242  wxPoint end = t->GetEnd();
243 
244  if( m_trackEndX.Valid() )
245  end.x = m_trackEndX.GetValue();
246 
247  if( m_trackEndY.Valid() )
248  end.y = m_trackEndY.GetValue();
249 
250  t->SetEnd( end );
251  }
252 
253  if( m_trackNetclass->IsChecked() )
254  {
255  t->SetWidth( t->GetNetClass()->GetTrackWidth() );
256  }
257  else if( m_trackWidth.Valid() )
258  {
260  }
261 
263 
264  if( layer != UNDEFINED_LAYER )
265  t->SetLayer( (PCB_LAYER_ID) layer );
266 
267  if( changeLock )
268  t->SetLocked( setLock );
269 
270  break;
271  }
272 
273  case PCB_VIA_T:
274  {
275  assert( m_vias );
276 
277  VIA* v = static_cast<VIA*>( item );
278 
279  if( m_viaX.Valid() || m_viaY.Valid() )
280  {
281  wxPoint pos = v->GetPosition();
282 
283  if( m_viaX.Valid() )
284  pos.x = m_viaX.GetValue();
285 
286  if( m_viaY.Valid() )
287  pos.y = m_viaY.GetValue();
288 
289  v->SetPosition( pos );
290  }
291 
292  if( m_viaNetclass->IsChecked() )
293  {
294  switch( v->GetViaType() )
295  {
296  default:
297  wxFAIL_MSG("Unhandled via type");
298  // fall through
299 
300  case VIA_THROUGH:
301  case VIA_BLIND_BURIED:
302  v->SetWidth( v->GetNetClass()->GetViaDiameter() );
303  v->SetDrill( v->GetNetClass()->GetViaDrill() );
304  break;
305 
306  case VIA_MICROVIA:
307  v->SetWidth( v->GetNetClass()->GetuViaDiameter() );
308  v->SetDrill( v->GetNetClass()->GetuViaDrill() );
309  break;
310  }
311  }
312  else
313  {
314  if( m_viaDiameter.Valid() )
316 
317  if( m_viaDrill.Valid() )
318  v->SetDrill( m_viaDrill.GetValue() );
319  }
320 
321  if( changeLock )
322  v->SetLocked( setLock );
323 
324  break;
325  }
326 
327  default:
328  assert( false );
329  break;
330  }
331  }
332 
333  return true;
334 }
COMMIT & Modify(EDA_ITEM *aItem)
Modifies a given item in the model.
Definition: commit.h:103
bool check() const
Checks if the dialog values are correct.
void SetPosition(const wxPoint &aPoint) override
Definition: class_track.h:412
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
void SetEnd(const wxPoint &aEnd)
Definition: class_track.h:117
const SELECTION & m_items
Selected items to be modified.
bool m_tracks
Flag that determines if the dialog displays track properties.
bool m_vias
Flag that determines if the dialog displays via properties.
const wxPoint & GetEnd() const
Definition: class_track.h:118
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:107
void SetWidth(int aWidth)
Definition: class_track.h:114
bool Valid() const
Function Valid Returns true if the text control contains a real number.
void SetLocked(bool aLocked) override
Function SetLocked modifies 'lock' status for of the item.
Definition: class_track.h:141
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE_T GetViaType() const
Definition: class_track.h:439
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
const wxPoint & GetStart() const
Definition: class_track.h:121
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
virtual int GetValue() const
Function GetValue Returns the current value in Internal Units.
LAYER_NUM GetLayerSelection() const
void SetDrill(int aDrill)
Function SetDrill sets the drill value for vias.
Definition: class_track.h:447
const wxPoint & GetPosition() const override
Definition: class_track.h:411
void SetStart(const wxPoint &aStart)
Definition: class_track.h:120
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:108
bool DIALOG_TRACK_VIA_PROPERTIES::check ( ) const
private

Checks if the dialog values are correct.

Definition at line 380 of file dialog_track_via_properties.cpp.

References DisplayError(), WX_UNIT_BINDER::GetValue(), DIALOG_TRACK_VIA_PROPERTIES_BASE::m_trackNetclass, m_tracks, m_trackWidth, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthCtrl, m_viaDiameter, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterCtrl, m_viaDrill, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillCtrl, m_vias, and WX_UNIT_BINDER::Valid().

Referenced by Apply(), and onOkClick().

381 {
382  bool trackNetclass = m_trackNetclass->IsChecked();
383  bool viaNetclass = m_trackNetclass->IsChecked();
384 
385  if( m_tracks && !trackNetclass && m_trackWidth.Valid() && m_trackWidth.GetValue() <= 0 )
386  {
387  DisplayError( GetParent(), _( "Invalid track width" ) );
388  m_TrackWidthCtrl->SetFocus();
389  return false;
390  }
391 
392  if( m_vias && !viaNetclass )
393  {
394  if( m_viaDiameter.Valid() && m_viaDiameter.GetValue() <= 0 )
395  {
396  DisplayError( GetParent(), _( "Invalid via diameter" ) );
397  m_ViaDiameterCtrl->SetFocus();
398  return false;
399  }
400 
401  if( m_viaDrill.Valid() && m_viaDrill.GetValue() <= 0 )
402  {
403  DisplayError( GetParent(), _( "Invalid via drill size" ) );
404  m_ViaDrillCtrl->SetFocus();
405  return false;
406  }
407 
409  {
410  DisplayError( GetParent(), _( "Via drill size has to be smaller than via diameter" ) );
411  m_ViaDrillCtrl->SetFocus();
412  return false;
413  }
414  }
415 
416  return true;
417 }
bool m_tracks
Flag that determines if the dialog displays track properties.
bool m_vias
Flag that determines if the dialog displays via properties.
bool Valid() const
Function Valid Returns true if the text control contains a real number.
virtual int GetValue() const
Function GetValue Returns the current value in Internal Units.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:69
bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 182 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

183 {
184  // so we can do logging of this state change:
185 
186 #if defined(DEBUG)
187  const char* type_id = typeid( *this ).name();
188  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
189 #endif
190 
191  return wxDialog::Enable( enable );
192 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 540 of file dialog_shim.cpp.

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

541 {
542  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
543  // handle validation in the same way as other dialogs.
544  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
545  return;
546 
547  SetReturnCode( retCode );
548 
549  if( !IsQuasiModal() )
550  {
551  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
552  return;
553  }
554 
555  m_qmodal_showing = false;
556 
557  if( m_qmodal_loop )
558  {
559  if( m_qmodal_loop->IsRunning() )
560  m_qmodal_loop->Exit( 0 );
561  else
562  m_qmodal_loop->ScheduleExit( 0 );
563 
564  m_qmodal_loop = NULL;
565  }
566 
569 
570  Show( false );
571 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool IsQuasiModal()
Definition: dialog_shim.h:93
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

FinishDialogSettings must be called from derived classes, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DialogEditModuleText::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_MODULE_MODULE_EDITOR::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_MODULE_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), and DIALOG_SIGNAL_LIST::TransferDataToWindow().

105 {
106  // must be called from the constructor of derived classes,
107  // when all widgets are initialized, and therefore their size fixed
108 
109  // SetSizeHints fixes the minimal size of sizers in the dialog
110  // (SetSizeHints calls Fit(), so no need to call it)
111  GetSizer()->SetSizeHints( this );
112 
113  // the default position, when calling the first time the dlg
114  Center();
115 }
void DIALOG_SHIM::FixOSXCancelButtonIssue ( )
protectedinherited

A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.

Definition at line 117 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

118 {
119 #ifdef __WXMAC__
120  // A ugly hack to fix an issue on OSX: ctrl+c closes the dialog instead of
121  // copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer
122  // created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority
123  // to copy text standard accelerator, and the dlg is closed when trying to copy text
124  wxButton* button = dynamic_cast< wxButton* > ( wxWindow::FindWindowById( wxID_CANCEL, this ) );
125 
126  if( button )
127  button->SetLabel( _( "Cancel" ) );
128 #endif
129 }
KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendOneEEProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), LIB_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), SCH_SHEET::Load(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:85
void DIALOG_TRACK_VIA_PROPERTIES::onCancelClick ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_TRACK_VIA_PROPERTIES_BASE.

Definition at line 367 of file dialog_track_via_properties.cpp.

368 {
369  EndModal( 0 );
370 }
void DIALOG_TRACK_VIA_PROPERTIES::onClose ( wxCloseEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_TRACK_VIA_PROPERTIES_BASE.

Definition at line 337 of file dialog_track_via_properties.cpp.

338 {
339  EndModal( 0 );
340 }
void DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg ( wxInitDialogEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_TRACK_VIA_PROPERTIES_BASE.

Definition at line 50 of file dialog_track_via_properties.h.

References DIALOG_SHIM::FinishDialogSettings().

51  {
52  // Call the default wxDialog handler of a wxInitDialogEvent
53  TransferDataToWindow();
54 
55  // Now all widgets have the size fixed, call FinishDialogSettings
57  }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
void DIALOG_TRACK_VIA_PROPERTIES::onOkClick ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_TRACK_VIA_PROPERTIES_BASE.

Definition at line 373 of file dialog_track_via_properties.cpp.

References check().

Referenced by DIALOG_TRACK_VIA_PROPERTIES().

374 {
375  if( check() )
376  EndModal( 1 );
377 }
bool check() const
Checks if the dialog values are correct.
void DIALOG_TRACK_VIA_PROPERTIES::onTrackNetclassCheck ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_TRACK_VIA_PROPERTIES_BASE.

Definition at line 343 of file dialog_track_via_properties.cpp.

References DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthCtrl, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthLabel, and DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthUnit.

344 {
345  bool enableNC = aEvent.IsChecked();
346 
347  m_TrackWidthLabel->Enable( !enableNC );
348  m_TrackWidthCtrl->Enable( !enableNC );
349  m_TrackWidthUnit->Enable( !enableNC );
350 }
void DIALOG_TRACK_VIA_PROPERTIES::onViaNetclassCheck ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_TRACK_VIA_PROPERTIES_BASE.

Definition at line 353 of file dialog_track_via_properties.cpp.

References DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterCtrl, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterLabel, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterUnit, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillCtrl, DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillLabel, and DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillUnit.

354 {
355  bool enableNC = aEvent.IsChecked();
356 
357  m_ViaDiameterLabel->Enable( !enableNC );
358  m_ViaDiameterCtrl->Enable( !enableNC );
359  m_ViaDiameterUnit->Enable( !enableNC );
360 
361  m_ViaDrillLabel->Enable( !enableNC );
362  m_ViaDrillCtrl->Enable( !enableNC );
363  m_ViaDrillUnit->Enable( !enableNC );
364 }
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 34 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), SCH_EDIT_FRAME::backAnnotateFootprints(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_SCREEN::CheckComponentsToPartsLinks(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), SCH_EDIT_FRAME::CreateArchiveLibrary(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), LIB_EDIT_FRAME::DeleteOnePart(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EESCHEMA_CONFIG::DIALOG_EESCHEMA_CONFIG(), DIALOG_FP_LIB_TABLE::DIALOG_FP_LIB_TABLE(), DIALOG_MODULE_BOARD_EDITOR::DIALOG_MODULE_BOARD_EDITOR(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), LIB_EDIT_FRAME::GetCurPart(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), FOOTPRINT_EDIT_FRAME::getLibPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_EDIT_FRAME::InstallConfigFrame(), SCH_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), DIALOG_BOM_EDITOR::LoadComponents(), CVPCB_MAINFRAME::LoadFootprintFiles(), SCH_EDIT_FRAME::LoadOneEEFile(), LIB_EDIT_FRAME::LoadOneLibraryPart(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertLibClick(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertPath(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), LIB_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), DIALOG_NETLIST::OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectIcLib(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OnSelectUnit(), DIALOG_SPICE_MODEL::onSemiSelectLib(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_SCREEN::Save(), LIB_EDIT_FRAME::SaveActiveLibrary(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_ERC::TestErc(), DIALOG_SPICE_MODEL::updateFromFile(), SIM_PLOT_FRAME::updateNetlistExporter(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), CVPCB_MAINFRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_MODULE_BOARD_EDITOR::~DIALOG_MODULE_BOARD_EDITOR(), and DIALOG_MODULE_MODULE_EDITOR::~DIALOG_MODULE_MODULE_EDITOR().

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:144
template<typename T >
void DIALOG_TRACK_VIA_PROPERTIES::setCommonVal ( const boost::optional< T > &  aVal,
wxTextCtrl *  aTxtCtrl,
WX_UNIT_BINDER aBinder 
)
inlineprivate

Sets wxTextCtrl to the value stored in boost::optional<T> or "<...>" if it is not available.

Definition at line 64 of file dialog_track_via_properties.h.

References WX_UNIT_BINDER::SetValue().

Referenced by DIALOG_TRACK_VIA_PROPERTIES().

65  {
66  if( aVal )
67  aBinder.SetValue( *aVal );
68  else
69  aTxtCtrl->SetValue( "<...>" );
70  }
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_player.h:85
const char * name
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 139 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::FixOSXCancelButtonIssue(), EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_SCH_FIND::OnCancel(), DIALOG_ANNOTATE::OnCancelClick(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

140 {
141  bool ret;
142  const char* hash_key;
143 
144  if( m_hash_key.size() )
145  {
146  // a special case like EDA_LIST_DIALOG, which has multiple uses.
147  hash_key = m_hash_key.c_str();
148  }
149  else
150  {
151  hash_key = typeid(*this).name();
152  }
153 
154  // Show or hide the window. If hiding, save current position and size.
155  // If showing, use previous position and size.
156  if( show )
157  {
158  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
159  ret = wxDialog::Show( show );
160 
161  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
162  EDA_RECT r = class_map[ hash_key ];
163 
164  if( r.GetSize().x != 0 && r.GetSize().y != 0 )
165  SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
166  }
167  else
168  {
169  // Save the dialog's position & size before hiding, using classname as key
170  EDA_RECT r( wxDialog::GetPosition(), wxDialog::GetSize() );
171  class_map[ hash_key ] = r;
172 
173  ret = wxDialog::Show( show );
174  }
175 
177 
178  return ret;
179 }
std::string m_hash_key
Definition: dialog_shim.h:128
void FixOSXCancelButtonIssue()
A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.
static RECT_MAP class_map
const wxPoint & GetPosition() const
Class EDA_RECT handles the component boundary box.
const wxSize & GetSize() const
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 495 of file dialog_shim.cpp.

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), InvokeDialogCreateBOMEditor(), LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

496 {
497  // This is an exception safe way to zero a pointer before returning.
498  // Yes, even though DismissModal() clears this first normally, this is
499  // here in case there's an exception before the dialog is dismissed.
500  struct NULLER
501  {
502  void*& m_what;
503  NULLER( void*& aPtr ) : m_what( aPtr ) {}
504  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
505  } clear_this( (void*&) m_qmodal_loop );
506 
507  // release the mouse if it's currently captured as the window having it
508  // will be disabled when this dialog is shown -- but will still keep the
509  // capture making it impossible to do anything in the modal dialog itself
510  wxWindow* win = wxWindow::GetCapture();
511  if( win )
512  win->ReleaseMouse();
513 
514  // Get the optimal parent
515  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
516 
517  // Show the optimal parent
518  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
519 
520  wxASSERT_MSG( !m_qmodal_parent_disabler,
521  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
522 
523  // quasi-modal: disable only my "optimal" parent
525 
526  Show( true );
527 
528  m_qmodal_showing = true;
529 
530  EVENT_LOOP event_loop;
531 
532  m_qmodal_loop = &event_loop;
533 
534  event_loop.Run();
535 
536  return GetReturnCode();
537 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:33
#define DBG(x)
Definition: fctsys.h:33

Member Data Documentation

std::string DIALOG_SHIM::m_hash_key
protectedinherited
const SELECTION& DIALOG_TRACK_VIA_PROPERTIES::m_items
private

Selected items to be modified.

Definition at line 73 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxCheckBox* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_lockedCbox
protectedinherited
wxBoxSizer* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_MainSizer
protectedinherited
wxComboBox* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_NetComboBox
protectedinherited
EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 131 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited
wxStaticBoxSizer* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_sbCommonSizer
protectedinherited
wxStaticBoxSizer* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_sbTrackSizer
protectedinherited
wxStaticBoxSizer* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_sbViaSizer
protectedinherited
wxStaticLine* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_staticline3
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_staticText24
protectedinherited
wxStdDialogButtonSizer* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_StdButtons
protectedinherited
wxButton* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_StdButtonsCancel
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_trackEndX
private

Definition at line 76 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndXCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndXLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndXUnit
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_trackEndY
private

Definition at line 76 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndYCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndYLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackEndYUnit
protectedinherited
PCB_LAYER_BOX_SELECTOR* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackLayerCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackLayerLabel
protectedinherited
wxCheckBox* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_trackNetclass
protectedinherited
bool DIALOG_TRACK_VIA_PROPERTIES::m_tracks
private

Flag that determines if the dialog displays track properties.

Definition at line 83 of file dialog_track_via_properties.h.

Referenced by Apply(), check(), and DIALOG_TRACK_VIA_PROPERTIES().

WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_trackStartX
private

Definition at line 75 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartXCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartXLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartXUnit
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_trackStartY
private

Definition at line 75 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartYCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartYLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackStartYUnit
protectedinherited
wxStaticLine* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_trackStaticLine
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_trackWidth
private

Definition at line 77 of file dialog_track_via_properties.h.

Referenced by Apply(), check(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_TrackWidthUnit
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_viaDiameter
private

Definition at line 80 of file dialog_track_via_properties.h.

Referenced by Apply(), check(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDiameterUnit
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_viaDrill
private

Definition at line 80 of file dialog_track_via_properties.h.

Referenced by Apply(), check(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaDrillUnit
protectedinherited
PCB_LAYER_BOX_SELECTOR* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaEndLayer
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaEndLayerLabel1
protectedinherited
wxCheckBox* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_viaNetclass
protectedinherited
bool DIALOG_TRACK_VIA_PROPERTIES::m_vias
private

Flag that determines if the dialog displays via properties.

Definition at line 86 of file dialog_track_via_properties.h.

Referenced by Apply(), check(), and DIALOG_TRACK_VIA_PROPERTIES().

PCB_LAYER_BOX_SELECTOR* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaStartLayer
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaStartLayerLabel
protectedinherited
wxStaticLine* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_viaStaticLine
protectedinherited
wxChoice* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaTypeChoice
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaTypeLabel
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_viaX
private

Definition at line 79 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaXCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaXLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaXUnit
protectedinherited
WX_UNIT_BINDER DIALOG_TRACK_VIA_PROPERTIES::m_viaY
private

Definition at line 79 of file dialog_track_via_properties.h.

Referenced by Apply(), and DIALOG_TRACK_VIA_PROPERTIES().

wxTextCtrl* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaYCtrl
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaYLabel
protectedinherited
wxStaticText* DIALOG_TRACK_VIA_PROPERTIES_BASE::m_ViaYUnit
protectedinherited

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