Inheritance diagram for NETLIST_DIALOG:

Public Types
enum	HOLDER_TYPE { DIALOG, FRAME, PANEL }

Public Member Functions
	NETLIST_DIALOG (SCH_EDIT_FRAME *parent)

	~NETLIST_DIALOG ()

void	SetInitialFocus (wxWindow *aWindow)
	Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...

int	ShowQuasiModal ()

void	EndQuasiModal (int retCode)

bool	IsQuasiModal () const

bool	Show (bool show) override

bool	Enable (bool enable) override

void	OnPaint (wxPaintEvent &event)

void	SetPosition (const wxPoint &aNewPosition)
	Force the position of the dialog to a new position. More...

EDA_UNITS	GetUserUnits () const

HOLDER_TYPE	GetType () const

KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...

PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

Static Public Member Functions
static bool	IsCtrl (int aChar, const wxKeyEvent &e)

static bool	IsShiftCtrl (int aChar, const wxKeyEvent &e)

Public Attributes
SCH_EDIT_FRAME *	m_Parent

wxString	m_DefaultNetFmtName

NETLIST_PAGE_DIALOG *	m_PanelNetType [4+CUSTOMPANEL_COUNTMAX]

Protected Types
enum	{ ID_CHANGE_NOTEBOOK_PAGE = 1000, ID_ADD_PLUGIN, ID_DEL_PLUGIN }

Protected Member Functions
void	finishDialogSettings ()
	In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...

void	setSizeInDU (int x, int y)
	Set the dialog to the given dimensions in "dialog units". More...

int	horizPixelsFromDU (int x) const
	Convert an integer number of dialog units to pixels, horizontally. More...

int	vertPixelsFromDU (int y) const
	Convert an integer number of dialog units to pixels, vertically. More...

void	resetSize ()
	Clear the existing dialog size and position. More...

virtual void	OnCharHook (wxKeyEvent &aEvt)

Protected Attributes
wxNotebook *	m_NoteBook

wxBoxSizer *	m_buttonSizer

wxButton *	m_buttonAddGenerator

wxButton *	m_buttonDelGenerator

wxStdDialogButtonSizer *	m_sdbSizer2

wxButton *	m_sdbSizer2OK

wxButton *	m_sdbSizer2Cancel

EDA_UNITS	m_units

std::string	m_hash_key

bool	m_useCalculatedSize

bool	m_firstPaintEvent

wxWindow *	m_initialFocusTarget

WX_EVENT_LOOP *	m_qmodal_loop

bool	m_qmodal_showing

WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler

EDA_BASE_FRAME *	m_parentFrame

std::vector< wxWindow * >	m_tabOrder

Private Member Functions
void	InstallCustomPages ()

NETLIST_PAGE_DIALOG *	AddOneCustomPage (const wxString &aTitle, const wxString &aCommandString, NETLIST_TYPE_ID aNetTypeId)

void	InstallPageSpice ()

bool	TransferDataFromWindow () override

void	NetlistUpdateOpt ()

void	OnNetlistTypeSelection (wxNotebookEvent &event) override

void	OnAddGenerator (wxCommandEvent &event) override
	Add a new panel for a new netlist plugin. More...

void	OnDelGenerator (wxCommandEvent &event) override
	Remove a panel relative to a netlist plugin. More...

void	OnRunExternSpiceCommand (wxCommandEvent &event)
	Run the external spice simulator command. More...

void	OnRunSpiceButtUI (wxUpdateUIEvent &event)
	Enable (if the command line is not empty or disable the button to run spice command. More...

void	WriteCurrentNetlistSetup ()
	Write the current netlist options setup in the configuration. More...

bool	FilenamePrms (NETLIST_TYPE_ID aType, wxString aExt, wxString aWildCard)
	Return the filename extension and the wildcard string for this page or a void name if there is no default name. More...

Friends
class	NETLIST_PAGE_DIALOG

Detailed Description

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator
ID_CHANGE_NOTEBOOK_PAGE
ID_ADD_PLUGIN
ID_DEL_PLUGIN

Definition at line 44 of file eeschema/dialogs/dialog_netlist_base.h.

         {
             ID_CHANGE_NOTEBOOK_PAGE = 1000,
             ID_ADD_PLUGIN,
             ID_DEL_PLUGIN
         };

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 42 of file kiway_holder.h.

42 { DIALOG, FRAME, PANEL };

KIWAY_HOLDER::DIALOG

Definition: kiway_holder.h:42

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:42

KIWAY_HOLDER::FRAME

Definition: kiway_holder.h:42

Constructor & Destructor Documentation

◆ NETLIST_DIALOG()

NETLIST_DIALOG::NETLIST_DIALOG ( SCH_EDIT_FRAME * parent )

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

                                                        :
     NETLIST_DIALOG_BASE( parent )
 {
     m_Parent = parent;
 
     SCHEMATIC_SETTINGS& settings = m_Parent->Schematic().Settings();
 
     m_DefaultNetFmtName = settings.m_NetFormatName;
 
     for( NETLIST_PAGE_DIALOG*& page : m_PanelNetType)
         page = NULL;
 
     // Add notebook pages:
     m_PanelNetType[PANELPCBNEW] = new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "KiCad" ),
                                                            NET_TYPE_PCBNEW );
 
     m_PanelNetType[PANELORCADPCB2] = new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "OrcadPCB2" ),
                                                               NET_TYPE_ORCADPCB2 );
 
     m_PanelNetType[PANELCADSTAR] = new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "CadStar" ),
                                                             NET_TYPE_CADSTAR );
 
     InstallPageSpice();
     InstallCustomPages();
 
     // We use a sdbSizer here to get the order right, which is platform-dependent
     m_sdbSizer2OK->SetLabel( _( "Export Netlist" ) );
     m_sdbSizer2Cancel->SetLabel( _( "Close" ) );
     m_buttonSizer->Layout();
 
     m_sdbSizer2OK->SetDefault();
 
     // Now all widgets have the size fixed, call FinishDialogSettings
     finishDialogSettings();
 }

References _, DIALOG_SHIM::finishDialogSettings(), InstallCustomPages(), InstallPageSpice(), NETLIST_DIALOG_BASE::m_buttonSizer, m_DefaultNetFmtName, SCHEMATIC_SETTINGS::m_NetFormatName, NETLIST_DIALOG_BASE::m_NoteBook, m_PanelNetType, m_Parent, NETLIST_DIALOG_BASE::m_sdbSizer2Cancel, NETLIST_DIALOG_BASE::m_sdbSizer2OK, NET_TYPE_CADSTAR, NET_TYPE_ORCADPCB2, NET_TYPE_PCBNEW, NETLIST_PAGE_DIALOG, NULL, PANELCADSTAR, PANELORCADPCB2, PANELPCBNEW, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

◆ ~NETLIST_DIALOG()

NETLIST_DIALOG::~NETLIST_DIALOG ( )

inline

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

111 { };

Member Function Documentation

◆ AddOneCustomPage()

NETLIST_PAGE_DIALOG * NETLIST_DIALOG::AddOneCustomPage	(	const wxString &	aTitle,
		const wxString &	aCommandString,
		NETLIST_TYPE_ID	aNetTypeId
	)

private

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

 {
     NETLIST_PAGE_DIALOG* currPage = new NETLIST_PAGE_DIALOG( m_NoteBook, aTitle, aNetTypeId );
 
     currPage->m_LowBoxSizer->Add( new wxStaticText( currPage, -1, _( "Title:" ) ), 0,
                                   wxGROW | wxLEFT | wxRIGHT | wxTOP, 5 );
 
     currPage->m_TitleStringCtrl = new wxTextCtrl( currPage, -1, aTitle,
                                                   wxDefaultPosition, wxDefaultSize );
 
     currPage->m_TitleStringCtrl->SetInsertionPoint( 1 );
     currPage->m_LowBoxSizer->Add( currPage->m_TitleStringCtrl, 0,
                                   wxGROW | wxTOP | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
 
     currPage->m_LowBoxSizer->Add( new wxStaticText( currPage, -1, _( "Netlist command:" ) ), 0,
                                                     wxGROW | wxLEFT | wxRIGHT | wxTOP, 5 );
 
     currPage->m_CommandStringCtrl = new wxTextCtrl( currPage, -1, aCommandString,
                                                     wxDefaultPosition, wxDefaultSize );
 
     currPage->m_CommandStringCtrl->SetInsertionPoint( 1 );
     currPage->m_LowBoxSizer->Add( currPage->m_CommandStringCtrl, 0,
                                   wxGROW | wxTOP | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
 
     return currPage;
 }

References _, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, NETLIST_PAGE_DIALOG::m_LowBoxSizer, NETLIST_DIALOG_BASE::m_NoteBook, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, and NETLIST_PAGE_DIALOG.

Referenced by InstallCustomPages(), and OnAddGenerator().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 307 of file dialog_shim.cpp.

 {
     // so we can do logging of this state change:
     return wxDialog::Enable( enable );
 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 445 of file dialog_shim.cpp.

 {
     // Hook up validator and transfer data from controls handling so quasi-modal dialogs
     // handle validation in the same way as other dialogs.
     if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
         return;
 
     SetReturnCode( retCode );
 
     if( !IsQuasiModal() )
     {
         wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
                     "wasn't called" );
         return;
     }
 
     if( m_qmodal_loop )
     {
         if( m_qmodal_loop->IsRunning() )
             m_qmodal_loop->Exit( 0 );
         else
             m_qmodal_loop->ScheduleExit( 0 );
 
         m_qmodal_loop = NULL;
     }
 
     delete m_qmodal_parent_disabler;
     m_qmodal_parent_disabler = 0;
 
     Show( false );
 }

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, NULL, and DIALOG_SHIM::Show().

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_SYMBOL::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_SYMBOL::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FilenamePrms()

bool NETLIST_DIALOG::FilenamePrms	(	NETLIST_TYPE_ID	aType,
		wxString *	aExt,
		wxString *	aWildCard
	)

private

Return the filename extension and the wildcard string for this page or a void name if there is no default name.

Parameters

aType	is the netlist type ( NET_TYPE_PCBNEW ... ).
aExt	[in] is a holder for the netlist file extension.
aWildCard	[in] is a holder for netlist file dialog wildcard.

Returns: true for known netlist type, false for custom formats.

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

 {
     wxString fileExt;
     wxString fileWildcard;
     bool     ret = true;
 
     switch( aType )
     {
     case NET_TYPE_SPICE:
         fileExt = wxT( "cir" );
         fileWildcard = SpiceNetlistFileWildcard();
         break;
 
     case NET_TYPE_CADSTAR:
         fileExt = wxT( "frp" );
         fileWildcard = CadstarNetlistFileWildcard();
         break;
 
     case NET_TYPE_PCBNEW:
     case NET_TYPE_ORCADPCB2:
         fileExt = NetlistFileExtension;
         fileWildcard = NetlistFileWildcard();
         break;
 
     default:    // custom, NET_TYPE_CUSTOM1 and greater
         fileWildcard = AllFilesWildcard();
         ret = false;
     }
 
     if( aExt )
         *aExt = fileExt;
 
     if( aWildCard )
         *aWildCard = fileWildcard;
 
     return ret;
 }

References AllFilesWildcard(), CadstarNetlistFileWildcard(), NET_TYPE_CADSTAR, NET_TYPE_ORCADPCB2, NET_TYPE_PCBNEW, NET_TYPE_SPICE, NetlistFileExtension, NetlistFileWildcard(), and SpiceNetlistFileWildcard().

Referenced by TransferDataFromWindow().

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )

protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 148 of file dialog_shim.cpp.

 {
     // must be called from the constructor of derived classes,
     // when all widgets are initialized, and therefore their size fixed
 
     // SetSizeHints fixes the minimal size of sizers in the dialog
     // (SetSizeHints calls Fit(), so no need to call it)
     GetSizer()->SetSizeHints( this );
 }

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:79

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

EDA_UNITS DIALOG_SHIM::GetUserUnits ( ) const

inlineinherited

Definition at line 120 of file dialog_shim.h.

     {
         return m_units;
     }

References DIALOG_SHIM::m_units.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_NET_INSPECTOR::formatLength(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onCellChanging(), POSITION_RELATIVE_TOOL::PositionRelative(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), DIALOG_POSITION_RELATIVE::updateDialogControls(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), DIALOG_BOARD_STATISTICS::updateWidets(), DIALOG_ERC::writeReport(), and DIALOG_DRC::writeReport().

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int x ) const

protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

 {
     wxSize sz( x, 0 );
     return ConvertDialogToPixels( sz ).x;
 }

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), and DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ InstallCustomPages()

void NETLIST_DIALOG::InstallCustomPages ( )

private

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

 {
     NETLIST_PAGE_DIALOG* currPage;
 
     auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
     wxASSERT( cfg );
 
     if( cfg )
     {
         for( size_t i = 0;
              i < CUSTOMPANEL_COUNTMAX && i < cfg->m_NetlistPanel.custom_command_titles.size();
              i++ )
         {
             // pairs of (title, command) are stored
             wxString title = cfg->m_NetlistPanel.custom_command_titles[i];
 
             if( i >= cfg->m_NetlistPanel.custom_command_paths.size() )
                 break; // No more panel to install
 
             wxString command = cfg->m_NetlistPanel.custom_command_paths[i];
 
             currPage = AddOneCustomPage( title, command,
                     static_cast<NETLIST_TYPE_ID>( NET_TYPE_CUSTOM1 + i ) );
 
             m_PanelNetType[PANELCUSTOMBASE + i] = currPage;
         }
     }
 }

References AddOneCustomPage(), CUSTOMPANEL_COUNTMAX, Kiface(), m_PanelNetType, NET_TYPE_CUSTOM1, and PANELCUSTOMBASE.

Referenced by NETLIST_DIALOG().

◆ InstallPageSpice()

void NETLIST_DIALOG::InstallPageSpice ( )

private

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

 {
     NETLIST_PAGE_DIALOG* page = m_PanelNetType[PANELSPICE] =
                     new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "Spice" ), NET_TYPE_SPICE );
 
     SCHEMATIC_SETTINGS& settings = m_Parent->Schematic().Settings();
 
     page->m_AdjustPassiveValues = new wxCheckBox( page, ID_USE_NETCODE_AS_NETNAME,
                                                   _( "Reformat passive symbol values" ) );
     page->m_AdjustPassiveValues->SetToolTip( _( "Reformat passive symbol values e.g. 1M -> 1Meg" ) );
     page->m_AdjustPassiveValues->SetValue( settings.m_SpiceAdjustPassiveValues );
     page->m_LeftBoxSizer->Add( page->m_AdjustPassiveValues, 0, wxGROW | wxBOTTOM | wxRIGHT, 5 );
 
     wxString simulatorCommand = settings.m_SpiceCommandString;
     wxStaticText* spice_label = new wxStaticText( page, -1, _( "External simulator command:" ) );
     spice_label->SetToolTip( _( "Enter the command line to run spice\n"
                                 "Usually <path to spice binary> %I\n"
                                 "%I will be replaced by the actual spice netlist name") );
     page->m_LowBoxSizer->Add( spice_label, 0, wxGROW | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
 
     page->m_CommandStringCtrl = new wxTextCtrl( page, -1, simulatorCommand,
                                                 wxDefaultPosition, wxDefaultSize );
 
     page->m_CommandStringCtrl->SetInsertionPoint( 1 );
     page->m_LowBoxSizer->Add( page->m_CommandStringCtrl, 0,
                               wxGROW | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
 
     // Add button to run spice command
     wxButton* button = new wxButton( page, ID_RUN_SIMULATOR,
                                      _( "Create Netlist and Run Simulator Command" ) );
     page->m_LowBoxSizer->Add( button, 0, wxGROW | wxBOTTOM | wxLEFT | wxRIGHT, 5 );
 }

References _, ID_RUN_SIMULATOR, ID_USE_NETCODE_AS_NETNAME, NETLIST_PAGE_DIALOG::m_AdjustPassiveValues, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, NETLIST_PAGE_DIALOG::m_LeftBoxSizer, NETLIST_PAGE_DIALOG::m_LowBoxSizer, NETLIST_DIALOG_BASE::m_NoteBook, m_PanelNetType, m_Parent, SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues, SCHEMATIC_SETTINGS::m_SpiceCommandString, NET_TYPE_SPICE, NETLIST_PAGE_DIALOG, PANELSPICE, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

Referenced by NETLIST_DIALOG().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl	(	int	aChar,
		const wxKeyEvent &	e
	)

inlinestaticinherited

Definition at line 125 of file dialog_shim.h.

     {
         return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
                 !e.ShiftDown() && !e.MetaDown();
     }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 107 of file dialog_shim.h.

107 { return m_qmodal_showing; }

DIALOG_SHIM::m_qmodal_showing

bool m_qmodal_showing

Definition: dialog_shim.h:214

References DIALOG_SHIM::m_qmodal_showing.

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::EndQuasiModal(), EDA_BASE_FRAME::findQuasiModalDialog(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_SYMBOL::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_CHOOSE_SYMBOL::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl	(	int	aChar,
		const wxKeyEvent &	e
	)

inlinestaticinherited

Definition at line 131 of file dialog_shim.h.

     {
         return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
                 e.ShiftDown() && !e.MetaDown();
     }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

     {
         wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
         return *m_kiway;
     }

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ NetlistUpdateOpt()

void NETLIST_DIALOG::NetlistUpdateOpt ( )

private

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

 {
     bool adjust = m_PanelNetType[ PANELSPICE ]->m_AdjustPassiveValues->IsChecked();
     wxString spice_cmd_string = m_PanelNetType[ PANELSPICE ]->m_CommandStringCtrl->GetValue();
 
     SCHEMATIC_SETTINGS& settings = m_Parent->Schematic().Settings();
 
     settings.m_SpiceAdjustPassiveValues = adjust;
     settings.m_SpiceCommandString       = spice_cmd_string;
     settings.m_NetFormatName            = wxEmptyString;
     settings.m_NetFormatName            = m_DefaultNetFmtName;
 }

References NETLIST_PAGE_DIALOG::m_AdjustPassiveValues, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, m_DefaultNetFmtName, SCHEMATIC_SETTINGS::m_NetFormatName, m_PanelNetType, m_Parent, SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues, SCHEMATIC_SETTINGS::m_SpiceCommandString, PANELSPICE, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

Referenced by OnRunExternSpiceCommand(), TransferDataFromWindow(), and WriteCurrentNetlistSetup().

◆ OnAddGenerator()

void NETLIST_DIALOG::OnAddGenerator ( wxCommandEvent & event )

overrideprivatevirtual

Add a new panel for a new netlist plugin.

Reimplemented from NETLIST_DIALOG_BASE.

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

 {
     NETLIST_DIALOG_ADD_GENERATOR dlg( this );
 
     if( dlg.ShowModal() != wxID_OK )
         return;
 
     // Creates a new custom plugin page
     wxString title = dlg.GetGeneratorTitle();
 
     // Verify it does not exists
     int netTypeId = PANELCUSTOMBASE;    // the first not used type id
     NETLIST_PAGE_DIALOG* currPage;
 
     for( int ii = 0; ii < CUSTOMPANEL_COUNTMAX; ii++ )
     {
         netTypeId = PANELCUSTOMBASE + ii;
         currPage = m_PanelNetType[ii + PANELCUSTOMBASE];
 
         if( currPage == NULL )
             break;
 
         if( currPage->GetPageNetFmtName() == title )
         {
             wxMessageBox( _("This plugin already exists.") );
             return;
         }
     }
 
     wxString cmd = dlg.GetGeneratorTCommandLine();
     currPage = AddOneCustomPage( title,cmd, (NETLIST_TYPE_ID)netTypeId );
     m_PanelNetType[netTypeId] = currPage;
     WriteCurrentNetlistSetup();
 
     // Close and reopen dialog to rebuild the dialog after changes
     EndModal( NET_PLUGIN_CHANGE );
 }

References _, AddOneCustomPage(), CUSTOMPANEL_COUNTMAX, NETLIST_DIALOG_ADD_GENERATOR::GetGeneratorTCommandLine(), NETLIST_DIALOG_ADD_GENERATOR::GetGeneratorTitle(), NETLIST_PAGE_DIALOG::GetPageNetFmtName(), m_PanelNetType, NET_PLUGIN_CHANGE, NULL, PANELCUSTOMBASE, and WriteCurrentNetlistSetup().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent & aEvt )

protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 536 of file dialog_shim.cpp.

 {
     if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
     {
         if( m_parentFrame )
         {
             m_parentFrame->ToggleUserUnits();
             return;
         }
     }
     // shift-return (Mac default) or Ctrl-Return (GTK) for OK
     else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
     {
         wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
         return;
     }
     else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
     {
         wxWindow* currentWindow = wxWindow::FindFocus();
         int       currentIdx = -1;
         int       delta = aEvt.ShiftDown() ? -1 : 1;
 
         auto advance = [&]( int& idx )
         {
             // Wrap-around modulus
             int size = m_tabOrder.size();
             idx = ( ( idx + delta ) % size + size ) % size;
         };
 
         for( size_t i = 0; i < m_tabOrder.size(); ++i )
         {
             if( m_tabOrder[i] == currentWindow )
             {
                 currentIdx = (int) i;
                 break;
             }
         }
 
         if( currentIdx >= 0 )
         {
             advance( currentIdx );
 
             //todo: We don't currently have non-textentry dialog boxes but this will break if
             // we add them.
 #ifdef __APPLE__
             while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
                 advance( currentIdx );
 #endif
 
             m_tabOrder[ currentIdx ]->SetFocus();
             return;
         }
     }
 
     aEvt.Skip();
 }

References DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

◆ OnDelGenerator()

void NETLIST_DIALOG::OnDelGenerator ( wxCommandEvent & event )

overrideprivatevirtual

Remove a panel relative to a netlist plugin.

Reimplemented from NETLIST_DIALOG_BASE.

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

 {
     NETLIST_PAGE_DIALOG* currPage = (NETLIST_PAGE_DIALOG*) m_NoteBook->GetCurrentPage();
 
     currPage->m_CommandStringCtrl->SetValue( wxEmptyString );
     currPage->m_TitleStringCtrl->SetValue( wxEmptyString );
     m_DefaultNetFmtName = m_PanelNetType[PANELPCBNEW]->GetPageNetFmtName();
 
     WriteCurrentNetlistSetup();
     EndModal( NET_PLUGIN_CHANGE );
 }

References NETLIST_PAGE_DIALOG::GetPageNetFmtName(), NETLIST_PAGE_DIALOG::m_CommandStringCtrl, m_DefaultNetFmtName, NETLIST_DIALOG_BASE::m_NoteBook, m_PanelNetType, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, NET_PLUGIN_CHANGE, PANELPCBNEW, and WriteCurrentNetlistSetup().

◆ OnNetlistTypeSelection()

void NETLIST_DIALOG::OnNetlistTypeSelection ( wxNotebookEvent & event )

overrideprivatevirtual

Reimplemented from NETLIST_DIALOG_BASE.

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

 {
     NETLIST_PAGE_DIALOG* currPage = (NETLIST_PAGE_DIALOG*) m_NoteBook->GetCurrentPage();
 
     if( currPage == NULL )
         return;
 
     m_DefaultNetFmtName = currPage->GetPageNetFmtName();
 
     m_buttonDelGenerator->Enable( currPage->m_IdNetType >= NET_TYPE_CUSTOM1 );
 }

References NETLIST_PAGE_DIALOG::GetPageNetFmtName(), NETLIST_DIALOG_BASE::m_buttonDelGenerator, m_DefaultNetFmtName, NETLIST_PAGE_DIALOG::m_IdNetType, NETLIST_DIALOG_BASE::m_NoteBook, NET_TYPE_CUSTOM1, and NULL.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event )

inherited

Definition at line 352 of file dialog_shim.cpp.

 {
     if( m_firstPaintEvent )
     {
         KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision( this );
 
         selectAllInTextCtrls( GetChildren() );
 
         if( m_initialFocusTarget )
             KIPLATFORM::UI::ForceFocus( m_initialFocusTarget );
         else
             KIPLATFORM::UI::ForceFocus( this );     // Focus the dialog itself
 
         m_firstPaintEvent = false;
     }
 
     event.Skip();
 }

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnRunExternSpiceCommand()

void NETLIST_DIALOG::OnRunExternSpiceCommand ( wxCommandEvent & event )

private

Run the external spice simulator command.

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

 {
     // Run the external spice simulator command
     NetlistUpdateOpt();
 
     SCHEMATIC_SETTINGS& settings = m_Parent->Schematic().Settings();
     wxString simulatorCommand = settings.m_SpiceCommandString;
 
     unsigned netlist_opt = 0;
 
     // Calculate the netlist filename and options
     wxFileName fn = m_Parent->Schematic().GetFileName();
     fn.SetExt( wxT( "cir" ) );
 
     if( settings.m_SpiceAdjustPassiveValues )
         netlist_opt |= NET_ADJUST_PASSIVE_VALS;
 
     // Build the command line
     wxString commandLine = simulatorCommand;
     commandLine.Replace( "%I", fn.GetFullPath(), true );
 
     if( m_Parent->ReadyToNetlist( _( "Simulator requires a fully annotated schematic." ) ) )
     {
         m_Parent->WriteNetListFile( NET_TYPE_SPICE, fn.GetFullPath(), netlist_opt, nullptr );
         wxExecute( commandLine, wxEXEC_ASYNC );
     }
 }

References _, SCHEMATIC::GetFileName(), m_Parent, SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues, SCHEMATIC_SETTINGS::m_SpiceCommandString, NET_ADJUST_PASSIVE_VALS, NET_TYPE_SPICE, NetlistUpdateOpt(), SCH_EDIT_FRAME::ReadyToNetlist(), SCH_EDIT_FRAME::Schematic(), SCHEMATIC::Settings(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ OnRunSpiceButtUI()

void NETLIST_DIALOG::OnRunSpiceButtUI ( wxUpdateUIEvent & event )

private

Enable (if the command line is not empty or disable the button to run spice command.

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

 {
     bool disable = m_PanelNetType[PANELSPICE]->m_CommandStringCtrl->IsEmpty();
     aEvent.Enable( !disable );
 }

References NETLIST_PAGE_DIALOG::m_CommandStringCtrl, m_PanelNetType, and PANELSPICE.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

 {
     return Kiway().Prj();
 }

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )

protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 282 of file dialog_shim.cpp.

 {
     const char* hash_key;
 
     if( m_hash_key.size() )
     {
         // a special case like EDA_LIST_DIALOG, which has multiple uses.
         hash_key = m_hash_key.c_str();
     }
     else
     {
         hash_key = typeid(*this).name();
     }
 
     RECT_MAP::iterator it = class_map.find( hash_key );
 
     if( it == class_map.end() )
         return;
 
     EDA_RECT rect = it->second;
     rect.SetSize( 0, 0 );
     class_map[ hash_key ] = rect;
 }

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow * aWindow )

inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 98 of file dialog_shim.h.

     {
         m_initialFocusTarget = aWindow;
     }

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway	(	wxWindow *	aDest,
		KIWAY *	aKiway
	)

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

 {
 #if defined(DEBUG)
     // offer a trap point for debugging most any window
     wxASSERT( aDest );
     if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
     {
         int breakhere=1;
         (void) breakhere;
     }
 #endif
 
     (void) aDest;
 
     m_kiway = aKiway;
 }

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint & aNewPosition )

inherited

Force the position of the dialog to a new position.

Parameters

aNewPosition is the new forced position

Definition at line 187 of file dialog_shim.cpp.

 {
     wxDialog::SetPosition( aNewPosition );
 
     // Now update the stored position:
     const char* hash_key;
 
     if( m_hash_key.size() )
     {
         // a special case like EDA_LIST_DIALOG, which has multiple uses.
         hash_key = m_hash_key.c_str();
     }
     else
     {
         hash_key = typeid(*this).name();
     }
 
     RECT_MAP::iterator it = class_map.find( hash_key );
 
     if( it == class_map.end() )
         return;
 
     EDA_RECT rect = it->second;
     rect.SetOrigin( aNewPosition );
 
     class_map[ hash_key ] = rect;
 }

References class_map, DIALOG_SHIM::m_hash_key, EDA_RECT::SetOrigin(), and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

◆ setSizeInDU()

void DIALOG_SHIM::setSizeInDU	(	int	x,
		int	y
	)

protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 159 of file dialog_shim.cpp.

 {
     wxSize sz( x, y );
     SetSize( ConvertDialogToPixels( sz ) );
 }

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 216 of file dialog_shim.cpp.

 {
     bool        ret;
     const char* hash_key;
 
     if( m_hash_key.size() )
     {
         // a special case like EDA_LIST_DIALOG, which has multiple uses.
         hash_key = m_hash_key.c_str();
     }
     else
     {
         hash_key = typeid(*this).name();
     }
 
     // Show or hide the window.  If hiding, save current position and size.
     // If showing, use previous position and size.
     if( show )
     {
 #ifndef __WINDOWS__
         wxDialog::Raise();  // Needed on OS X and some other window managers (i.e. Unity)
 #endif
         ret = wxDialog::Show( show );
 
         // classname is key, returns a zeroed out default EDA_RECT if none existed before.
         EDA_RECT savedDialogRect = class_map[ hash_key ];
 
         if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
         {
             if( m_useCalculatedSize )
             {
                 SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
                          wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
             }
             else
             {
                 SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
                          std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
                          std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
                          0 );
             }
         }
 
         // Be sure that the dialog appears in a visible area
         // (the dialog position might have been stored at the time when it was
         // shown on another display)
         if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
             Centre();
     }
     else
     {
         // Save the dialog's position & size before hiding, using classname as key
         class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
 
 #ifdef __WXMAC__
         if ( m_eventLoop )
             m_eventLoop->Exit( GetReturnCode() );   // Needed for APP-MODAL dlgs on OSX
 #endif
 
         ret = wxDialog::Show( show );
     }
 
     return ret;
 }

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 395 of file dialog_shim.cpp.

 {
     // This is an exception safe way to zero a pointer before returning.
     // Yes, even though DismissModal() clears this first normally, this is
     // here in case there's an exception before the dialog is dismissed.
     struct NULLER
     {
         void*&  m_what;
         NULLER( void*& aPtr ) : m_what( aPtr ) {}
         ~NULLER() { m_what = 0; }   // indeed, set it to NULL on destruction
     } clear_this( (void*&) m_qmodal_loop );
 
     // release the mouse if it's currently captured as the window having it
     // will be disabled when this dialog is shown -- but will still keep the
     // capture making it impossible to do anything in the modal dialog itself
     wxWindow* win = wxWindow::GetCapture();
     if( win )
         win->ReleaseMouse();
 
     // Get the optimal parent
     wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
 
     wxASSERT_MSG( !m_qmodal_parent_disabler,
             wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
 
     // quasi-modal: disable only my "optimal" parent
     m_qmodal_parent_disabler = new WDO_ENABLE_DISABLE( parent );
 
     // Apple in its infinite wisdom will raise a disabled window before even passing
     // us the event, so we have no way to stop it.  Instead, we must set an order on
     // the windows so that the quasi-modal will be pushed in front of the disabled
     // window when it is raised.
     KIPLATFORM::UI::ReparentQuasiModal( this );
 
     Show( true );
 
     m_qmodal_showing = true;
 
     WX_EVENT_LOOP event_loop;
 
     m_qmodal_loop = &event_loop;
 
     event_loop.Run();
 
     m_qmodal_showing = false;
 
     return GetReturnCode();
 }

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool NETLIST_DIALOG::TransferDataFromWindow ( )

overrideprivate

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

 {
     wxFileName  fn;
     wxString    fileWildcard;
     wxString    fileExt;
     wxString    title = _( "Save Netlist File" );
 
     NetlistUpdateOpt();
 
     NETLIST_PAGE_DIALOG* currPage;
     currPage = (NETLIST_PAGE_DIALOG*) m_NoteBook->GetCurrentPage();
 
     unsigned netlist_opt = 0;
 
     // Calculate the netlist filename
     fn = m_Parent->Schematic().GetFileName();
     FilenamePrms( currPage->m_IdNetType, &fileExt, &fileWildcard );
 
     // Set some parameters
     switch( currPage->m_IdNetType )
     {
     case NET_TYPE_SPICE:
         // Set spice netlist options:
         if( currPage->m_AdjustPassiveValues->GetValue() )
             netlist_opt |= NET_ADJUST_PASSIVE_VALS;
         break;
 
     case NET_TYPE_CADSTAR:
         break;
 
     case NET_TYPE_PCBNEW:
         break;
 
     case NET_TYPE_ORCADPCB2:
         break;
 
     default:    // custom, NET_TYPE_CUSTOM1 and greater
     {
         wxString command = currPage->m_CommandStringCtrl->GetValue();
         wxRegEx extRE( wxT( ".*\\.([[:alnum:]][[:alnum:]][[:alnum:]][[:alnum:]]?)\\.xslt?\".*" ) );
 
         if( extRE.Matches( command ) )
             fileExt = extRE.GetMatch( command, 1 );
 
         title.Printf( _( "%s Export" ), currPage->m_TitleStringCtrl->GetValue().GetData() );
     }
         break;
     }
 
     fn.SetExt( fileExt );
 
     if( fn.GetPath().IsEmpty() )
        fn.SetPath( wxPathOnly( Prj().GetProjectFullName() ) );
 
     wxString fullpath = fn.GetFullPath();
     wxString fullname = fn.GetFullName();
     wxString path     = fn.GetPath();
 
     // fullname does not and should not include the path, per wx docs.
     wxFileDialog dlg( this, title, path, fullname, fileWildcard, wxFD_SAVE );
 
     if( dlg.ShowModal() == wxID_CANCEL )
         return false;
 
     fullpath = dlg.GetPath();   // directory + filename
 
     m_Parent->ClearMsgPanel();
 
     if( currPage->m_CommandStringCtrl )
         m_Parent->SetNetListerCommand( currPage->m_CommandStringCtrl->GetValue() );
     else
         m_Parent->SetNetListerCommand( wxEmptyString );
 
     if( m_Parent->ReadyToNetlist( _( "Exporting netlist requires a fully annotated schematic." ) ) )
         m_Parent->WriteNetListFile( currPage->m_IdNetType, fullpath, netlist_opt, nullptr );
 
     WriteCurrentNetlistSetup();
 
     return true;
 }

References _, EDA_DRAW_FRAME::ClearMsgPanel(), FilenamePrms(), SCHEMATIC::GetFileName(), NETLIST_PAGE_DIALOG::m_AdjustPassiveValues, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, NETLIST_PAGE_DIALOG::m_IdNetType, NETLIST_DIALOG_BASE::m_NoteBook, m_Parent, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, NET_ADJUST_PASSIVE_VALS, NET_TYPE_CADSTAR, NET_TYPE_ORCADPCB2, NET_TYPE_PCBNEW, NET_TYPE_SPICE, NetlistUpdateOpt(), path, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::ReadyToNetlist(), SCH_EDIT_FRAME::Schematic(), SCH_EDIT_FRAME::SetNetListerCommand(), WriteCurrentNetlistSetup(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int y ) const

protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 173 of file dialog_shim.cpp.

 {
     wxSize sz( 0, y );
     return ConvertDialogToPixels( sz ).y;
 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ WriteCurrentNetlistSetup()

void NETLIST_DIALOG::WriteCurrentNetlistSetup ( )

private

Write the current netlist options setup in the configuration.

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

 {
     wxString  msg;
 
     NetlistUpdateOpt();
 
     EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
     wxASSERT( cfg );
 
     if( cfg )
     {
         cfg->m_NetlistPanel.custom_command_titles.clear();
         cfg->m_NetlistPanel.custom_command_paths.clear();
 
         // Update existing custom pages
         for( int ii = 0; ii < CUSTOMPANEL_COUNTMAX; ii++ )
         {
             NETLIST_PAGE_DIALOG* currPage = m_PanelNetType[ii + PANELCUSTOMBASE];
 
             if( currPage == NULL )
                 break;
 
             wxString title = currPage->m_TitleStringCtrl->GetValue();
 
             if( title.IsEmpty() )
                 continue;
 
             cfg->m_NetlistPanel.custom_command_titles.emplace_back( title.ToStdString() );
             cfg->m_NetlistPanel.custom_command_paths.emplace_back(
                     currPage->m_CommandStringCtrl->GetValue().ToStdString() );
         }
     }
 }