KiCad PCB EDA Suite
Loading...
Searching...
No Matches
confirm.h File Reference

This file is part of the common library. More...

#include <kicommon.h>
#include <wx/richmsgdlg.h>
#include <vector>
#include <functional>

Go to the source code of this file.

Classes

class  KIDIALOG
 Helper class to create more flexible dialogs, including 'do not show again' checkbox handling. More...
 

Functions

KICOMMON_API bool AskOverrideLock (wxWindow *aParent, const wxString &aMessage)
 Display a dialog indicating the file is already open, with an option to reset the lock. More...
 
KICOMMON_API bool HandleUnsavedChanges (wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
 Display a dialog with Save, Cancel and Discard Changes buttons. More...
 
KICOMMON_API int UnsavedChangesDialog (wxWindow *aParent, const wxString &aMessage, bool *aApplyToAll)
 A specialized version of HandleUnsavedChanges which handles an apply-to-all checkbox. More...
 
KICOMMON_API int UnsavedChangesDialog (wxWindow *aParent, const wxString &aMessage)
 
KICOMMON_API bool ConfirmRevertDialog (wxWindow *parent, const wxString &aMessage)
 Display a confirmation dialog for a revert action. More...
 
KICOMMON_API void DisplayError (wxWindow *aParent, const wxString &aText, int aDisplayTime=0)
 Display an error or warning message box with aMessage. More...
 
KICOMMON_API void DisplayErrorMessage (wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo=wxEmptyString)
 Display an error message with aMessage. More...
 
KICOMMON_API void DisplayInfoMessage (wxWindow *parent, const wxString &aMessage, const wxString &aExtraInfo=wxEmptyString)
 Display an informational message box with aMessage. More...
 
KICOMMON_API bool IsOK (wxWindow *aParent, const wxString &aMessage)
 Display a yes/no dialog with aMessage and returns the user response. More...
 
KICOMMON_API int OKOrCancelDialog (wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage=wxEmptyString, const wxString &aOKLabel=wxEmptyString, const wxString &aCancelLabel=wxEmptyString, bool *aApplyToAll=nullptr)
 Display a warning dialog with aMessage and returns the user response. More...
 
KICOMMON_API int SelectSingleOption (wxWindow *aParent, const wxString &aTitle, const wxString &aMessage, const wxArrayString &aOptions)
 Display a dialog with radioboxes asking the user to select an option. More...
 

Detailed Description

This file is part of the common library.

See also
common.h

Definition in file confirm.h.

Function Documentation

◆ AskOverrideLock()

KICOMMON_API bool AskOverrideLock ( wxWindow *  aParent,
const wxString &  aMessage 
)

Display a dialog indicating the file is already open, with an option to reset the lock.

Returns
true if the lock was reset.

Definition at line 155 of file confirm.cpp.

References _.

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ ConfirmRevertDialog()

KICOMMON_API bool ConfirmRevertDialog ( wxWindow *  parent,
const wxString &  aMessage 
)

Display a confirmation dialog for a revert action.

Definition at line 229 of file confirm.cpp.

References _.

Referenced by SYMBOL_EDIT_FRAME::Revert(), and FOOTPRINT_EDIT_FRAME::RevertFootprint().

◆ DisplayError()

KICOMMON_API void DisplayError ( wxWindow *  aParent,
const wxString &  aText,
int  aDisplayTime = 0 
)

Display an error or warning message box with aMessage.

Warning
Setting displaytime does not work. Do not use it.

Definition at line 280 of file confirm.cpp.

References _.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), PCB_CONTROL::AppendBoard(), SYMBOL_EDIT_FRAME::backupFile(), SCH_EDIT_FRAME::CheckSheetForRecursion(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), MICROWAVE_TOOL::createFootprint(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), SIMULATOR::CreateInstance(), PCB_BASE_EDIT_FRAME::createNewLibrary(), SYMBOL_EDIT_FRAME::DdAddLibrary(), UNIT_BINDER::delayedFocusHandler(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), PANEL_SETUP_LAYERS::DenyChangeCheckBox(), DIALOG_SIM_COMMAND::evaluateDCControls(), ExecuteFile(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), GBR_TO_PCB_EXPORTER::ExportPcb(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), PCB_EDIT_FRAME::ExportToGenCAD(), SCH_EDIT_FRAME::FlipBodyStyle(), DIALOG_GENDRILL::GenDrillAndMapFiles(), PCB_EDIT_FRAME::GenFootprintsReport(), PCB_EDIT_FRAME::GenIPC2581File(), GetAssociatedDocument(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SCH_EDITOR_CONTROL::ImportFPAssignments(), SYMBOL_EDIT_FRAME::ImportSymbol(), DIALOG_PRINT_GENERIC::initPrintData(), SYMBOL_EDIT_FRAME::LoadSymbol(), SCH_EDIT_FRAME::NewProject(), DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_CONFIG_EQUFILES::OnAddFiles(), DIALOG_BOM::OnAddGenerator(), PANEL_GRID_SETTINGS::OnAddGrid(), DIALOG_NET_INSPECTOR::onAddNet(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), DIALOG_FOOTPRINT_PROPERTIES::OnDeleteField(), DIALOG_LABEL_PROPERTIES::OnDeleteField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteField(), DIALOG_SHEET_PROPERTIES::OnDeleteField(), DIALOG_SYMBOL_PROPERTIES::OnDeleteField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnDeleteField(), PANEL_FP_EDITOR_DEFAULTS::OnDeleteTextItem(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PROJECT_TREE_PANE::onGitSwitchBranch(), DIALOG_LIB_SYMBOL_PROPERTIES::OnGridCellChanging(), DIALOG_SYMBOL_PROPERTIES::OnGridCellChanging(), SCH_EDIT_FRAME::OnOpenCvpcb(), DIALOG_PRINT_GENERIC::onPrintButtonClick(), DIALOG_PRINT_GENERIC::onPrintPreview(), PANEL_GRID_SETTINGS::OnRemoveGrid(), DIALOG_SYMBOL_FIELDS_TABLE::OnRenameField(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_BOM::OnRunGenerator(), PNS_LOG_VIEWER_FRAME::onSaveAs(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), PCB_DRAW_PANEL_GAL::OnShow(), SCH_EDIT_FRAME::OnUpdatePCB(), DIALOG_FOOTPRINT_PROPERTIES::OnUpdateUI(), DIALOG_LIB_SYMBOL_PROPERTIES::OnUpdateUI(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnUpdateUI(), OpenPDF(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), DIALOG_PLOT::Plot(), PCB_CONTROL::pruneItemLayers(), MWAVE_POLYGONAL_SHAPE_DLG::ReadDataShapeDescr(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), KIGFX::VERTEX_MANAGER::Reserve(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), ROUTER_TOOL::saveRouterDebugLog(), SCH_EDIT_FRAME::saveSchematicFile(), PROJECT_SCH::SchLibs(), KIGFX::GPU_MANAGER::SetShader(), EDA_DRAW_PANEL_GAL::SwitchBackend(), PCB_EDIT_FRAME::TestStandalone(), NETLIST_EXPORTER_ALLEGRO::toAllegroPackages(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_FIELD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_IMPORT_SETTINGS::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SIM_COMMAND::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_IMPORT_SETTINGS::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow(), SPICE_VALIDATOR::Validate(), REGEX_VALIDATOR::Validate(), KIGFX::VERTEX_MANAGER::Vertex(), KIGFX::VERTEX_MANAGER::Vertices(), and LEGACY_RESCUER::WriteRescueLibrary().

◆ DisplayErrorMessage()

KICOMMON_API void DisplayErrorMessage ( wxWindow *  aParent,
const wxString &  aMessage,
const wxString &  aExtraInfo = wxEmptyString 
)

Display an error message with aMessage.

Parameters
aParentis the parent window
aMessageis the message text to display
aExtraInfois extra data that can be optionally displayed in a collapsible pane

Definition at line 305 of file confirm.cpp.

References _.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FILENAME_RESOLVER::addPath(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SIMULATOR_FRAME_UI::AddTuner(), PANEL_SETUP_LAYERS::addUserDefinedLayer(), SIMULATOR_FRAME_UI::applyTuners(), CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_MAINFRAME::AssociateFootprint(), checkGlError(), SCH_EDIT_FRAME::CreateArchiveLibrary(), CONVERT_TOOL::CreatePolys(), PROJECT_TREE_ITEM::Delete(), EDA_DRAW_PANEL_GAL::DoRePaint(), SIMULATOR_FRAME::EditAnalysis(), WIDGET_HOTKEY_LIST::editItem(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_EDIT_FRAME::ExportSpecctraFile(), SYMBOL_EDIT_FRAME::ExportSymbol(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), PL_EDITOR_FRAME::Files_io(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), EDA_BASE_FRAME::GetFileFromHistory(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), SCH_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), PCB_EDIT_FRAME::ImportSpecctraSession(), SYMBOL_EDIT_FRAME::ImportSymbol(), PGM_BASE::InitPgm(), EDA_BASE_FRAME::IsWritable(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SCH::IFACE::loadGlobalLibTable(), PCB::IFACE::loadGlobalLibTable(), DIALOG_SIM_MODEL< T_symbol, T_field >::loadLibrary(), SCH_EDIT_FRAME::LoadSheetFromFile(), SIMULATOR_FRAME::LoadSimulator(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), mergeZones(), SETTINGS_MANAGER::MigrateIfNeeded(), SIMULATOR_CONTROL::NewAnalysisTab(), KICAD_MANAGER_CONTROL::NewFromRepository(), KICAD_MANAGER_CONTROL::NewFromTemplate(), KICAD_MANAGER_CONTROL::newProjectDirectory(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), DIALOG_EXPORT_STEP::onExportButton(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), DIALOG_GIT_REPOSITORY::OnFileUpdated(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPushProject(), PROJECT_TREE_PANE::onGitRemoveVCS(), CV::IFACE::OnKifaceStart(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), DIALOG_GIT_REPOSITORY::OnOKClick(), PANEL_SETUP_NETCLASSES::OnRemoveNetclassClick(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SIMULATOR_FRAME::onUpdateSim(), PANEL_SETUP_BUSES::OnUpdateUI(), DIALOG_CONFIGURE_PATHS::OnUpdateUI(), PANEL_TEXT_VARIABLES::OnUpdateUI(), DIALOG_SIM_MODEL< T_symbol, T_field >::onWaveformChoice(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT::PcbFootprintLibs(), PROJECT_PCB::PcbFootprintLibs(), EDA_DRAW_FRAME::PrintPage(), NETLIST_EXPORTER_SPICE::readModel(), PCB_EDIT_FRAME::ReadNetlistFromFile(), SIMULATOR_FRAME::ReloadSimulator(), PCB_EDIT_FRAME::RunEeschema(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), SYMBOL_EDIT_FRAME::saveLibrary(), KICAD_MANAGER_CONTROL::SaveProjectAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), SchGetLibSymbol(), PROJECT_SCH::SchSymbolLibTable(), KIWAY::SetLanguage(), SCH_EDITOR_CONTROL::SimProbe(), SIMULATOR_FRAME::StartSimulation(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::TransferDataFromWindow(), DIALOG_SIM_MODEL< T_symbol, T_field >::TransferDataToWindow(), SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), SIMULATOR_FRAME_UI::UpdateTunerValue(), DIALOG_SHEET_PROPERTIES::Validate(), DIALOG_SYMBOL_PROPERTIES::Validate(), IPC356D_WRITER::Write(), NETLIST_EXPORTER_SPICE::writeInclude(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ DisplayInfoMessage()

KICOMMON_API void DisplayInfoMessage ( wxWindow *  parent,
const wxString &  aMessage,
const wxString &  aExtraInfo = wxEmptyString 
)

Display an informational message box with aMessage.

Parameters
aParentis the parent window
aMessageis the message text to display
aExtraInfois the extra data that can be optionally displayed in a collapsible pane

Definition at line 332 of file confirm.cpp.

References _.

Referenced by SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds(), EE_INSPECTION_TOOL::CheckSymbol(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), EDA_DRAW_PANEL_GAL::DoRePaint(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PRINT_GENERIC::getScaleValue(), PGM_BASE::GetTextEditor(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), PROJECT_TREE_PANE::onGitInitializeProject(), CV::IFACE::OnKifaceStart(), SCH_DRAW_PANEL::OnShow(), SCH_EDIT_FRAME::OpenProjectFiles(), DIALOG_PLOT::Plot(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), SCH_EDITOR_CONTROL::RepairSchematic(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), PCB_EDIT_FRAME::SavePcbCopy(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::setFPWatcher(), SCH_BASE_FRAME::setSymWatcher(), KICAD_MANAGER_CONTROL::ShowPlayer(), EDA_DRAW_PANEL_GAL::SwitchBackend(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ HandleUnsavedChanges()

KICOMMON_API bool HandleUnsavedChanges ( wxWindow *  aParent,
const wxString &  aMessage,
const std::function< bool()> &  aSaveFunction 
)

Display a dialog with Save, Cancel and Discard Changes buttons.

Parameters
aParent= the parent window
aMessage= the main message to put in dialog
aSaveFunction= a function to save changes, if requested. Must return true if the save was successful and false otherwise (which will result in HandleUnsavedChanges() returning wxID_CANCEL).
Returns
wxID_YES, wxID_CANCEL, wxID_NO.

Definition at line 240 of file confirm.cpp.

References UnsavedChangesDialog().

Referenced by SCH_EDIT_FRAME::AskToSaveChanges(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), CVPCB_MAINFRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), PL_EDITOR_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), PL_EDITOR_FRAME::Files_io(), PCB_EDIT_FRAME::Files_io_from_id(), SYMBOL_EDIT_FRAME::LoadSymbol(), DIALOG_SYMBOL_FIELDS_TABLE::OnClose(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), PL_EDITOR_FRAME::OnFileHistory(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsOK()

KICOMMON_API bool IsOK ( wxWindow *  aParent,
const wxString &  aMessage 
)

Display a yes/no dialog with aMessage and returns the user response.

Parameters
aParentis the parent window. NULL can be used if the parent is the top level window.
aMessageis the message to display in the dialog box.
Returns
True if user selected the yes button, otherwise false.

Definition at line 360 of file confirm.cpp.

References _.

Referenced by PANEL_SETUP_NETCLASSES::checkReload(), PANEL_SETUP_SEVERITIES::checkReload(), PANEL_TEXT_VARIABLES::checkReload(), PANEL_IMAGE_EDITOR::CheckValues(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_FRAME::Clear_DrawLayers(), PCB_EDIT_FRAME::Clear_Pcb(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), PCB_EDIT_FRAME::Files_io_from_id(), KICAD_MANAGER_CONTROL::newProjectDirectory(), SCH_EDIT_FRAME::OnAppendProject(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged(), DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged(), PANEL_SETUP_RULES::onCharHook(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), DIALOG_NET_INSPECTOR::onDeleteNet(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PROJECT_TREE_PANE::onGitRemoveVCS(), SCH_EDIT_FRAME::OnImportProject(), APPEARANCE_CONTROLS_3D::onLayerPresetChanged(), APPEARANCE_CONTROLS::onLayerPresetChanged(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_BASE_FRAME::OnSymChangeDebounceTimer(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), CVPCB_MAINFRAME::readNetListAndFpFiles(), SCH_EDIT_FRAME::ReadyToNetlist(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), SCH_EDITOR_CONTROL::Revert(), SIMULATOR_FRAME::StartSimulation(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ OKOrCancelDialog()

KICOMMON_API int OKOrCancelDialog ( wxWindow *  aParent,
const wxString &  aWarning,
const wxString &  aMessage,
const wxString &  aDetailedMessage = wxEmptyString,
const wxString &  aOKLabel = wxEmptyString,
const wxString &  aCancelLabel = wxEmptyString,
bool *  aApplyToAll = nullptr 
)

Display a warning dialog with aMessage and returns the user response.

Parameters
aParentis the parent window. NULL can be used if the parent is the top level window.
aWarningis the warning to display in the top part of the dialog box using a bold font.
aMessageis the message to display in the lower part of the dialog box using the default system UI font.
aDetailedMessageis the message to display in the "Show detailed information" section. Passing wxEmptyString will hide this portion of the dialog.
aOKLabelis the text to display in the OK button.
aCancelLabelis the text to display in the cancel button.
Returns
wxID_OK or wxID_CANCEL depending on the button the user selected.

Definition at line 253 of file confirm.cpp.

References _.

Referenced by PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveAllLibraries(), and SYMBOL_EDIT_FRAME::saveCurrentSymbol().

◆ SelectSingleOption()

KICOMMON_API int SelectSingleOption ( wxWindow *  aParent,
const wxString &  aTitle,
const wxString &  aMessage,
const wxArrayString &  aOptions 
)

Display a dialog with radioboxes asking the user to select an option.

Parameters
aParentis the parent window.
aTitleis the dialog title.
aMessageis a text label displayed in the first row of the dialog.
aOptionsis a vector of possible options.
Returns
Index of the selected option or -1 when the dialog has been canceled.

Definition at line 389 of file confirm.cpp.

◆ UnsavedChangesDialog() [1/2]

KICOMMON_API int UnsavedChangesDialog ( wxWindow *  aParent,
const wxString &  aMessage 
)

Definition at line 203 of file confirm.cpp.

References _, and UnsavedChangesDialog().

◆ UnsavedChangesDialog() [2/2]

KICOMMON_API int UnsavedChangesDialog ( wxWindow *  aParent,
const wxString &  aMessage,
bool *  aApplyToAll 
)

A specialized version of HandleUnsavedChanges which handles an apply-to-all checkbox.

Parameters
aParent= the parent window
aMessage= the main message to put in dialog
aApplyToAll= if non-null an "Apply to all" checkbox will be shown and it's value written back to the bool.
Returns
wxID_YES, wxID_CANCEL, wxID_NO.

Definition at line 177 of file confirm.cpp.

References _.

Referenced by SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), HandleUnsavedChanges(), InvokeSchEditSymbolLibTable(), SYMBOL_EDIT_FRAME::saveAllLibraries(), and UnsavedChangesDialog().