KiCad PCB EDA Suite
invoke_sch_dialog.h File Reference
#include <set>
#include <vector>
#include <list>
#include <class_draw_panel_gal.h>

Go to the source code of this file.

Macros

#define NET_PLUGIN_CHANGE   1
 Create and shows NETLIST_DIALOG and returns whatever NETLIST_DIALOG::ShowModal() returns. More...
 

Functions

int InvokeDialogRescueEach (wxWindow *aParent, RESCUER &aRescuer, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType, bool aAskShowAgain)
 This dialog asks the user which rescuable, cached parts he wants to rescue. More...
 
int InvokeDialogPrintUsingPrinter (SCH_EDIT_FRAME *aCaller)
 Create and show DIALOG_PRINT_USING_PRINTER and return whatever DIALOG_PRINT_USING_PRINTER::ShowModal() returns. More...
 
int InvokeDialogCreateBOM (SCH_EDIT_FRAME *aCaller)
 Create and show DIALOG_BOM and return whatever DIALOG_BOM::ShowModal() returns. More...
 
void InvokeDialogBusManager (SCH_EDIT_FRAME *aCaller)
 Create and show DIALOG_BUS_MANAGER. More...
 
int InvokeDialogNetList (SCH_EDIT_FRAME *aCaller)
 
bool InvokeDialogEditSymbolsLibId (SCH_EDIT_FRAME *aCaller)
 Run a dialog to modify the LIB_ID of symbols for instance when a symbol has moved from a symbol library to another symbol library. More...
 

Macro Definition Documentation

◆ NET_PLUGIN_CHANGE

#define NET_PLUGIN_CHANGE   1

Create and shows NETLIST_DIALOG and returns whatever NETLIST_DIALOG::ShowModal() returns.

Parameters
int- NET_PLUGIN_CHANGE means user added or deleted a plugin, wxID_OK, or wxID_CANCEL.

Definition at line 90 of file invoke_sch_dialog.h.

Function Documentation

◆ InvokeDialogBusManager()

void InvokeDialogBusManager ( SCH_EDIT_FRAME aCaller)

Create and show DIALOG_BUS_MANAGER.

Definition at line 490 of file dialog_bus_manager.cpp.

491 {
492  DIALOG_BUS_MANAGER dlg( aCaller );
493  dlg.ShowModal();
494 }

Referenced by SCH_EDITOR_CONTROL::ShowBusManager().

◆ InvokeDialogCreateBOM()

int InvokeDialogCreateBOM ( SCH_EDIT_FRAME aCaller)

Create and show DIALOG_BOM and return whatever DIALOG_BOM::ShowModal() returns.

Definition at line 108 of file dialog_bom.cpp.

109 {
110  DIALOG_BOM dlg( aCaller );
111 
112  // QuasiModal so syntax help works
113  return dlg.ShowQuasiModal();
114 }

References DIALOG_SHIM::ShowQuasiModal().

Referenced by SCH_EDITOR_CONTROL::GenerateBOM().

◆ InvokeDialogEditSymbolsLibId()

bool InvokeDialogEditSymbolsLibId ( SCH_EDIT_FRAME aCaller)

Run a dialog to modify the LIB_ID of symbols for instance when a symbol has moved from a symbol library to another symbol library.

Returns
true if changes are made, false if no change

Definition at line 836 of file dialog_edit_symbols_libid.cpp.

837 {
838  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
839  // frame. Therefore this dialog as a modal frame parent, MUST be run under
840  // quasimodal mode for the quasimodal frame support to work. So don't use
841  // the QUASIMODAL macros here.
842  DIALOG_EDIT_SYMBOLS_LIBID dlg( aCaller );
843 
844  // DO NOT use ShowModal() here, otherwise the library browser will not work properly.
845  dlg.ShowQuasiModal();
846 
847  return dlg.IsSchematicModified();
848 }
Dialog to globally edit the LIB_ID of groups if symbols having the same initial LIB_ID.

References DIALOG_EDIT_SYMBOLS_LIBID::IsSchematicModified(), and DIALOG_SHIM::ShowQuasiModal().

Referenced by SCH_EDITOR_CONTROL::EditSymbolLibraryLinks().

◆ InvokeDialogNetList()

int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

Definition at line 714 of file eeschema/dialogs/dialog_netlist.cpp.

715 {
716  NETLIST_DIALOG dlg( aCaller );
717 
718  SCHEMATIC_SETTINGS& settings = aCaller->Schematic().Settings();
719 
720  wxString curr_default_netformat = settings.m_NetFormatName;
721 
722  int ret = dlg.ShowModal();
723 
724  // Update the default netlist and store it in prj config if it was explicitly changed.
725  settings.m_NetFormatName = dlg.m_DefaultNetFmtName; // can have temporary changed
726 
727  if( curr_default_netformat != dlg.m_DefaultNetFmtName )
728  aCaller->SaveProjectSettings();
729 
730  return ret;
731 }
void SaveProjectSettings() override
Save changes to the project settings to the project (.pro) file.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
SCHEMATIC & Schematic() const
These settings were stored in SCH_BASE_FRAME previously.

References NETLIST_DIALOG::m_DefaultNetFmtName, SCHEMATIC_SETTINGS::m_NetFormatName, SCH_EDIT_FRAME::SaveProjectSettings(), SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_EDITOR_CONTROL::ExportNetlist().

◆ InvokeDialogPrintUsingPrinter()

int InvokeDialogPrintUsingPrinter ( SCH_EDIT_FRAME aCaller)

Create and show DIALOG_PRINT_USING_PRINTER and return whatever DIALOG_PRINT_USING_PRINTER::ShowModal() returns.

Definition at line 513 of file dialog_print_using_printer.cpp.

514 {
515  DIALOG_PRINT_USING_PRINTER dlg( aCaller );
516 
517  return dlg.ShowModal();
518 }

Referenced by SCH_EDITOR_CONTROL::Print().

◆ InvokeDialogRescueEach()

int InvokeDialogRescueEach ( wxWindow *  aParent,
RESCUER aRescuer,
SCH_SHEET_PATH aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE  aGalBackEndType,
bool  aAskShowAgain 
)

This dialog asks the user which rescuable, cached parts he wants to rescue.

Any rejects will be pruned from aCandidates.

Parameters
aParent- the wxWindow object calling this dialog
aRescuer- the active RESCUER instance
aCurrentSheetthe current sheet in the schematic editor frame
aGalBackEndTypethe current GAL type used to render symbols
aAskShowAgain- if true, a "Never Show Again" button will be included

Definition at line 320 of file dialog_rescue_each.cpp.

322 {
323  DIALOG_RESCUE_EACH dlg( aParent, aRescuer, aCurrentSheet, aGalBackEndType, aAskShowAgain );
324  return dlg.ShowQuasiModal();
325 }

References DIALOG_SHIM::ShowQuasiModal().

Referenced by LEGACY_RESCUER::InvokeDialog(), and SYMBOL_LIB_TABLE_RESCUER::InvokeDialog().