KiCad PCB EDA Suite
DIALOG_SYMBOL_REMAP Class Reference

#include <dialog_symbol_remap.h>

Inheritance diagram for DIALOG_SYMBOL_REMAP:
DIALOG_SYMBOL_REMAP_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 DIALOG_SYMBOL_REMAP (SCH_EDIT_FRAME *aParent)
 
void OnRemapSymbols (wxCommandEvent &aEvent) override
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
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...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 

Protected Member Functions

void OnUpdateUIRemapButton (wxUpdateUIEvent &aEvent) override
 
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 SetSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int HorizPixelsFromDU (int x)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 
void ResetSize ()
 Clear the existing dialog size and position. More...
 

Protected Attributes

wxHtmlWindow * m_htmlCtrl
 
wxButton * m_buttonRemap
 
wxButton * m_buttonClose
 
WX_HTML_REPORT_PANELm_messagePanel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

size_t getLibsNotInGlobalSymbolLibTable (std::vector< PART_LIB * > &aLibs)
 Add libraries found in the legacy library list to aLibs that are not found in the global symbol library table. More...
 
void createProjectSymbolLibTable (REPORTER &aReporter)
 
void remapSymbolsToLibTable (REPORTER &aReporter)
 
bool remapSymbolToLibTable (SCH_COMPONENT *aSymbol)
 
bool backupProject (REPORTER &aReporter)
 Backup all of the files that could be modified by the remapping with a time stamp appended to the file name into the "remap_backup" folder in case something goes wrong. More...
 

Private Attributes

bool m_remapped
 

Detailed Description

Definition at line 37 of file dialog_symbol_remap.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_SYMBOL_REMAP()

DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP ( SCH_EDIT_FRAME aParent)

Definition at line 48 of file dialog_symbol_remap.cpp.

48  :
49  DIALOG_SYMBOL_REMAP_BASE( aParent )
50 {
51  m_remapped = false;
52 
53  if( !wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
54  {
55  DisplayInfoMessage( this, _( "Remapping is not possible because you do not have "
56  "write privileges to the project folder \"%s\"." ) );
57 
58  // Disable the remap button.
59  m_remapped = true;
60  }
61 
62  wxString text;
63 
64  text = _( "This schematic currently uses the project symbol library list look up method "
65  "for loading library symbols. KiCad will attempt to map the existing symbols "
66  "to use the new symbol library table. Remapping will change some project files "
67  "and schematics may not be compatible with older versions of KiCad. All files "
68  "that are changed will be backed up to the \"remap_backup\" folder in the project "
69  "folder should you need to revert any changes. If you choose to skip this step, "
70  "you will be responsible for manually remapping the symbols." );
71 
72  m_htmlCtrl->AppendToPage( text );
73 }
DIALOG_SYMBOL_REMAP_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Remap Symbols"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
Definition: 3d_actions.cpp:31
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:264

References _, DisplayInfoMessage(), DIALOG_SYMBOL_REMAP_BASE::m_htmlCtrl, m_remapped, and KIWAY_HOLDER::Prj().

Member Function Documentation

◆ backupProject()

bool DIALOG_SYMBOL_REMAP::backupProject ( REPORTER aReporter)
private

Backup all of the files that could be modified by the remapping with a time stamp appended to the file name into the "remap_backup" folder in case something goes wrong.

Backup the following:

  • All schematic (prj-name.sch -> remap_backup/prj-name-time-stamp.sch ) files.
  • The project (prj-name.pro) -> remap_backup/prj-name-time-stamp.pro) file.
  • The cache library (prj-name-cache.lib -> remap_backup/prj-name.-cache-time-stamp.lib) file.
  • The rescue library (prj-name-rescue.lib -> remap_backup/prj-name.rescue-time-stamp.lib) file.
  • The rescue library (prj-name-rescue.dcm -> remap_backup/prj-name.rescue-time-stamp.dcm) file.
Parameters
aReporteris the REPORTER object in which to write information messages.
Returns
true to continue rescue or false to abort rescue.

Definition at line 321 of file dialog_symbol_remap.cpp.

322 {
323  static wxString backupFolder = "rescue-backup";
324 
325  wxString tmp;
326  wxString errorMsg;
327  wxFileName srcFileName;
328  wxFileName destFileName;
329  wxFileName backupPath;
330  SCH_SCREENS schematic;
331 
332  // Copy backup files to different folder so as not to pollute the project folder.
333  destFileName.SetPath( Prj().GetProjectPath() );
334  destFileName.AppendDir( backupFolder );
335  backupPath = destFileName;
336 
337  if( !destFileName.DirExists() )
338  {
339  if( !destFileName.Mkdir() )
340  {
341  errorMsg.Printf( _( "Cannot create project remap back up folder \"%s\"." ),
342  destFileName.GetPath() );
343 
344  wxMessageDialog dlg( this, errorMsg, _( "Backup Error" ),
345  wxYES_NO | wxCENTRE | wxRESIZE_BORDER | wxICON_QUESTION );
346  dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Continue with Rescue" ) ),
347  wxMessageDialog::ButtonLabel( _( "Abort Rescue" ) ) );
348 
349  if( dlg.ShowModal() == wxID_NO )
350  return false;
351  }
352  }
353 
354  // Time stamp to append to file name in case multiple remappings are performed.
355  wxString timeStamp = wxDateTime::Now().Format( "-%Y-%m-%d-%H-%M-%S" );
356 
357  // Back up symbol library table.
358  srcFileName.SetPath( Prj().GetProjectPath() );
359  srcFileName.SetName( SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
360  destFileName = srcFileName;
361  destFileName.AppendDir( backupFolder );
362  destFileName.SetName( destFileName.GetName() + timeStamp );
363 
364  tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
365  srcFileName.GetFullPath(), destFileName.GetFullPath() );
366  aReporter.Report( tmp, REPORTER::RPT_INFO );
367 
368  if( wxFileName::Exists( srcFileName.GetFullPath() )
369  && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
370  {
371  tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
372  errorMsg += tmp;
373  }
374 
375  // Back up the schematic files.
376  for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
377  {
378  destFileName = screen->GetFileName();
379  destFileName.SetName( destFileName.GetName() + timeStamp );
380 
381  // Check for nest hierarchical schematic paths.
382  if( destFileName.GetPath() != backupPath.GetPath() )
383  {
384  destFileName.SetPath( backupPath.GetPath() );
385 
386  wxArrayString srcDirs = wxFileName( screen->GetFileName() ).GetDirs();
387  wxArrayString destDirs = wxFileName( Prj().GetProjectPath() ).GetDirs();
388 
389  for( size_t i = destDirs.GetCount(); i < srcDirs.GetCount(); i++ )
390  destFileName.AppendDir( srcDirs[i] );
391  }
392  else
393  {
394  destFileName.AppendDir( backupFolder );
395  }
396 
397  tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
398  screen->GetFileName(), destFileName.GetFullPath() );
399  aReporter.Report( tmp, REPORTER::RPT_INFO );
400 
401  if( !destFileName.DirExists() && !destFileName.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
402  {
403  tmp.Printf( _( "Failed to create backup folder \"%s\"\n" ), destFileName.GetPath() );
404  errorMsg += tmp;
405  continue;
406  }
407 
408  if( wxFileName::Exists( screen->GetFileName() )
409  && !wxCopyFile( screen->GetFileName(), destFileName.GetFullPath() ) )
410  {
411  tmp.Printf( _( "Failed to back up file \"%s\".\n" ), screen->GetFileName() );
412  errorMsg += tmp;
413  }
414  }
415 
416  // Back up the project file.
417  destFileName = Prj().GetProjectFullName();
418  destFileName.SetName( destFileName.GetName() + timeStamp );
419  destFileName.AppendDir( backupFolder );
420 
421  tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
422  Prj().GetProjectFullName(), destFileName.GetFullPath() );
423  aReporter.Report( tmp, REPORTER::RPT_INFO );
424 
425  if( wxFileName::Exists( Prj().GetProjectFullName() )
426  && !wxCopyFile( Prj().GetProjectFullName(), destFileName.GetFullPath() ) )
427  {
428  tmp.Printf( _( "Failed to back up file \"%s\".\n" ), Prj().GetProjectFullName() );
429  errorMsg += tmp;
430  }
431 
432  // Back up the cache library.
433  srcFileName.SetPath( Prj().GetProjectPath() );
434  srcFileName.SetName( Prj().GetProjectName() + "-cache" );
435  srcFileName.SetExt( SchematicLibraryFileExtension );
436 
437  destFileName = srcFileName;
438  destFileName.SetName( destFileName.GetName() + timeStamp );
439  destFileName.AppendDir( backupFolder );
440 
441  tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
442  srcFileName.GetFullPath(), destFileName.GetFullPath() );
443  aReporter.Report( tmp, REPORTER::RPT_INFO );
444 
445  if( srcFileName.Exists()
446  && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
447  {
448  tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
449  errorMsg += tmp;
450  }
451 
452  // Back up the rescue symbol library if it exists.
453  srcFileName.SetName( Prj().GetProjectName() + "-rescue" );
454  destFileName.SetName( srcFileName.GetName() + timeStamp );
455 
456  tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
457  srcFileName.GetFullPath(), destFileName.GetFullPath() );
458  aReporter.Report( tmp, REPORTER::RPT_INFO );
459 
460  if( srcFileName.Exists()
461  && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
462  {
463  tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
464  errorMsg += tmp;
465  }
466 
467  // Back up the rescue symbol library document file if it exists.
468  srcFileName.SetExt( "dcm" );
469  destFileName.SetExt( srcFileName.GetExt() );
470 
471  tmp.Printf( _( "Backing up file \"%s\" to file \"%s\"." ),
472  srcFileName.GetFullPath(), destFileName.GetFullPath() );
473  aReporter.Report( tmp, REPORTER::RPT_INFO );
474 
475  if( srcFileName.Exists()
476  && !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
477  {
478  tmp.Printf( _( "Failed to back up file \"%s\".\n" ), srcFileName.GetFullPath() );
479  errorMsg += tmp;
480  }
481 
482  if( !errorMsg.IsEmpty() )
483  {
484  wxMessageDialog dlg( this, _( "Some of the project files could not be backed up." ),
485  _( "Backup Error" ),
486  wxYES_NO | wxCENTRE | wxRESIZE_BORDER | wxICON_QUESTION );
487  errorMsg.Trim();
488  dlg.SetExtendedMessage( errorMsg );
489  dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Continue with Rescue" ) ),
490  wxMessageDialog::ButtonLabel( _( "Abort Rescue" ) ) );
491 
492  if( dlg.ShowModal() == wxID_NO )
493  return false;
494  }
495 
496  return true;
497 }
static const wxString & GetSymbolLibTableFileName()
SCH_SCREEN * GetNext()
Definition: sch_screen.cpp:981
const std::string SchematicLibraryFileExtension
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Definition: project.cpp:96
#define _(s)
Definition: 3d_actions.cpp:31
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
SCH_SCREEN * GetFirst()
Definition: sch_screen.cpp:970
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:498

References _, SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), PROJECT::GetProjectFullName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), KIWAY_HOLDER::Prj(), REPORTER::Report(), REPORTER::RPT_INFO, and SchematicLibraryFileExtension.

Referenced by OnRemapSymbols().

◆ createProjectSymbolLibTable()

void DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable ( REPORTER aReporter)
private

Definition at line 159 of file dialog_symbol_remap.cpp.

160 {
161  wxString msg;
162  std::vector< PART_LIB* > libs;
163 
165  {
166  SYMBOL_LIB_TABLE prjLibTable;
167  std::vector< wxString > libNames = SYMBOL_LIB_TABLE::GetGlobalLibTable().GetLogicalLibs();
168 
169  for( auto lib : libs )
170  {
171  wxString libName = lib->GetName();
172  int libNameInc = 1;
173  int libNameLen = libName.Length();
174 
175  // Spaces in the file name will break the symbol name because they are not
176  // quoted in the symbol library file format.
177  libName.Replace( " ", "-" );
178 
179  // Don't create duplicate table entries.
180  while( std::find( libNames.begin(), libNames.end(), libName ) != libNames.end() )
181  {
182  libName = libName.Left( libNameLen );
183  libName << libNameInc;
184  libNameInc++;
185  }
186 
187  wxString pluginType = SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY );
188  wxFileName fn = lib->GetFullFileName();
189 
190  // Use environment variable substitution where possible. This is based solely
191  // on the internal user environment variable list. Checking against all of the
192  // system wide environment variables is probably not a good idea.
193  wxString fullFileName = NormalizePath( fn, &Pgm().GetLocalEnvVariables(), &Prj() );
194 
195  // Fall back to the absolute library path.
196  if( fullFileName.IsEmpty() )
197  fullFileName = lib->GetFullFileName();
198 
199  wxFileName tmpFn = fullFileName;
200 
201  // Don't add symbol libraries that do not exist.
202  if( tmpFn.Normalize() && tmpFn.FileExists() )
203  {
204  msg.Printf( _( "Adding library \"%s\", file \"%s\" to project symbol library table." ),
205  libName, fullFileName );
206  aReporter.Report( msg, REPORTER::RPT_INFO );
207 
208  prjLibTable.InsertRow( new SYMBOL_LIB_TABLE_ROW( libName, fullFileName,
209  pluginType ) );
210  }
211  else
212  {
213  msg.Printf( _( "Library \"%s\" not found." ), fullFileName );
214  aReporter.Report( msg, REPORTER::RPT_WARNING );
215  }
216  }
217 
218  // Don't save empty project symbol library table.
219  if( !prjLibTable.IsEmpty() )
220  {
221  wxFileName fn( Prj().GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
222 
223  try
224  {
225  FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
226  prjLibTable.Format( &formatter, 0 );
227  }
228  catch( const IO_ERROR& ioe )
229  {
230  msg.Printf( _( "Failed to write project symbol library table. Error:\n %s" ),
231  ioe.What() );
232  aReporter.ReportTail( msg, REPORTER::RPT_ERROR );
233  }
234 
235  aReporter.ReportTail( _( "Created project symbol library table.\n" ), REPORTER::RPT_INFO );
236  }
237  }
238 }
static const wxString & GetSymbolLibTableFileName()
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:98
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
size_t getLibsNotInGlobalSymbolLibTable(std::vector< PART_LIB * > &aLibs)
Add libraries found in the legacy library list to aLibs that are not found in the global symbol libra...
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:76
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
Function ReportTail Places the report at the end of the list, for objects that support report orderin...
Definition: reporter.h:111
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const override
Generate the table in s-expression format to aOutput with an indention level of aIndentLevel.
#define _(s)
Definition: 3d_actions.cpp:31
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalizes a file path to an environmental variable, if possible.
Definition: env_paths.cpp:67
bool IsEmpty(bool aIncludeFallback=true)
Return true if the table is empty.
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References _, SYMBOL_LIB_TABLE::Format(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), getLibsNotInGlobalSymbolLibTable(), LIB_TABLE::GetLogicalLibs(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), LIB_TABLE::InsertRow(), LIB_TABLE::IsEmpty(), NormalizePath(), Pgm(), KIWAY_HOLDER::Prj(), REPORTER::Report(), REPORTER::ReportTail(), REPORTER::RPT_ERROR, REPORTER::RPT_INFO, REPORTER::RPT_WARNING, SCH_IO_MGR::ShowType(), and IO_ERROR::What().

Referenced by OnRemapSymbols().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 262 of file dialog_shim.cpp.

263 {
264  // so we can do logging of this state change:
265 
266 #if 0 && defined(DEBUG)
267  const char* type_id = typeid( *this ).name();
268  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
269  fflush(0); //Needed on msys2 to immediately print the message
270 #endif
271 
272  return wxDialog::Enable( enable );
273 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 419 of file dialog_shim.cpp.

420 {
421  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
422  // handle validation in the same way as other dialogs.
423  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
424  return;
425 
426  SetReturnCode( retCode );
427 
428  if( !IsQuasiModal() )
429  {
430  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
431  "wasn't called" );
432  return;
433  }
434 
435  if( m_qmodal_loop )
436  {
437  if( m_qmodal_loop->IsRunning() )
438  m_qmodal_loop->Exit( 0 );
439  else
440  m_qmodal_loop->ScheduleExit( 0 );
441 
443  }
444 
447 
448  Show( false );
449 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:124
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FinishDialogSettings()

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 137 of file dialog_shim.cpp.

138 {
139  // must be called from the constructor of derived classes,
140  // when all widgets are initialized, and therefore their size fixed
141 
142  // SetSizeHints fixes the minimal size of sizers in the dialog
143  // (SetSizeHints calls Fit(), so no need to call it)
144  GetSizer()->SetSizeHints( this );
145 
146  // the default position, when calling the first time the dlg
147  Center();
148 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_EDITOR_DATA::DIALOG_EDITOR_DATA(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), 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_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ getLibsNotInGlobalSymbolLibTable()

size_t DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable ( std::vector< PART_LIB * > &  aLibs)
private

Add libraries found in the legacy library list to aLibs that are not found in the global symbol library table.

This function is used to create a project symbol library table when converting legacy projects over to the new symbol library table implementation. This only needs to be called the first time a legacy project is opened. The cache library is ignored.

Parameters
aLibsis a vector container to add all of the libraries not found in the global symbol library table that were found in the legacy library list.
Returns
the number of libraries found.

Definition at line 138 of file dialog_symbol_remap.cpp.

139 {
140  PART_LIBS* libs = Prj().SchLibs();
141 
142  for( PART_LIBS_BASE::iterator it = libs->begin(); it != libs->end(); ++it )
143  {
144  // Ignore the cache library.
145  if( it->IsCache() )
146  continue;
147 
148  // Check for the obvious library name.
149  wxString libFileName = it->GetFullFileName();
150 
151  if( !SYMBOL_LIB_TABLE::GetGlobalLibTable().FindRowByURI( libFileName ) )
152  aLibs.push_back( &(*it) );
153  }
154 
155  return aLibs.size();
156 }
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
A collection of PART_LIB objects.

References SYMBOL_LIB_TABLE::GetGlobalLibTable(), and KIWAY_HOLDER::Prj().

Referenced by createProjectSymbolLibTable().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 158 of file dialog_shim.cpp.

159 {
160  wxSize sz( x, 0 );
161  return ConvertDialogToPixels( sz ).x;
162 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), and DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 137 of file dialog_shim.h.

138  {
139  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
140  !e.ShiftDown() && !e.MetaDown();
141  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 143 of file dialog_shim.h.

144  {
145  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
146  e.ShiftDown() && !e.MetaDown();
147  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ Kiway()

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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 320 of file dialog_shim.cpp.

321 {
322  if( m_firstPaintEvent )
323  {
324 #ifdef __WXMAC__
325  fixOSXCancelButtonIssue( this );
326 #endif
327 
328  selectAllInTextCtrls( GetChildren() );
329 
331  m_initialFocusTarget->SetFocus();
332  else
333  SetFocus(); // Focus the dialog itself
334 
335  m_firstPaintEvent = false;
336  }
337 
338  event.Skip();
339 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203
bool m_firstPaintEvent
Definition: dialog_shim.h:202
static void selectAllInTextCtrls(wxWindowList &children)

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnRemapSymbols()

void DIALOG_SYMBOL_REMAP::OnRemapSymbols ( wxCommandEvent &  aEvent)
overridevirtual

Reimplemented from DIALOG_SYMBOL_REMAP_BASE.

Definition at line 76 of file dialog_symbol_remap.cpp.

77 {
78  SCH_EDIT_FRAME* parent = dynamic_cast< SCH_EDIT_FRAME* >( GetParent() );
79 
80  wxCHECK_RET( parent != nullptr, "Parent window is not type SCH_EDIT_FRAME." );
81 
82  wxBusyCursor busy;
83 
85  return;
86 
87  // Ignore the never show rescue setting for one last rescue of legacy symbol
88  // libraries before remapping to the symbol library table. This ensures the
89  // best remapping results.
90  LEGACY_RESCUER rescuer( Prj(), &parent->GetCurrentSheet(), parent->GetCanvas()->GetBackend() );
91 
92  if( RESCUER::RescueProject( this, rescuer, false ) )
93  {
94  LIB_VIEW_FRAME* viewer = (LIB_VIEW_FRAME*) parent->Kiway().Player( FRAME_SCH_VIEWER, false );
95 
96  if( viewer )
97  viewer->ReCreateListLib();
98 
99  parent->GetScreen()->ClearUndoORRedoList( parent->GetScreen()->m_UndoList, 1 );
100  parent->SyncView();
101  parent->GetCanvas()->Refresh();
102  parent->OnModify();
103  }
104 
105  // The schematic is fully loaded, any legacy library symbols have been rescued. Now
106  // check to see if the schematic has not been converted to the symbol library table
107  // method for looking up symbols.
108  wxFileName prjSymLibTableFileName( Prj().GetProjectPath(),
110 
111  // Delete the existing project symbol library table.
112  if( prjSymLibTableFileName.FileExists() )
113  {
114  wxRemoveFile( prjSymLibTableFileName.GetFullPath() );
115  }
116 
119  Prj().SchSymbolLibTable();
120 
122 
123  // Remove all of the libraries from the legacy library list.
124  wxString paths;
125  wxArrayString libNames;
126 
127  PART_LIBS::LibNamesAndPaths( &Prj(), true, &paths, &libNames );
128 
129  // Reload the the cache symbol library.
131  Prj().SchLibs();
132 
133  Raise();
134  m_remapped = true;
135 }
static const wxString & GetSymbolLibTableFileName()
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
static void LibNamesAndPaths(PROJECT *aProject, bool doSave, wxString *aPaths, wxArrayString *aNames=NULL)
Save or load the names of the currently configured part libraries (without paths).
Schematic editor (Eeschema) main window.
Symbol library viewer main window.
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:217
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static bool RescueProject(wxWindow *aParent, RESCUER &aRescuer, bool aRunningOnDemand)
void createProjectSymbolLibTable(REPORTER &aReporter)
#define NULL
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:341
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:132
void SyncView()
Mark all items for refresh.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
REPORTER & Reporter()
returns the reporter object that reports to this panel
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
SCH_SHEET_PATH & GetCurrentSheet()
void remapSymbolsToLibTable(REPORTER &aReporter)
WX_HTML_REPORT_PANEL * m_messagePanel
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool backupProject(REPORTER &aReporter)
Backup all of the files that could be modified by the remapping with a time stamp appended to the fil...
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1) override
Free the undo or redo list from aList element.
Definition: sch_screen.cpp:623
bool ReCreateListLib()
Creates or recreates a sorted list of currently loaded libraries.

References backupProject(), SCH_SCREEN::ClearUndoORRedoList(), createProjectSymbolLibTable(), PROJECT::ELEM_SCH_PART_LIBS, PROJECT::ELEM_SYMBOL_LIB_TABLE, FRAME_SCH_VIEWER, EDA_DRAW_PANEL_GAL::GetBackend(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_EDIT_FRAME::GetScreen(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), KIWAY_HOLDER::Kiway(), PART_LIBS::LibNamesAndPaths(), DIALOG_SYMBOL_REMAP_BASE::m_messagePanel, m_remapped, BASE_SCREEN::m_UndoList, NULL, SCH_EDIT_FRAME::OnModify(), KIWAY::Player(), KIWAY_HOLDER::Prj(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_DRAW_PANEL_GAL::Refresh(), remapSymbolsToLibTable(), WX_HTML_REPORT_PANEL::Reporter(), RESCUER::RescueProject(), PROJECT::SetElem(), and SCH_BASE_FRAME::SyncView().

◆ OnUpdateUIRemapButton()

void DIALOG_SYMBOL_REMAP::OnUpdateUIRemapButton ( wxUpdateUIEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_SYMBOL_REMAP_BASE.

Definition at line 500 of file dialog_symbol_remap.cpp.

501 {
502  aEvent.Enable( !m_remapped );
503 }

References m_remapped.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:171

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ remapSymbolsToLibTable()

void DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable ( REPORTER aReporter)
private

Definition at line 241 of file dialog_symbol_remap.cpp.

242 {
243  wxString msg;
244  SCH_SCREENS schematic;
245  SCH_COMPONENT* symbol;
246  SCH_SCREEN* screen;
247 
248  for( screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
249  {
250  for( auto item : screen->Items().OfType( SCH_COMPONENT_T ) )
251  {
252  symbol = dynamic_cast<SCH_COMPONENT*>( item );
253 
254  if( !remapSymbolToLibTable( symbol ) )
255  {
256  msg.Printf( _( "No symbol \"%s\" found in symbol library table." ),
257  symbol->GetLibId().GetLibItemName().wx_str() );
258  aReporter.Report( msg, REPORTER::RPT_WARNING );
259  }
260  else
261  {
262  msg.Printf( _( "Symbol \"%s\" mapped to symbol library \"%s\"." ),
263  symbol->GetLibId().GetLibItemName().wx_str(),
264  symbol->GetLibId().GetLibNickname().wx_str() );
265  aReporter.Report( msg, REPORTER::RPT_ACTION );
266  screen->SetModify();
267  }
268  }
269  }
270 
271  aReporter.Report( _( "Symbol library table mapping complete!" ), REPORTER::RPT_INFO );
272  schematic.UpdateSymbolLinks( true );
273 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
SCH_SCREEN * GetNext()
Definition: sch_screen.cpp:981
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
bool remapSymbolToLibTable(SCH_COMPONENT *aSymbol)
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in the ful...
#define _(s)
Definition: 3d_actions.cpp:31
EE_RTREE & Items()
Definition: sch_screen.h:127
wxString wx_str() const
Definition: utf8.cpp:51
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:89
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
SCH_SCREEN * GetFirst()
Definition: sch_screen.cpp:970
void SetModify()
Definition: base_screen.h:224
const LIB_ID & GetLibId() const
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:498

References _, SCH_SCREENS::GetFirst(), SCH_COMPONENT::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SCH_SCREENS::GetNext(), SCH_SCREEN::Items(), EE_RTREE::OfType(), remapSymbolToLibTable(), REPORTER::Report(), REPORTER::RPT_ACTION, REPORTER::RPT_INFO, REPORTER::RPT_WARNING, SCH_COMPONENT_T, BASE_SCREEN::SetModify(), SCH_SCREENS::UpdateSymbolLinks(), and UTF8::wx_str().

Referenced by OnRemapSymbols().

◆ remapSymbolToLibTable()

bool DIALOG_SYMBOL_REMAP::remapSymbolToLibTable ( SCH_COMPONENT aSymbol)
private

Definition at line 276 of file dialog_symbol_remap.cpp.

277 {
278  wxCHECK_MSG( aSymbol != NULL, false, "Null pointer passed to remapSymbolToLibTable." );
279  wxCHECK_MSG( aSymbol->GetLibId().GetLibNickname().empty(), false,
280  "Cannot remap symbol that is already mapped." );
281  wxCHECK_MSG( !aSymbol->GetLibId().GetLibItemName().empty(), false,
282  "The symbol LIB_ID name is empty." );
283 
284  PART_LIBS* libs = Prj().SchLibs();
285 
286  for( PART_LIBS_BASE::iterator it = libs->begin(); it != libs->end(); ++it )
287  {
288  // Ignore the cache library.
289  if( it->IsCache() )
290  continue;
291 
292  LIB_PART* alias = it->FindPart( aSymbol->GetLibId().GetLibItemName().wx_str() );
293 
294  // Found in the same library as the old look up method assuming the user didn't
295  // change the libraries or library ordering since the last time the schematic was
296  // loaded.
297  if( alias )
298  {
299  // Find the same library in the symbol library table using the full path and file name.
300  wxString libFileName = it->GetFullFileName();
301 
302  const LIB_TABLE_ROW* row = Prj().SchSymbolLibTable()->FindRowByURI( libFileName );
303 
304  if( row )
305  {
306  LIB_ID id = aSymbol->GetLibId();
307 
308  id.SetLibNickname( row->GetNickName() );
309 
310  // Don't resolve symbol library links now.
311  aSymbol->SetLibId( id, nullptr, nullptr );
312  return true;
313  }
314  }
315  }
316 
317  return false;
318 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const wxString & GetNickName() const
void SetLibId(const LIB_ID &aName, PART_LIBS *aLibs=NULL)
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Define a library symbol object.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
A collection of PART_LIB objects.
wxString wx_str() const
Definition: utf8.cpp:51
const LIB_ID & GetLibId() const
bool empty() const
Definition: utf8.h:108

References UTF8::empty(), SCH_COMPONENT::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TABLE_ROW::GetNickName(), NULL, KIWAY_HOLDER::Prj(), SCH_COMPONENT::SetLibId(), LIB_ID::SetLibNickname(), and UTF8::wx_str().

Referenced by remapSymbolsToLibTable().

◆ ResetSize()

void DIALOG_SHIM::ResetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 237 of file dialog_shim.cpp.

238 {
239  const char* hash_key;
240 
241  if( m_hash_key.size() )
242  {
243  // a special case like EDA_LIST_DIALOG, which has multiple uses.
244  hash_key = m_hash_key.c_str();
245  }
246  else
247  {
248  hash_key = typeid(*this).name();
249  }
250 
251  RECT_MAP::iterator it = class_map.find( hash_key );
252 
253  if( it == class_map.end() )
254  return;
255 
256  EDA_RECT rect = it->second;
257  rect.SetSize( 0, 0 );
258  class_map[ hash_key ] = rect;
259 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 115 of file dialog_shim.h.

116  {
117  m_initialFocusTarget = aWindow;
118  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetSizeInDU()

void DIALOG_SHIM::SetSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 151 of file dialog_shim.cpp.

152 {
153  wxSize sz( x, y );
154  SetSize( ConvertDialogToPixels( sz ) );
155 }

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 178 of file dialog_shim.cpp.

179 {
180  bool ret;
181  const char* hash_key;
182 
183  if( m_hash_key.size() )
184  {
185  // a special case like EDA_LIST_DIALOG, which has multiple uses.
186  hash_key = m_hash_key.c_str();
187  }
188  else
189  {
190  hash_key = typeid(*this).name();
191  }
192 
193  // Show or hide the window. If hiding, save current position and size.
194  // If showing, use previous position and size.
195  if( show )
196  {
197 #ifndef __WINDOWS__
198  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
199 #endif
200  ret = wxDialog::Show( show );
201 
202  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
203  EDA_RECT savedDialogRect = class_map[ hash_key ];
204 
205  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
206  {
207  SetSize( savedDialogRect.GetPosition().x,
208  savedDialogRect.GetPosition().y,
209  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
210  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
211  0 );
212  }
213 
214  // Be sure that the dialog appears in a visible area
215  // (the dialog position might have been stored at the time when it was
216  // shown on another display)
217  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
218  Centre();
219  }
220  else
221  {
222  // Save the dialog's position & size before hiding, using classname as key
223  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
224 
225 #ifdef __WXMAC__
226  if ( m_eventLoop )
227  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
228 #endif
229 
230  ret = wxDialog::Show( show );
231  }
232 
233  return ret;
234 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:115
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetSize() const
Definition: eda_rect.h:103

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickFootprints(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 365 of file dialog_shim.cpp.

366 {
367  // This is an exception safe way to zero a pointer before returning.
368  // Yes, even though DismissModal() clears this first normally, this is
369  // here in case there's an exception before the dialog is dismissed.
370  struct NULLER
371  {
372  void*& m_what;
373  NULLER( void*& aPtr ) : m_what( aPtr ) {}
374  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
375  } clear_this( (void*&) m_qmodal_loop );
376 
377  // release the mouse if it's currently captured as the window having it
378  // will be disabled when this dialog is shown -- but will still keep the
379  // capture making it impossible to do anything in the modal dialog itself
380  wxWindow* win = wxWindow::GetCapture();
381  if( win )
382  win->ReleaseMouse();
383 
384  // Get the optimal parent
385  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
386 
387  // Show the optimal parent
388  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
389 
390  wxASSERT_MSG( !m_qmodal_parent_disabler,
391  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
392 
393  // quasi-modal: disable only my "optimal" parent
395 
396 #ifdef __WXMAC__
397  // Apple in its infinite wisdom will raise a disabled window before even passing
398  // us the event, so we have no way to stop it. Instead, we must set an order on
399  // the windows so that the quasi-modal will be pushed in front of the disabled
400  // window when it is raised.
401  ReparentQuasiModal();
402 #endif
403  Show( true );
404 
405  m_qmodal_showing = true;
406 
407  WX_EVENT_LOOP event_loop;
408 
409  m_qmodal_loop = &event_loop;
410 
411  event_loop.Run();
412 
413  m_qmodal_showing = false;
414 
415  return GetReturnCode();
416 }
bool m_qmodal_showing
Definition: dialog_shim.h:207
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

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

Referenced by LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 165 of file dialog_shim.cpp.

166 {
167  wxSize sz( 0, y );
168  return ConvertDialogToPixels( sz ).y;
169 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), and DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT().

Member Data Documentation

◆ m_buttonClose

wxButton* DIALOG_SYMBOL_REMAP_BASE::m_buttonClose
protectedinherited

◆ m_buttonRemap

wxButton* DIALOG_SYMBOL_REMAP_BASE::m_buttonRemap
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 202 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_htmlCtrl

wxHtmlWindow* DIALOG_SYMBOL_REMAP_BASE::m_htmlCtrl
protectedinherited

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 203 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

◆ m_messagePanel

WX_HTML_REPORT_PANEL* DIALOG_SYMBOL_REMAP_BASE::m_messagePanel
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 205 of file dialog_shim.h.

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

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 207 of file dialog_shim.h.

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

◆ m_remapped

bool DIALOG_SYMBOL_REMAP::m_remapped
private

◆ m_tabOrder

◆ m_units


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