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...
 
wxDialog * InvokeDialogERC (SCH_EDIT_FRAME *aCaller)
 Create the modeless DIALOG_ERC and show it, return something to destroy or close it. 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 InvokeDialogUpdateFields (SCH_EDIT_FRAME *aCaller, const std::list< SCH_COMPONENT * > aComponents, bool aCreateUndoEntry)
 Update symbol fields. More...
 
int InvokeDialogNetList (SCH_EDIT_FRAME *aCaller)
 
bool InvokeDialogEditComponentsLibId (SCH_EDIT_FRAME *aCaller)
 Run a dialog to modify the LIB_ID of components 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 95 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 215 of file dialog_bom.cpp.

216 {
217  DIALOG_BOM dlg( aCaller );
218  return dlg.ShowModal();
219 }

Referenced by SCH_EDIT_FRAME::OnCreateBillOfMaterials().

◆ InvokeDialogEditComponentsLibId()

bool InvokeDialogEditComponentsLibId ( SCH_EDIT_FRAME aCaller)

Run a dialog to modify the LIB_ID of components 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 887 of file dialog_edit_components_libid.cpp.

888 {
889  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
890  // frame. Therefore this dialog as a modal frame parent, MUST be run under
891  // quasimodal mode for the quasimodal frame support to work. So don't use
892  // the QUASIMODAL macros here.
893  DIALOG_EDIT_COMPONENTS_LIBID dlg( aCaller );
894  // DO NOT use ShowModal() here, otherwise the library browser will not work
895  // properly.
896  dlg.ShowQuasiModal();
897 
898  return dlg.IsSchematicModified();
899 }
DIALOG_EDIT_COMPONENTS_LIBID is a dialog to globally edit the LIB_ID of groups if components having t...

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

Referenced by SCH_EDIT_FRAME::OnEditComponentSymbolsId().

◆ InvokeDialogERC()

wxDialog* InvokeDialogERC ( SCH_EDIT_FRAME aCaller)

Create the modeless DIALOG_ERC and show it, return something to destroy or close it.

The dialog will have ID_DIALOG_ERC from id.h

Definition at line 673 of file dialog_erc.cpp.

674 {
675  // This is a modeless dialog, so new it rather than instantiating on stack.
676  DIALOG_ERC* dlg = new DIALOG_ERC( aCaller );
677 
678  dlg->Show( true );
679 
680  return dlg; // wxDialog is information hiding about DIALOG_ERC.
681 }
bool Show(bool show) override

References DIALOG_SHIM::Show().

Referenced by SCH_EDIT_FRAME::OnErc().

◆ InvokeDialogNetList()

int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

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

859 {
860  NETLIST_DIALOG dlg( aCaller );
861 
862  return dlg.ShowModal();
863 }

Referenced by SCH_EDIT_FRAME::OnCreateNetlist().

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

459 {
460  DIALOG_PRINT_USING_PRINTER dlg( aCaller );
461 
462  return dlg.ShowModal();
463 }
Class DIALOG_PRINT_USING_PRINTER offers to print a schematic dialog.

Referenced by SCH_EDIT_FRAME::OnPrint().

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

313 {
314  DIALOG_RESCUE_EACH dlg( aParent, aRescuer, aCurrentSheet, aGalBackEndType, aAskShowAgain );
315  return dlg.ShowQuasiModal();
316 }

References DIALOG_SHIM::ShowQuasiModal().

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

◆ InvokeDialogUpdateFields()

int InvokeDialogUpdateFields ( SCH_EDIT_FRAME aCaller,
const std::list< SCH_COMPONENT * >  aComponents,
bool  aCreateUndoEntry 
)

Update symbol fields.