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...
 
int InvokeDialogAnnotate (SCH_EDIT_FRAME *aCaller, wxString message="")
 Create and show DIALOG_ANNOTATE and return whatever DIALOG_ANNOTATE::ShowModal() returns. 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...
 
void InvokeDialogCreateBOMEditor (SCH_EDIT_FRAME *aCaller)
 Create and show DIALOG_BOM_EDITOR. 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 an other 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 98 of file invoke_sch_dialog.h.

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

Function Documentation

int InvokeDialogAnnotate ( SCH_EDIT_FRAME aCaller,
wxString  message = "" 
)

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

Definition at line 313 of file dialog_annotate.cpp.

Referenced by SCH_EDIT_FRAME::OnAnnotate(), and SCH_EDIT_FRAME::prepareForNetlist().

314 {
315  DIALOG_ANNOTATE dlg( aCaller, message );
316 
317  return dlg.ShowModal();
318 }
Class DIALOG_ANNOTATE: a dialog to set/clear reference designators, of a schematic hierarchy...
int InvokeDialogCreateBOM ( SCH_EDIT_FRAME aCaller)

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

Definition at line 223 of file dialog_bom.cpp.

Referenced by SCH_EDIT_FRAME::OnCreateBillOfMaterials().

224 {
225  DIALOG_BOM dlg( aCaller );
226  return dlg.ShowModal();
227 }
void InvokeDialogCreateBOMEditor ( SCH_EDIT_FRAME aCaller)

Create and show DIALOG_BOM_EDITOR.

Definition at line 44 of file dialog_bom_editor.cpp.

References DIALOG_SHIM::ShowQuasiModal().

Referenced by SCH_EDIT_FRAME::OnLaunchBomManager().

45 {
46  DIALOG_BOM_EDITOR dlg( aCaller );
47  dlg.ShowQuasiModal();
48 }
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 an other symbol library.

Returns
true if changes are made, false if no change

Definition at line 428 of file dialog_edit_components_libid.cpp.

References DIALOG_EDIT_COMPONENTS_LIBID::IsSchelaticModified().

Referenced by SCH_EDIT_FRAME::OnEditComponentSymbolsId().

429 {
430  DIALOG_EDIT_COMPONENTS_LIBID dlg( aCaller );
431  dlg.ShowModal();
432 
433  return dlg.IsSchelaticModified();
434 }
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 613 of file dialog_erc.cpp.

References DIALOG_SHIM::Show().

Referenced by SCH_EDIT_FRAME::OnErc().

614 {
615  // This is a modeless dialog, so new it rather than instantiating on stack.
616  DIALOG_ERC* dlg = new DIALOG_ERC( aCaller );
617 
618  dlg->Show( true );
619 
620  return dlg; // wxDialog is information hiding about DIALOG_ERC.
621 }
bool Show(bool show) override
int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

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

Referenced by SCH_EDIT_FRAME::OnCreateNetlist().

876 {
877  NETLIST_DIALOG dlg( aCaller );
878 
879  return dlg.ShowModal();
880 }
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 478 of file eeschema/dialogs/dialog_print_using_printer.cpp.

Referenced by SCH_EDIT_FRAME::OnPrint().

479 {
480  DIALOG_PRINT_USING_PRINTER dlg( aCaller );
481 
482  return dlg.ShowModal();
483 }
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 316 of file dialog_rescue_each.cpp.

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

317 {
318  DIALOG_RESCUE_EACH dlg( aCaller, aRescuer, aAskShowAgain );
319  return dlg.ShowModal();
320 }
int InvokeDialogUpdateFields ( SCH_EDIT_FRAME aCaller,
const std::list< SCH_COMPONENT * >  aComponents,
bool  aCreateUndoEntry 
)

Update symbol fields.