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...
 
void InvokeDialogBusManager (SCH_EDIT_FRAME *aCaller)
 Create and show DIALOG_BUS_MANAGER. 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...
 
int InvokeDialogLabelEditor (SCH_EDIT_FRAME *aCaller, SCH_TEXT *aText)
 Launches the "Edit Text/Label" dialog. 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 99 of file invoke_sch_dialog.h.

Function Documentation

◆ InvokeDialogBusManager()

void InvokeDialogBusManager ( SCH_EDIT_FRAME aCaller)

Create and show DIALOG_BUS_MANAGER.

Definition at line 513 of file dialog_bus_manager.cpp.

514 {
515  DIALOG_BUS_MANAGER dlg( aCaller );
516  dlg.ShowModal();
517 }

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 216 of file dialog_bom.cpp.

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

Referenced by SCH_EDITOR_CONTROL::GenerateBOM().

◆ 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 885 of file dialog_edit_components_libid.cpp.

886 {
887  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
888  // frame. Therefore this dialog as a modal frame parent, MUST be run under
889  // quasimodal mode for the quasimodal frame support to work. So don't use
890  // the QUASIMODAL macros here.
891  DIALOG_EDIT_COMPONENTS_LIBID dlg( aCaller );
892  // DO NOT use ShowModal() here, otherwise the library browser will not work
893  // properly.
894  dlg.ShowQuasiModal();
895 
896  return dlg.IsSchematicModified();
897 }
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_EDITOR_CONTROL::EditSymbolLibraryLinks().

◆ 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 654 of file dialog_erc.cpp.

655 {
656  // This is a modeless dialog, so new it rather than instantiating on stack.
657  DIALOG_ERC* dlg = new DIALOG_ERC( aCaller );
658 
659  dlg->Show( true );
660 
661  return dlg; // wxDialog is information hiding about DIALOG_ERC.
662 }
bool Show(bool show) override

References DIALOG_SHIM::Show().

Referenced by EE_INSPECTION_TOOL::RunERC().

◆ InvokeDialogLabelEditor()

int InvokeDialogLabelEditor ( SCH_EDIT_FRAME aCaller,
SCH_TEXT aText 
)

Launches the "Edit Text/Label" dialog.

Returns
the ShowModal() result (wxID_OK, wxID_CANCEL, etc.)

Definition at line 87 of file dialog_edit_label.cpp.

88 {
89  DIALOG_LABEL_EDITOR dialog( aCaller, aTextItem );
90 
91  return dialog.ShowModal();
92 }

Referenced by SCH_EDIT_FRAME::CreateNewText(), and SCH_EDIT_TOOL::Properties().

◆ InvokeDialogNetList()

int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

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

752 {
753  NETLIST_DIALOG dlg( aCaller );
754 
755  wxString curr_default_netformat = aCaller->GetNetListFormatName();
756 
757  int ret = dlg.ShowModal();
758 
759  // Update the default netlist and store it in prj config if it was explicitely changed.
760  aCaller->SetNetListFormatName( dlg.m_DefaultNetFmtName ); // can have temporary changed
761 
762  if( curr_default_netformat != dlg.m_DefaultNetFmtName )
763  aCaller->SaveProjectSettings( false );
764 
765  return ret;
766 }
const wxString & GetNetListFormatName() const
void SaveProjectSettings(bool aAskForSave) override
Save changes to the project settings to the project (.pro) file.
void SetNetListFormatName(const wxString &aFormat)

References SCH_EDIT_FRAME::GetNetListFormatName(), NETLIST_DIALOG::m_DefaultNetFmtName, SCH_EDIT_FRAME::SaveProjectSettings(), and SCH_EDIT_FRAME::SetNetListFormatName().

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

447 {
448  DIALOG_PRINT_USING_PRINTER dlg( aCaller );
449 
450  return dlg.ShowModal();
451 }

Referenced by SCH_EDIT_FRAME::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 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.