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

Function Documentation

◆ InvokeDialogBusManager()

void InvokeDialogBusManager ( SCH_EDIT_FRAME aCaller)

Create and show DIALOG_BUS_MANAGER.

Definition at line 507 of file dialog_bus_manager.cpp.

508 {
509  DIALOG_BUS_MANAGER dlg( aCaller );
510  dlg.ShowModal();
511 }

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

108 {
109  DIALOG_BOM dlg( aCaller );
110 
111  // QuasiModal so syntax help works
112  return dlg.ShowQuasiModal();
113 }

References DIALOG_SHIM::ShowQuasiModal().

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

825 {
826  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
827  // frame. Therefore this dialog as a modal frame parent, MUST be run under
828  // quasimodal mode for the quasimodal frame support to work. So don't use
829  // the QUASIMODAL macros here.
830  DIALOG_EDIT_COMPONENTS_LIBID dlg( aCaller );
831  // DO NOT use ShowModal() here, otherwise the library browser will not work
832  // properly.
833  dlg.ShowQuasiModal();
834 
835  return dlg.IsSchematicModified();
836 }
Dialog to globally edit the LIB_ID of groups if components having the same initial LIB_ID.

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

Referenced by SCH_EDITOR_CONTROL::EditSymbolLibraryLinks().

◆ InvokeDialogNetList()

int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

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

719 {
720  NETLIST_DIALOG dlg( aCaller );
721 
722  SCHEMATIC_SETTINGS& settings = aCaller->Schematic().Settings();
723 
724  wxString curr_default_netformat = settings.m_NetFormatName;
725 
726  int ret = dlg.ShowModal();
727 
728  // Update the default netlist and store it in prj config if it was explicitely changed.
729  settings.m_NetFormatName = dlg.m_DefaultNetFmtName; // can have temporary changed
730 
731  if( curr_default_netformat != dlg.m_DefaultNetFmtName )
732  aCaller->SaveProjectSettings();
733 
734  return ret;
735 }
void SaveProjectSettings() override
Save changes to the project settings to the project (.pro) file.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:125
SCHEMATIC & Schematic() const
These settings were stored in SCH_BASE_FRAME previously.

References NETLIST_DIALOG::m_DefaultNetFmtName, SCHEMATIC_SETTINGS::m_NetFormatName, SCH_EDIT_FRAME::SaveProjectSettings(), SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

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

514 {
515  DIALOG_PRINT_USING_PRINTER dlg( aCaller );
516 
517  return dlg.ShowModal();
518 }

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

322 {
323  DIALOG_RESCUE_EACH dlg( aParent, aRescuer, aCurrentSheet, aGalBackEndType, aAskShowAgain );
324  return dlg.ShowQuasiModal();
325 }

References DIALOG_SHIM::ShowQuasiModal().

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