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

Go to the source code of this file.

Macros

#define NET_PLUGIN_CHANGE   1
 Function InvokeDialogNetList creates and shows NETLIST_DIALOG and returns whatever NETLIST_DIALOG::ShowModal() returns. More...
 

Functions

int InvokeDialogRescueEach (SCH_EDIT_FRAME *aCaller, RESCUER &aRescuer, bool aAskShowAgain)
 Function InvokeDialogRescueEach 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

#define NET_PLUGIN_CHANGE   1

Function InvokeDialogNetList creates 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 91 of file invoke_sch_dialog.h.

Referenced by NETLIST_DIALOG::OnAddPlugin(), SCH_EDIT_FRAME::OnCreateNetlist(), and NETLIST_DIALOG::OnDelPlugin().

Function Documentation

int InvokeDialogCreateBOM ( SCH_EDIT_FRAME aCaller)

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

Definition at line 208 of file dialog_bom.cpp.

Referenced by SCH_EDIT_FRAME::OnCreateBillOfMaterials().

209 {
210  DIALOG_BOM dlg( aCaller );
211  return dlg.ShowModal();
212 }
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 872 of file dialog_edit_components_libid.cpp.

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

Referenced by SCH_EDIT_FRAME::OnEditComponentSymbolsId().

873 {
874  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
875  // frame. Therefore this dialog as a modal frame parent, MUST be run under
876  // quasimodal mode for the quasimodal frame support to work. So don't use
877  // the QUASIMODAL macros here.
878  DIALOG_EDIT_COMPONENTS_LIBID dlg( aCaller );
879  // DO NOT use ShowModal() here, otherwise the library browser will not work
880  // properly.
881  dlg.ShowQuasiModal();
882 
883  return dlg.IsSchematicModified();
884 }
DIALOG_EDIT_COMPONENTS_LIBID is a dialog to globally edit the LIB_ID of groups if components having t...
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.

References DIALOG_ERC::DIALOG_ERC(), and DIALOG_SHIM::Show().

Referenced by SCH_EDIT_FRAME::OnErc().

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
int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

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

Referenced by SCH_EDIT_FRAME::OnCreateNetlist().

884 {
885  NETLIST_DIALOG dlg( aCaller );
886 
887  return dlg.ShowModal();
888 }
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.

Referenced by SCH_EDIT_FRAME::OnPrint().

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.
int InvokeDialogRescueEach ( SCH_EDIT_FRAME aCaller,
RESCUER aRescuer,
bool  aAskShowAgain 
)

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

Any rejects will be pruned from aCandidates.

Parameters
aCaller- the SCH_EDIT_FRAME calling this
aRescuer- the active RESCUER instance
aAskShowAgain- if true, a "Never Show Again" button will be included

Definition at line 301 of file dialog_rescue_each.cpp.

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

302 {
303  DIALOG_RESCUE_EACH dlg( aCaller, aRescuer, aAskShowAgain );
304  return dlg.ShowModal();
305 }
int InvokeDialogUpdateFields ( SCH_EDIT_FRAME aCaller,
const std::list< SCH_COMPONENT * >  aComponents,
bool  aCreateUndoEntry 
)

Update symbol fields.