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 DIALOG_EXPORT_NETLIST and returns whatever DIALOG_EXPORT_NETLIST::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...
 
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 DIALOG_EXPORT_NETLIST and returns whatever DIALOG_EXPORT_NETLIST::ShowModal() returns.

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

Definition at line 80 of file invoke_sch_dialog.h.

Function Documentation

◆ InvokeDialogCreateBOM()

int InvokeDialogCreateBOM ( SCH_EDIT_FRAME aCaller)

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

Definition at line 110 of file dialog_bom.cpp.

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

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 837 of file dialog_edit_symbols_libid.cpp.

838{
839 // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
840 // frame. Therefore this dialog as a modal frame parent, MUST be run under
841 // quasimodal mode for the quasimodal frame support to work. So don't use
842 // the QUASIMODAL macros here.
843 DIALOG_EDIT_SYMBOLS_LIBID dlg( aCaller );
844
845 // DO NOT use ShowModal() here, otherwise the library browser will not work properly.
846 dlg.ShowQuasiModal();
847
848 return dlg.IsSchematicModified();
849}
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 822 of file dialog_export_netlist.cpp.

823{
824 DIALOG_EXPORT_NETLIST dlg( aCaller );
825
826 int ret = dlg.ShowModal();
827 aCaller->SaveProjectLocalSettings();
828
829 return ret;
830}
void SaveProjectLocalSettings() override
Save changes to the project settings to the project (.pro) file.

References SCH_EDIT_FRAME::SaveProjectLocalSettings().

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 542 of file dialog_print_using_printer.cpp.

543{
544 DIALOG_PRINT_USING_PRINTER dlg( aCaller );
545
546 return dlg.ShowModal();
547}

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 323 of file dialog_rescue_each.cpp.

325{
326 DIALOG_RESCUE_EACH dlg( aParent, aRescuer, aCurrentSheet, aGalBackEndType, aAskShowAgain );
327 return dlg.ShowQuasiModal();
328}

References DIALOG_SHIM::ShowQuasiModal().

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