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, SCH_COMPONENT *aSpecificComponent=nullptr, bool aCreateUndoEntry=true)
 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 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 515 of file dialog_bus_manager.cpp.

516 {
517  DIALOG_BUS_MANAGER dlg( aCaller );
518  dlg.ShowModal();
519 }

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

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

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

820 {
821  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
822  // frame. Therefore this dialog as a modal frame parent, MUST be run under
823  // quasimodal mode for the quasimodal frame support to work. So don't use
824  // the QUASIMODAL macros here.
825  DIALOG_EDIT_COMPONENTS_LIBID dlg( aCaller );
826  // DO NOT use ShowModal() here, otherwise the library browser will not work
827  // properly.
828  dlg.ShowQuasiModal();
829 
830  return dlg.IsSchematicModified();
831 }
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().

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

682 {
683  // This is a modeless dialog, so new it rather than instantiating on stack.
684  DIALOG_ERC* dlg = new DIALOG_ERC( aCaller );
685 
686  dlg->Show( true );
687 
688  return dlg; // wxDialog is information hiding about DIALOG_ERC.
689 }
bool Show(bool show) override

References DIALOG_SHIM::Show().

Referenced by EE_INSPECTION_TOOL::RunERC().

◆ InvokeDialogNetList()

int InvokeDialogNetList ( SCH_EDIT_FRAME aCaller)

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

793 {
794  NETLIST_DIALOG dlg( aCaller );
795 
796  SCHEMATIC_SETTINGS& settings = aCaller->Schematic().Settings();
797 
798  wxString curr_default_netformat = settings.m_NetFormatName;
799 
800  int ret = dlg.ShowModal();
801 
802  // Update the default netlist and store it in prj config if it was explicitely changed.
803  settings.m_NetFormatName = dlg.m_DefaultNetFmtName; // can have temporary changed
804 
805  if( curr_default_netformat != dlg.m_DefaultNetFmtName )
806  aCaller->SaveProjectSettings();
807 
808  return ret;
809 }
void SaveProjectSettings() override
Save changes to the project settings to the project (.pro) file.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:138
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 536 of file dialog_print_using_printer.cpp.

537 {
538  DIALOG_PRINT_USING_PRINTER dlg( aCaller );
539 
540  return dlg.ShowModal();
541 }

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

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

References DIALOG_SHIM::ShowQuasiModal().

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

◆ InvokeDialogUpdateFields()

int InvokeDialogUpdateFields ( SCH_EDIT_FRAME aCaller,
SCH_COMPONENT aSpecificComponent = nullptr,
bool  aCreateUndoEntry = true 
)

Update symbol fields.

Definition at line 36 of file dialog_update_fields.cpp.

38 {
39  DIALOG_UPDATE_FIELDS dlg( aCaller, aSpecificComponent, aCreateUndoEntry );
40  return dlg.ShowQuasiModal();
41 }
Dialog to update component fields (i.e.

References DIALOG_SHIM::ShowQuasiModal().

Referenced by SCH_EDIT_TOOL::UpdateFields(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().