#include <pcb_calculator_frame.h>

Inheritance diagram for PCB_CALCULATOR_FRAME:

Public Types
enum	UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
	Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...

enum	HOLDER_TYPE { DIALOG, FRAME, PANEL }

Public Member Functions
	PCB_CALCULATOR_FRAME (KIWAY aKiway, wxWindow aParent)

	~PCB_CALCULATOR_FRAME ()

void	SetPrmValue (enum PRMS_ID aPrmId, double aValue)
	Function SetPrmValue Read/write params values and results. More...

void	SetResult (int aLineNumber, const wxString &aText)
	Function SetResult Puts the text into the given result line. More...

void	SetPrmBgColor (enum PRMS_ID aPrmId, const KIGFX::COLOR4D *aCol)
	Function SetPrgmBgColor Set the background color of a parameter. More...

double	GetPrmValue (enum PRMS_ID aPrmId) const
	Function GetPrmValue Returns a param value. More...

bool	IsPrmSelected (enum PRMS_ID aPrmId) const
	Function IsPrmSelected. More...

void	OnBoardClassesUnitsSelection (wxCommandEvent &event) override

void	BoardClassesUpdateData (double aUnitScale)

wxWindow *	GetToolCanvas () const override
	Canvas access. More...

virtual bool	OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
	Open a project or set of files given by aFileList. More...

virtual void	ParseArgs (wxCmdLineParser &aParser)
	Handle command-line arguments in a frame-specific way. More...

virtual bool	ShowModal (wxString aResult=nullptr, wxWindow aResultantFocusWindow=nullptr)
	Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...

virtual void	KiwayMailIn (KIWAY_EXPRESS &aEvent)
	Receive KIWAY_EXPRESS messages from other players. More...

bool	Destroy () override
	Our version of Destroy() which is virtual from wxWidgets. More...

bool	IsModal () const override
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...

void	SetModal (bool aIsModal)

bool	IsDismissed ()

void	DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)

EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...

void	SetUserUnits (EDA_UNITS aUnits)

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual void	ToggleUserUnits ()

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

bool	ProcessEvent (wxEvent &aEvent) override
	Override the default process event handler to implement the auto save feature. More...

virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	Capture the key event before it is sent to the GUI. More...

void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...

virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID `aID`. More...

virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...

virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`. More...

virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using `RegisterUIUpdateHandler`. More...

virtual void	OnMove (wxMoveEvent &aEvent)

void	OnMaximize (wxMaximizeEvent &aEvent)

void	SetAutoSaveInterval (int aInterval)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program. More...

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...

void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...

virtual APP_SETTINGS_BASE *	config () const
	Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...

virtual void	InstallPreferences (PAGED_DIALOG , PANEL_HOTKEYS_EDITOR )
	Allow a frame to load its preference panels (if any) into the preferences dialog. More...

void	LoadWindowState (const wxString &aFileName)

virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file. More...

void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Load window settings from the given settings object. More...

void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object. More...

virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return a pointer to the window settings for this frame. More...

wxString	ConfigBaseName () override
	Get the configuration base name. More...

virtual void	SaveProjectSettings ()
	Save changes to the project settings to the project (.pro) file. More...

void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it. More...

wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetches the file name from the file history list. More...

void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	Removes all files from the file history. More...

void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files. More...

FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history. More...

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

virtual wxString	GetCurrentFileName () const
	Get the full filename + path of the currently opened file in the frame. More...

virtual void	ReCreateMenuBar ()
	Recreates the menu bar. More...

void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Adds the standard KiCad help menu to the menubar. More...

bool	IsWritable (const wxFileName &aFileName)
	Checks if aFileName can be written. More...

void	CheckForAutoSaveFile (const wxFileName &aFileName)
	Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...

virtual void	UpdateStatusBar ()
	Update the status bar information. More...

virtual void	ShowChangedLanguage ()
	Redraw the menus and what not in current language. More...

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Notification event that some of the common (suite-wide) settings have changed. More...

virtual void	ThemeChanged ()
	Process light/dark theme change. More...

virtual void	ProjectChanged ()
	Notification event that the project has changed. More...

const wxString &	GetAboutTitle () const

virtual bool	IsContentModified ()
	Get if the contents of the frame have been modified since the last save. More...

wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size. More...

virtual void	ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)

virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList() More...

virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list. More...

virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...

virtual SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area. More...

virtual void	PushTool (const std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...

virtual void	PopTool (const std::string &actionName)

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

virtual void	DisplayToolMsg (const wxString &msg)

bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...

MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...

bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...

virtual void	RefreshCanvas ()

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 void	HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
	Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...

Public Attributes
REGULATOR_LIST	m_RegulatorList

Protected Member Functions
void	kiway_express (KIWAY_EXPRESS &aEvent)
	event handler, routes to derivative specific virtual KiwayMailIn() More...

void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection. More...

void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event. More...

virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...

virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature. More...

virtual bool	canCloseWindow (wxCloseEvent &aCloseEvent)

virtual void	doCloseWindow ()

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

virtual void	unitsChangeRefresh ()
	Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...

virtual void	setupUIConditions ()
	Setup the UI conditions for the various actions and their controls in this frame. More...

void	initExitKey ()
	Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
wxMenuBar *	m_menubar

wxNotebook *	m_Notebook

wxPanel *	m_panelRegulators

wxStaticText *	m_staticTextRegType

wxChoice *	m_choiceRegType

wxStaticBitmap *	m_bitmapRegul4pins

wxStaticBitmap *	m_bitmapRegul3pins

wxStaticText *	m_RegulFormula

wxRadioButton *	m_rbRegulR1

wxStaticText *	m_labelRegultR1

wxTextCtrl *	m_RegulR1Value

wxStaticText *	m_r1Units

wxRadioButton *	m_rbRegulR2

wxStaticText *	m_labelRegultR2

wxTextCtrl *	m_RegulR2Value

wxStaticText *	m_r2Units

wxRadioButton *	m_rbRegulVout

wxStaticText *	m_labelVout

wxTextCtrl *	m_RegulVoutValue

wxStaticText *	m_unitsVout

wxStaticText *	m_labelVRef

wxTextCtrl *	m_RegulVrefValue

wxStaticText *	m_unitsVref

wxStaticText *	m_RegulIadjTitle

wxTextCtrl *	m_RegulIadjValue

wxStaticText *	m_IadjUnitLabel

wxButton *	m_buttonCalculate

wxButton *	m_buttonRegulReset

wxStaticText *	m_RegulMessage

wxChoice *	m_choiceRegulatorSelector

wxStaticText *	m_staticTextRegFile

wxTextCtrl *	m_regulators_fileNameCtrl

wxButton *	m_buttonDataFile

wxButton *	m_buttonEditItem

wxButton *	m_buttonAddItem

wxButton *	m_buttonRemoveItem

wxPanel *	m_panelAttenuators

wxRadioBox *	m_AttenuatorsSelection

wxStaticBitmap *	m_attenuatorBitmap

wxStaticText *	m_attenuationLabel

wxTextCtrl *	m_AttValueCtrl

wxStaticText *	m_attUnit

wxStaticText *	m_attenuationZinLabel

wxTextCtrl *	m_ZinValueCtrl

wxStaticText *	m_attZinUnit

wxStaticText *	m_ZoutLabel

wxTextCtrl *	m_ZoutValueCtrl

wxStaticText *	m_attZoutUnit

wxButton *	m_buttonAlcAtt

wxBitmapButton *	m_bpButtonCalcAtt

wxStaticText *	m_attenuatorR1Label

wxTextCtrl *	m_Att_R1_Value

wxStaticText *	m_attR1Unit

wxStaticText *	m_attenuatorR2Label

wxTextCtrl *	m_Att_R2_Value

wxStaticText *	m_attR2Unit

wxStaticText *	m_attenuatorR3Label

wxTextCtrl *	m_Att_R3_Value

wxStaticText *	m_attR3Unit

wxStaticText *	m_staticTextAttMsg

wxHtmlWindow *	m_Attenuator_Messages

wxHtmlWindow *	m_panelAttFormula

wxPanel *	m_panelESeries

wxStaticText *	m_ESrequired

wxTextCtrl *	m_ResRequired

wxStaticText *	m_reqResUnits

wxStaticText *	m_ESrequired1

wxTextCtrl *	m_ResExclude1

wxStaticText *	m_exclude1Units

wxStaticText *	m_ESrequired11

wxTextCtrl *	m_ResExclude2

wxStaticText *	m_exclude2Units

wxStaticLine *	m_staticline6

wxRadioButton *	m_e1

wxRadioButton *	m_e3

wxRadioButton *	m_e6

wxRadioButton *	m_e12

wxStaticText *	m_ESerieSimpleSolution

wxTextCtrl *	m_ESeries_Sol2R

wxStaticText *	m_ESeriesSimpleErr

wxTextCtrl *	m_ESeriesError2R

wxStaticText *	m_ESeriesSimplePercent

wxStaticText *	m_ESerie3RSolution1

wxTextCtrl *	m_ESeries_Sol3R

wxStaticText *	m_ESeriesAltErr

wxTextCtrl *	m_ESeriesError3R

wxStaticText *	m_ESeriesAltPercent

wxStaticText *	m_ESeries4RSolution

wxTextCtrl *	m_ESeries_Sol4R

wxStaticText *	m_ESeriesAltErr1

wxTextCtrl *	m_ESeriesError4R

wxStaticText *	m_ESeriesAltPercent1

wxStaticLine *	m_staticline7

wxButton *	m_buttonEScalculate

wxHtmlWindow *	m_panelESeriesHelp

wxPanel *	m_panelColorCode

wxRadioBox *	m_rbToleranceSelection

wxStaticText *	m_staticText31

wxStaticText *	m_staticText34

wxStaticText *	m_staticText35

wxStaticText *	m_Band4Label

wxStaticText *	m_staticText37

wxStaticText *	m_staticText38

wxStaticBitmap *	m_Band1bitmap

wxStaticBitmap *	m_Band2bitmap

wxStaticBitmap *	m_Band3bitmap

wxStaticBitmap *	m_Band4bitmap

wxStaticBitmap *	m_Band_mult_bitmap

wxStaticBitmap *	m_Band_tol_bitmap

wxPanel *	m_panelTransline

wxRadioBox *	m_TranslineSelection

wxStaticBitmap *	m_translineBitmap

wxStaticText *	m_EpsilonR_label

wxTextCtrl *	m_Value_EpsilonR

wxButton *	m_button_EpsilonR

wxStaticText *	m_TanD_label

wxTextCtrl *	m_Value_TanD

wxButton *	m_button_TanD

wxStaticText *	m_Rho_label

wxTextCtrl *	m_Value_Rho

wxButton *	m_button_Rho

wxStaticText *	m_substrate_prm4_label

wxTextCtrl *	m_Substrate_prm4_Value

UNIT_SELECTOR_LEN *	m_SubsPrm4_choiceUnit

wxStaticText *	m_substrate_prm5_label

wxTextCtrl *	m_Substrate_prm5_Value

UNIT_SELECTOR_LEN *	m_SubsPrm5_choiceUnit

wxStaticText *	m_substrate_prm6_label

wxTextCtrl *	m_Substrate_prm6_Value

UNIT_SELECTOR_LEN *	m_SubsPrm6_choiceUnit

wxStaticText *	m_substrate_prm7_label

wxTextCtrl *	m_Substrate_prm7_Value

UNIT_SELECTOR_LEN *	m_SubsPrm7_choiceUnit

wxStaticText *	m_substrate_prm8_label

wxTextCtrl *	m_Substrate_prm8_Value

UNIT_SELECTOR_LEN *	m_SubsPrm8_choiceUnit

wxStaticText *	m_substrate_prm9_label

wxTextCtrl *	m_Substrate_prm9_Value

UNIT_SELECTOR_LEN *	m_SubsPrm9_choiceUnit

wxStaticText *	m_Frequency_label

wxTextCtrl *	m_Value_Frequency_Ctrl

UNIT_SELECTOR_FREQUENCY *	m_choiceUnit_Frequency

wxStaticBitmap *	m_bmCMicrostripZoddZeven

wxFlexGridSizer *	m_fgSizerZcomment

wxStaticText *	m_staticTextZdiff

wxStaticText *	m_staticTextZcommon

wxStaticText *	m_phys_prm1_label

wxTextCtrl *	m_Phys_prm1_Value

UNIT_SELECTOR_LEN *	m_choiceUnit_Param1

wxRadioButton *	m_radioBtnPrm1

wxStaticText *	m_phys_prm2_label

wxTextCtrl *	m_Phys_prm2_Value

UNIT_SELECTOR_LEN *	m_choiceUnit_Param2

wxRadioButton *	m_radioBtnPrm2

wxStaticText *	m_phys_prm3_label

wxTextCtrl *	m_Phys_prm3_Value

UNIT_SELECTOR_LEN *	m_choiceUnit_Param3

wxBitmapButton *	m_bpButtonAnalyze

wxButton *	m_AnalyseButton

wxButton *	m_SynthetizeButton

wxBitmapButton *	m_bpButtonSynthetize

wxStaticText *	m_elec_prm1_label

wxTextCtrl *	m_Elec_prm1_Value

UNIT_SELECTOR_RESISTOR *	m_choiceUnit_ElecPrm1

wxStaticText *	m_elec_prm2_label

wxTextCtrl *	m_Elec_prm2_Value

UNIT_SELECTOR_RESISTOR *	m_choiceUnit_ElecPrm2

wxStaticText *	m_elec_prm3_label

wxTextCtrl *	m_Elec_prm3_Value

UNIT_SELECTOR_ANGLE *	m_choiceUnit_ElecPrm3

wxStaticText *	m_left_message1

wxStaticText *	m_Message1

wxStaticText *	m_left_message2

wxStaticText *	m_Message2

wxStaticText *	m_left_message3

wxStaticText *	m_Message3

wxStaticText *	m_left_message4

wxStaticText *	m_Message4

wxStaticText *	m_left_message5

wxStaticText *	m_Message5

wxStaticText *	m_left_message6

wxStaticText *	m_Message6

wxStaticText *	m_left_message7

wxStaticText *	m_Message7

wxButton *	m_buttonTransLineReset

wxPanel *	m_panelViaSize

wxStaticText *	m_staticTextHoleDia

wxTextCtrl *	m_textCtrlHoleDia

UNIT_SELECTOR_LEN *	m_choiceHoleDia

wxStaticText *	m_staticTextPlatingThickness

wxTextCtrl *	m_textCtrlPlatingThickness

UNIT_SELECTOR_LEN *	m_choicePlatingThickness

wxStaticText *	m_staticTextViaLength

wxTextCtrl *	m_textCtrlViaLength

UNIT_SELECTOR_LEN *	m_choiceViaLength

wxStaticText *	m_staticTextViaPadDia

wxTextCtrl *	m_textCtrlViaPadDia

UNIT_SELECTOR_LEN *	m_choiceViaPadDia

wxStaticText *	m_staticTextClearanceDia

wxTextCtrl *	m_textCtrlClearanceDia

UNIT_SELECTOR_LEN *	m_choiceClearanceDia

wxStaticText *	m_staticTextImpedance

wxTextCtrl *	m_textCtrlImpedance

UNIT_SELECTOR_RESISTOR *	m_choiceImpedance

wxStaticText *	m_staticAppliedCurrent

wxTextCtrl *	m_textCtrlAppliedCurrent

wxStaticText *	m_staticTextAppliedCurrentUnits

wxStaticText *	m_staticTextResistivity

wxTextCtrl *	m_textCtrlPlatingResistivity

wxButton *	m_button_ResistivityVia

wxStaticText *	m_viaResistivityUnits

wxStaticText *	m_staticTextPermittivity

wxTextCtrl *	m_textCtrlPlatingPermittivity

wxButton *	m_button_Permittivity

wxStaticText *	m_staticTextTemperatureDiff

wxTextCtrl *	m_textCtrlTemperatureDiff

wxStaticText *	m_viaTempUnits

wxStaticText *	m_staticTextRiseTime

wxTextCtrl *	m_textCtrlRiseTime

wxStaticText *	m_staticTextRiseTimeUnits

wxStaticText *	m_staticTextWarning

wxStaticText *	m_staticTextArea11

wxStaticText *	m_ViaResistance

wxStaticText *	m_viaResUnits

wxStaticText *	m_staticText65111

wxStaticText *	m_ViaVoltageDrop

wxStaticText *	m_staticText8411

wxStaticText *	m_staticText66111

wxStaticText *	m_ViaPowerLoss

wxStaticText *	m_staticText8311

wxStaticText *	m_staticText79211

wxStaticText *	m_ViaThermalResistance

wxStaticText *	m_viaThermalResUnits

wxStaticText *	m_staticTextAmpacity

wxStaticText *	m_ViaAmpacity

wxStaticText *	m_staticTextAmpacityUnits

wxStaticText *	m_staticTextCapacitance

wxStaticText *	m_ViaCapacitance

wxStaticText *	m_staticTextCapacitanceUnits

wxStaticText *	m_staticTextRiseTimeOutput

wxStaticText *	m_RiseTimeOutput

wxStaticText *	m_staticTextRiseTimeOutputUnits

wxStaticText *	m_staticTextInductance

wxStaticText *	m_Inductance

wxStaticText *	m_staticTextInductanceUnits

wxStaticText *	m_staticTextReactance

wxStaticText *	m_Reactance

wxStaticText *	m_viaReactanceUnits

wxStaticBitmap *	m_viaBitmap

wxButton *	m_buttonViaReset

wxPanel *	m_panelTrackWidth

wxStaticText *	m_staticTextCurrent

wxTextCtrl *	m_TrackCurrentValue

wxStaticText *	m_staticText62

wxStaticText *	m_staticText63

wxTextCtrl *	m_TrackDeltaTValue

wxStaticText *	m_trackTempUnits

wxStaticText *	m_staticText66

wxTextCtrl *	m_TrackLengthValue

UNIT_SELECTOR_LEN *	m_TW_CuLength_choiceUnit

wxStaticText *	m_staticText103

wxTextCtrl *	m_TWResistivity

wxStaticText *	m_resistivityUnits

wxHtmlWindow *	m_htmlWinFormulas

wxStaticText *	m_staticTextExtWidth

wxTextCtrl *	m_ExtTrackWidthValue

UNIT_SELECTOR_LEN *	m_TW_ExtTrackWidth_choiceUnit

wxStaticText *	m_staticText65

wxTextCtrl *	m_ExtTrackThicknessValue

UNIT_SELECTOR_THICKNESS *	m_ExtTrackThicknessUnit

wxStaticLine *	m_staticline3

wxStaticLine *	m_staticline4

wxStaticLine *	m_staticline5

wxStaticText *	m_staticTextArea

wxStaticText *	m_ExtTrackAreaValue

wxStaticText *	m_extTrackAreaUnitLabel

wxStaticText *	m_staticText651

wxStaticText *	m_ExtTrackResistValue

wxStaticText *	m_extTrackResUnits

wxStaticText *	m_staticText661

wxStaticText *	m_ExtTrackVDropValue

wxStaticText *	m_staticText83

wxStaticText *	m_staticText79

wxStaticText *	m_ExtTrackLossValue

wxStaticText *	m_staticText791

wxStaticText *	m_staticTextIntWidth

wxTextCtrl *	m_IntTrackWidthValue

UNIT_SELECTOR_LEN *	m_TW_IntTrackWidth_choiceUnit

wxStaticText *	m_staticText652

wxTextCtrl *	m_IntTrackThicknessValue

UNIT_SELECTOR_THICKNESS *	m_IntTrackThicknessUnit

wxStaticLine *	m_staticline8

wxStaticLine *	m_staticline9

wxStaticLine *	m_staticline10

wxStaticText *	m_staticTextArea1

wxStaticText *	m_IntTrackAreaValue

wxStaticText *	m_intTrackAreaUnitLabel

wxStaticText *	m_staticText6511

wxStaticText *	m_IntTrackResistValue

wxStaticText *	m_intTrackResUnits

wxStaticText *	m_staticText6611

wxStaticText *	m_IntTrackVDropValue

wxStaticText *	m_staticText831

wxStaticText *	m_staticText792

wxStaticText *	m_IntTrackLossValue

wxStaticText *	m_staticText7911

wxButton *	m_buttonTrackWidthReset

wxPanel *	m_panelElectricalSpacing

UNIT_SELECTOR_LEN *	m_ElectricalSpacingUnitsSelector

wxStaticLine *	m_staticline2

wxStaticText *	m_staticText891

wxTextCtrl *	m_ElectricalSpacingVoltage

wxButton *	m_buttonElectSpacingRefresh

wxBoxSizer *	m_electricalSpacingSizer

wxStaticText *	m_staticTextElectricalSpacing

wxGrid *	m_gridElectricalSpacingValues

wxStaticText *	m_staticText88

wxPanel *	m_panelBoardClass

UNIT_SELECTOR_LEN *	m_BoardClassesUnitsSelector

wxStaticText *	m_staticTextBrdClass

wxGrid *	m_gridClassesValuesDisplay

wxPanel *	m_panelShowClassPrms

bool	m_modal

WX_EVENT_LOOP *	m_modal_loop
	< Points to nested event_loop. NULL means not modal and dismissed. More...

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_hasAutoSave

bool	m_autoSaveState

int	m_autoSaveInterval

wxTimer *	m_autoSaveTimer

int	m_undoRedoCountMax

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

EDA_UNITS	m_userUnits
	Map containing the UI update handlers registered with wx for each action. More...

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...

bool	m_isClosing
	Set by NonUserClose() to indicate that the user did not request the current close. More...

bool	m_isNonUserClose

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

Static Protected Attributes
static constexpr int	KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE \| wxAUI_TB_PLAIN_BACKGROUND
	< Default style flags used for wxAUI toolbars. More...

Private Types
enum	{ TW_MASTER_CURRENT, TW_MASTER_EXT_WIDTH, TW_MASTER_INT_WIDTH }

Private Member Functions
void	OnClosePcbCalc (wxCloseEvent &event) override

void	OnUpdateUI (wxUpdateUIEvent &event) override

void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file. More...

void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file. More...

bool	ReadDataFile ()

bool	WriteDataFile ()

const wxString	GetDataFilename ()

void	SetDataFilename (const wxString &aFilename)
	Initialize the full filename of the selected pcb_calculator data file force the standard extension of the file (.pcbcalc) More...

void	initTrackWidthPanel ()
	Panel-specific initializers. More...

void	initESeriesPanel ()

void	initColorCodePanel ()

void	initViaSizePanel ()

void	OnCalculateESeries (wxCommandEvent &event) override
	Called on calculate button and executes all E-series calculations. More...

void	OnESeriesSelection (wxCommandEvent &event) override
	Radio Buttons to select the E-serie for the resistor calculator. More...

void	writeTrackWidthConfig ()
	Function writeTrackWidthConfig Write Track width parameters in config. More...

void	OnTWParametersChanged (wxCommandEvent &event) override
	Function OnTWParametersChanged Called when the user changes the general parameters (i.e., anything that is not one of the controlling values). More...

void	OnTWCalculateFromCurrent (wxCommandEvent &event) override
	Function OnTWCalculateFromCurrent Called when the user changes the desired maximum current. More...

void	OnTWCalculateFromExtWidth (wxCommandEvent &event) override
	Function OnTWCalculateFromExtWidth Called when the user changes the desired external trace width. More...

void	OnTWCalculateFromIntWidth (wxCommandEvent &event) override
	Function OnTWCalculateFromIntWidth Called when the user changes the desired internal trace width. More...

void	OnTWResetButtonClick (wxCommandEvent &event) override
	Function OnTWResetButtonClick Called when the user clicks the reset button. More...

double	TWCalculateWidth (double aCurrent, double aThickness, double aDeltaT_C, bool aUseInternalLayer)
	Function TWCalculateWidth Calculate track width required based on given current and temperature rise. More...

double	TWCalculateCurrent (double aWidth, double aThickness, double aDeltaT_C, bool aUseInternalLayer)
	Function TWCalculateCurrent Calculate maximum current based on given width and temperature rise. More...

void	TWDisplayValues (double aCurrent, double aExtWidth, double aIntWidth, double aExtThickness, double aIntThickness)
	Function TWDisplayValues Displays the results of a calculation (including resulting values such as the resistance and power loss). More...

void	TWUpdateModeDisplay ()
	Function TWUpdateModeDisplay Updates the fields to show whether the maximum current, external trace width, or internal trace width is currently the controlling parameter. More...

void	writeViaSizeConfig ()
	Function writeViaSizeConfig Write Via Size parameters in config. More...

void	OnViaCalculate (wxCommandEvent &event) override
	Function OnViaCalculate Called when the user changes any value in the via calcultor. More...

void	OnViaEpsilonR_Button (wxCommandEvent &event) override
	Function OnViaEpsilonR_Button. More...

void	OnViaRho_Button (wxCommandEvent &event) override
	Function OnViaRho_Button. More...

void	onUpdateViaCalcErrorText (wxUpdateUIEvent &event) override
	Update the Error message in Via calculation panel. More...

void	OnViaResetButtonClick (wxCommandEvent &event) override
	Function OnViaResetButtonClick Called when the user clicks the reset button; sets the parameters to their default values. More...

void	VSDisplayValues (double aViaResistance, double aVoltageDrop, double aPowerLoss, double aEstimatedAmpacity, double aThermalResistance, double aCapacitance, double aTimeDegradation, double aInductance, double aReactance)
	Function VSDisplayValues Displays the results of the calculation. More...

void	OnElectricalSpacingUnitsSelection (wxCommandEvent &event) override

void	OnElectricalSpacingRefresh (wxCommandEvent &event) override

void	ElectricalSpacingUpdateData (double aUnitScale)

void	OnTranslineSelection (wxCommandEvent &event) override
	Function OnTranslineSelection Called on new transmission line selection. More...

void	OnTransLineResetButtonClick (wxCommandEvent &event) override
	Function OnTransLineResetButtonClick Called when the user clicks the reset button; sets the parameters to their default values. More...

void	OnTranslineAnalyse (wxCommandEvent &event) override
	Function OnTranslineAnalyse Run a new analyse for the current transline with current parameters and displays the electrical parameters. More...

void	OnTranslineSynthetize (wxCommandEvent &event) override
	Function OnTranslineSynthetize Run a new synthezis for the current transline with current parameters and displays the geometrical parameters. More...

void	OnTranslineEpsilonR_Button (wxCommandEvent &event) override
	Function OnTranslineEpsilonR_Button Shows a list of current relative dielectric constant(Er) and set the selected value in main dialog frame. More...

void	OnTranslineTanD_Button (wxCommandEvent &event) override
	Function OnTranslineTanD_Button Shows a list of current dielectric loss factor (tangent delta) and set the selected value in main dialog frame. More...

void	OnTranslineRho_Button (wxCommandEvent &event) override
	Function OnTranslineRho_Button Shows a list of current Specific resistance list (rho) and set the selected value in main dialog frame. More...

void	TranslineTypeSelection (enum TRANSLINE_TYPE_ID aType)
	Function TranslineTypeSelection Must be called after selection of a new transline. More...

void	TransfDlgDataToTranslineParams ()
	Function TransfDlgDataToTranslineParams Read values entered in dialog frame, and transfert these values in current transline parameters, converted in normalized units. More...

void	OnToleranceSelection (wxCommandEvent &event) override

void	ToleranceSelection (int aSelection)

void	OnAttenuatorSelection (wxCommandEvent &event) override

void	SetAttenuator (unsigned aIdx)

void	OnCalculateAttenuator (wxCommandEvent &event) override

void	TransfPanelDataToAttenuator ()

void	TransfAttenuatorDataToPanel ()

void	TransfAttenuatorResultsToPanel ()

void	OnRegulatorCalcButtonClick (wxCommandEvent &event) override

void	OnRegulatorResetButtonClick (wxCommandEvent &event) override

void	OnRegulTypeSelection (wxCommandEvent &event) override

void	OnRegulatorSelection (wxCommandEvent &event) override

void	OnDataFileSelection (wxCommandEvent &event) override

void	OnAddRegulator (wxCommandEvent &event) override

void	OnEditRegulator (wxCommandEvent &event) override

void	OnRemoveRegulator (wxCommandEvent &event) override

void	RegulatorPageUpdate ()
	Function RegulatorPageUpdate: Update the regulator page dialog display: enable the current regulator drawings and the formula used for calculations. More...

void	SelectLastSelectedRegulator ()
	Function SelectLastSelectedRegulator If m_lastSelectedRegulatorName is empty, just calls RegulatorPageUpdate() More...

void	RegulatorsSolve ()

void	Regulators_WriteConfig (PCB_CALCULATOR_SETTINGS *aCfg)
	Write regulators parameters in config. More...

Private Attributes
bool	m_RegulatorListChanged

enum PCB_CALCULATOR_FRAME:: { ... }	m_TWMode

bool	m_TWNested

enum TRANSLINE_TYPE_ID	m_currTransLineType

TRANSLINE *	m_currTransLine

std::vector< TRANSLINE_IDENT * >	m_transline_list

ATTENUATOR *	m_currAttenuator

std::vector< ATTENUATOR * >	m_attenuator_list

wxString	m_lastSelectedRegulatorName

wxBitmap *	m_ccValueNamesBitmap

wxBitmap *	m_ccValuesBitmap

wxBitmap *	m_ccMultipliersBitmap

wxBitmap *	m_ccTolerancesBitmap

int	m_lastNotebookPage

bool	m_macHack

Detailed Description

Definition at line 41 of file pcb_calculator_frame.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
TW_MASTER_CURRENT
TW_MASTER_EXT_WIDTH
TW_MASTER_INT_WIDTH

Definition at line 370 of file pcb_calculator_frame.h.

     {                            // calculations:
         TW_MASTER_CURRENT,       //   the maximum current,
         TW_MASTER_EXT_WIDTH,     //   the external trace width,
         TW_MASTER_INT_WIDTH      //   or the internal trace width?
     } m_TWMode;

◆ 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

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters

aList	= the UNDO_REDO_CONTAINER of commands.
aItemCount	number of old commands to delete. -1 to remove all old commands this will empty the list of commands.

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 525 of file eda_base_frame.h.

525 { UNDO_LIST, REDO_LIST };

EDA_BASE_FRAME::UNDO_LIST

Definition: eda_base_frame.h:525

EDA_BASE_FRAME::REDO_LIST

Definition: eda_base_frame.h:525

Constructor & Destructor Documentation

◆ PCB_CALCULATOR_FRAME()

PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME	(	KIWAY *	aKiway,
		wxWindow *	aParent
	)

Definition at line 34 of file pcb_calculator_frame.cpp.

                                                                              :
     PCB_CALCULATOR_FRAME_BASE( aParent ),
     m_lastNotebookPage( -1 ),
     m_macHack( true )
 {
     m_bpButtonCalcAtt->SetBitmap( KiBitmap( BITMAPS::small_down ) );
     m_bpButtonAnalyze->SetBitmap( KiBitmap( BITMAPS::small_down ) );
     m_bpButtonSynthetize->SetBitmap( KiBitmap( BITMAPS::small_up ) );
 
     SetKiway( this, aKiway );
     m_currTransLine     = NULL;
     m_currTransLineType = DEFAULT_TYPE;
     m_currAttenuator    = NULL;
     m_RegulatorListChanged = false;
     m_TWMode = TW_MASTER_CURRENT;
     m_TWNested = false;
 
     SHAPE_POLY_SET dummy;   // A ugly trick to force the linker to include
                             // some methods in code and avoid link errors
 
     // Populate transline list ordered like in dialog menu list
     const static TRANSLINE_TYPE_ID tltype_list[8] =
             {
                 MICROSTRIP_TYPE,
                 CPW_TYPE,
                 GROUNDED_CPW_TYPE,
                 RECTWAVEGUIDE_TYPE,
                 COAX_TYPE,
                 C_MICROSTRIP_TYPE,
                 STRIPLINE_TYPE,
                 TWISTEDPAIR_TYPE
             };
 
     for( int ii = 0; ii < 8; ii++ )
         m_transline_list.push_back( new TRANSLINE_IDENT( tltype_list[ii] ) );
 
     // Populate attenuator list ordered like in dialog menu list
     m_attenuator_list.push_back( new ATTENUATOR_PI() );
     m_attenuator_list.push_back( new ATTENUATOR_TEE() );
     m_attenuator_list.push_back( new ATTENUATOR_BRIDGE() );
     m_attenuator_list.push_back( new ATTENUATOR_SPLITTER() );
     m_currAttenuator = m_attenuator_list[0];
 
     wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
     infoFont.SetSymbolicSize( wxFONTSIZE_SMALL );
     m_staticTextAttMsg->SetFont( infoFont );
 
     m_IadjUnitLabel->SetLabel( wxT( "µA" ) );
 
     m_attZinUnit->SetLabel( wxT( "Ω" ) );
     m_attZoutUnit->SetLabel( wxT( "Ω" ) );
     m_attR1Unit->SetLabel( wxT( "Ω" ) );
     m_attR2Unit->SetLabel( wxT( "Ω" ) );
     m_attR3Unit->SetLabel( wxT( "Ω" ) );
 
     m_r1Units->SetLabel( wxT( "kΩ" ) );
     m_r2Units->SetLabel( wxT( "kΩ" ) );
 
     m_reqResUnits->SetLabel( wxT( "kΩ" ) );
     m_exclude1Units->SetLabel( wxT( "kΩ" ) );
     m_exclude2Units->SetLabel( wxT( "kΩ" ) );
 
     m_EpsilonR_label->SetLabel( wxT( "εr" ) );
 
     m_trackTempUnits->SetLabel( wxT( "°C" ) );
     m_resistivityUnits->SetLabel( wxT( "Ω•m" ) );
 
     m_viaResistivityUnits->SetLabel( wxT( "Ω•m" ) );
 
     m_viaTempUnits->SetLabel( wxT( "°C" ) );
     m_viaResUnits->SetLabel( wxT( "Ω" ) );
     m_viaThermalResUnits->SetLabel( wxT( "°C/W" ) );
     m_viaReactanceUnits->SetLabel( wxT( "Ω" ) );
 
     m_extTrackResUnits->SetLabel( wxT( "Ω" ) );
     m_intTrackResUnits->SetLabel( wxT( "Ω" ) );
 
     LoadSettings( config() );
 
     ReadDataFile();
 
     TranslineTypeSelection( m_currTransLineType );
     m_TranslineSelection->SetSelection( m_currTransLineType );
 
     initTrackWidthPanel();
     initColorCodePanel();
     initViaSizePanel();
     initESeriesPanel();
 
     SetAttenuator( m_AttenuatorsSelection->GetSelection() );
 
     ToleranceSelection( m_rbToleranceSelection->GetSelection() );
 
     BoardClassesUpdateData( m_BoardClassesUnitsSelector->GetUnitScale() );
 
     ElectricalSpacingUpdateData( m_ElectricalSpacingUnitsSelector->GetUnitScale() );
 
     m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
     SelectLastSelectedRegulator();
 
     // Give an icon
     wxIcon icon;
     wxIconBundle icon_bundle;
 
     icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbcalculator ) );
     icon_bundle.AddIcon( icon );
     icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbcalculator_32 ) );
     icon_bundle.AddIcon( icon );
     icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbcalculator_16 ) );
     icon_bundle.AddIcon( icon );
 
     SetIcons( icon_bundle );
 
     // Autosize the the row label column to be sure label are not truncated
     m_gridClassesValuesDisplay->SetRowLabelSize( wxGRID_AUTOSIZE );
     m_gridElectricalSpacingValues->SetRowLabelSize( wxGRID_AUTOSIZE );
 
     GetSizer()->SetSizeHints( this );
 
     // Set previous size and position
     SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     if( m_framePos == wxDefaultPosition )
         Centre();
 }

◆ ~PCB_CALCULATOR_FRAME()

PCB_CALCULATOR_FRAME::~PCB_CALCULATOR_FRAME ( )

Definition at line 161 of file pcb_calculator_frame.cpp.

 {
     for( unsigned ii = 0; ii < m_transline_list.size(); ii++ )
         delete m_transline_list[ii];
 
     for( unsigned ii = 0; ii < m_attenuator_list.size(); ii++ )
         delete m_attenuator_list[ii];
 
     delete m_ccValueNamesBitmap;
     delete m_ccValuesBitmap;
     delete m_ccMultipliersBitmap;
     delete m_ccTolerancesBitmap;
 
     // This needed for OSX: avoids furter OnDraw processing after this destructor and before
     // the native window is destroyed
     this->Freeze();
 }

References m_attenuator_list, m_ccMultipliersBitmap, m_ccTolerancesBitmap, m_ccValueNamesBitmap, m_ccValuesBitmap, and m_transline_list.

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 418 of file eda_base_frame.cpp.

 {
     COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
     ACTION_MENU*    helpMenu = new ACTION_MENU( false, commonControl );
 
     helpMenu->Add( ACTIONS::help );
     helpMenu->Add( ACTIONS::gettingStarted );
     helpMenu->Add( ACTIONS::listHotKeys );
     helpMenu->Add( ACTIONS::getInvolved );
     helpMenu->Add( ACTIONS::donate );
     helpMenu->Add( ACTIONS::reportBug );
 
     helpMenu->AppendSeparator();
     helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
     aMenuBar->Append( helpMenu, _( "&Help" ) );
 }

References _, about, ACTIONS::donate, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by EDA_3D_VIEWER::CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ BoardClassesUpdateData()

void PCB_CALCULATOR_FRAME::BoardClassesUpdateData ( double aUnitScale )

Definition at line 91 of file board_classes_values.cpp.

 {
     wxString txt;
     #define FMT wxT("%g")
     #define NOVAL wxT("--")
     for( int ii = 0; ii < BRDCLASS_COUNT; ii ++ )
     {
         // Display min tracks width
         if( clist[ii].m_Lines > -1.0 )
             txt.Printf( FMT, clist[ii].m_Lines / aUnitScale);
         else
             txt = NOVAL;
         m_gridClassesValuesDisplay->SetCellValue(0, ii, txt );
 
         // Display min clearance
         if( clist[ii].m_Clearance > -1.0 )
             txt.Printf( FMT, clist[ii].m_Clearance / aUnitScale);
         else
             txt = NOVAL;
         m_gridClassesValuesDisplay->SetCellValue(1, ii, txt );
 
         // Display min Via diam diff
         if( clist[ii].m_ViaDiamDiff > -1.0 )
             txt.Printf( FMT, clist[ii].m_ViaDiamDiff / aUnitScale);
         else
             txt = NOVAL;
         m_gridClassesValuesDisplay->SetCellValue(2, ii, txt );
 
         // Display min Pad diam diff (plated)
         if( clist[ii].m_PadDiamDiffPlated > -1.0 )
             txt.Printf( FMT, clist[ii].m_PadDiamDiffPlated / aUnitScale);
         else
             txt = NOVAL;
         m_gridClassesValuesDisplay->SetCellValue(3, ii, txt );
 
         // Display min Pad diam diff (non plated)
         if( clist[ii].m_PadDiamDiffNotPlated > -1.0 )
             txt.Printf( FMT, clist[ii].m_PadDiamDiffNotPlated / aUnitScale);
         else
             txt = NOVAL;
         m_gridClassesValuesDisplay->SetCellValue(4, ii, txt );
     }
 }

References BRDCLASS_COUNT, clist, FMT, PCB_CALCULATOR_FRAME_BASE::m_gridClassesValuesDisplay, and NOVAL.

Referenced by OnBoardClassesUnitsSelection(), and PCB_CALCULATOR_FRAME().

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

inlineprotectedvirtualinherited

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, SIM_PLOT_FRAME, CVPCB_MAINFRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 607 of file eda_base_frame.h.

607 { return true; }

Referenced by EDA_BASE_FRAME::windowClosing().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1093 of file eda_base_frame.cpp.

 {
     SetUserUnits( aUnits );
     unitsChangeRefresh();
 
     wxCommandEvent e( UNITS_CHANGED );
     ProcessEventLocally( e );
 }

References EDA_BASE_FRAME::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

inherited

Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters

aFileName A wxFileName object containing the file name to check.

Definition at line 981 of file eda_base_frame.cpp.

 {
     wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
     wxFileName autoSaveFileName = aFileName;
 
     // Check for auto save file.
     autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
 
     wxLogTrace( traceAutoSave,
                 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
     if( !autoSaveFileName.FileExists() )
         return;
 
     wxString msg = wxString::Format( _(
             "Well this is potentially embarrassing!\n"
             "It appears that the last time you were editing the file\n"
             "\"%s\"\n"
             "it was not saved properly.  Do you wish to restore the last saved edits you made?" ),
             aFileName.GetFullName()
         );
 
     int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
                                  this );
 
     // Make a backup of the current file, delete the file, and rename the auto save file to
     // the file name.
     if( response == wxYES )
     {
         if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
         {
             wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
                           Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
         }
     }
     else
     {
         wxLogTrace( traceAutoSave,
                     wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
         // Remove the auto save file when using the previous file as is.
         wxRemoveFile( autoSaveFileName.GetFullPath() );
     }
 }

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

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

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY * aFileHistory = nullptr )

inherited

Removes all files from the file history.

Parameters

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 878 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     aFileHistory->ClearFileHistory();
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList	(	UNDO_REDO_LIST	aList,
		int	aItemCount = `-1`
	)

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, PL_EDITOR_FRAME, SYMBOL_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 526 of file eda_base_frame.h.

527 { }

Referenced by EDA_BASE_FRAME::ClearUndoRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), and EDA_BASE_FRAME::PushCommandToUndoList().

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1044 of file eda_base_frame.cpp.

 {
     ClearUndoORRedoList( UNDO_LIST );
     ClearUndoORRedoList( REDO_LIST );
 }

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewPageLayout(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void EDA_BASE_FRAME::CommonSettingsChanged	(	bool	aEnvVarsChanged,
		bool	aTextVarsChanged
	)

overridevirtualinherited

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from TOOLS_HOLDER.

Reimplemented in PCB_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, EDA_DRAW_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 447 of file eda_base_frame.cpp.

 {
     TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
     COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 
     if( m_fileHistory )
     {
         int historySize = settings->m_System.file_history_size;
         m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
     }
 
     if( GetBitmapStore()->ThemeChanged() )
     {
         ThemeChanged();
     }
 
     if( GetMenuBar() )
     {
         // For icons in menus, icon scaling & hotkeys
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References TOOLS_HOLDER::CommonSettingsChanged(), COMMON_SETTINGS::SYSTEM::file_history_size, GetBitmapStore(), EDA_BASE_FRAME::m_fileHistory, COMMON_SETTINGS::m_System, Pgm(), EDA_BASE_FRAME::ReCreateMenuBar(), FILE_HISTORY::SetMaxFiles(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_3D_VIEWER::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), and KIWAY::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 719 of file eda_base_frame.cpp.

 {
     // KICAD_MANAGER_FRAME overrides this
     return Kiface().KifaceSettings();
 }

References Kiface(), and KIFACE_I::KifaceSettings().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single configuration can be used.

Returns: a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 339 of file eda_base_frame.h.

     {
         wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
         return baseCfgName;
     }

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 744 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_infoBar = new WX_INFOBAR( GetToolCanvas() );
 #else
     m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
     m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
 #endif
 }

References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 99 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return ACTIONS::selectionTool.GetName();
     else
         return m_toolStack.back();
 }

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 150 of file kiway_player.cpp.

 {
     return EDA_BASE_FRAME::Destroy();
 }

◆ DismissModal()

void KIWAY_PLAYER::DismissModal	(	bool	aRetVal,
		const wxString &	aResult = `wxEmptyString`
	)

inherited

Definition at line 161 of file kiway_player.cpp.

 {
     m_modal_ret_val = aRetVal;
     m_modal_string  = aResult;
 
     if( m_modal_loop )
     {
         m_modal_loop->Exit();
         m_modal_loop = nullptr;      // this marks it as dismissed.
     }
 
     Show( false );
 }

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().

◆ DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString & msg )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 122 of file tools_holder.h.

122 {};

Referenced by TOOLS_HOLDER::PopTool(), and TOOLS_HOLDER::PushTool().

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

This should be overridden by the derived class to handle the auto save feature.

Returns: true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 301 of file eda_base_frame.cpp.

 {
     wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden.  Bad programmer!" ) );
 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

virtual void EDA_BASE_FRAME::doCloseWindow ( )

inlineprotectedvirtualinherited

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, SIM_PLOT_FRAME, CVPCB_MAINFRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_WIZARD_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_EDIT_FRAME, GERBVIEW_FRAME, KICAD_MANAGER_FRAME, PCB_BASE_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 608 of file eda_base_frame.h.

608 { }

Referenced by EDA_BASE_FRAME::windowClosing().

◆ ElectricalSpacingUpdateData()

void PCB_CALCULATOR_FRAME::ElectricalSpacingUpdateData ( double aUnitScale )

private

Definition at line 116 of file electrical_spacing_values.cpp.

 {
     wxString txt;
     double voltage = 500.0;     // to calculate values at V > 500V
     txt = m_ElectricalSpacingVoltage->GetValue();
 
     if( ! txt.IsEmpty() )
         voltage = DoubleFromString(txt);
 
     if( voltage < 500.0 )
         voltage = 500.0;
 
     txt.Printf( wxT( "%g" ), voltage );
     m_ElectricalSpacingVoltage->SetValue( txt );
 
     for( int ii = 0; ii < CLASS_COUNT-1; ii++ )
     {
         for( int jj = 0; jj < VALUE_COUNT; jj++ )
         {
             txt.Printf( wxT( "%g" ), clist[ii][jj] / aUnitScale );
             m_gridElectricalSpacingValues->SetCellValue( ii, jj, txt );
         }
     }
 
     for( int jj = 0; jj < VALUE_COUNT; jj++ )
     {
         double spacing = clist[CLASS_COUNT-2][jj];
         double spacing_extra = clist[CLASS_COUNT-1][jj];
         spacing += spacing_extra * ( voltage - 500.0 );
         txt.Printf( wxT( "%g" ), spacing / aUnitScale );
         m_gridElectricalSpacingValues->SetCellValue( CLASS_COUNT-1, jj, txt );
     }
 
     m_gridElectricalSpacingValues->SetRowLabelSize( wxGRID_AUTOSIZE );
 }

References CLASS_COUNT, clist, DoubleFromString(), PCB_CALCULATOR_FRAME_BASE::m_ElectricalSpacingVoltage, PCB_CALCULATOR_FRAME_BASE::m_gridElectricalSpacingValues, and VALUE_COUNT.

Referenced by OnElectricalSpacingRefresh(), OnElectricalSpacingUnitsSelection(), and PCB_CALCULATOR_FRAME().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 756 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_auimgr.Update();
 #else
     // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
     // hiding it.
     m_auimgr.Update();
 
     // We don't want the infobar displayed right away
     m_auimgr.GetPane( "InfoBar" ).Hide();
     m_auimgr.Update();
 #endif
 }

References EDA_BASE_FRAME::m_auimgr.

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 494 of file eda_base_frame.h.

494 { return m_aboutTitle; }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:670

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and COMMON_CONTROL::ReportBug().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

Returns: the string to prepend to a file name for automatic save.

Definition at line 583 of file eda_base_frame.h.

     {
         return wxT( "_autosave-" );
     }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

Definition: eda_base_frame.h:686

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns: the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 420 of file eda_base_frame.h.

420 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_VIEWER_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, DISPLAY_FOOTPRINTS_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 102 of file tools_holder.h.

     {
         return m_dummySelection;
     }

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDataFilename()

const wxString PCB_CALCULATOR_FRAME::GetDataFilename ( )

private

Returns: the full filename of the selected pcb_calculator data file

Definition at line 394 of file pcb_calculator_frame.cpp.

 {
     if( m_regulators_fileNameCtrl->GetValue().IsEmpty() )
         return wxEmptyString;
 
     wxFileName fn( m_regulators_fileNameCtrl->GetValue() );
     fn.SetExt( DataFileNameExt );
     return fn.GetFullPath();
 }

References DataFileNameExt(), and PCB_CALCULATOR_FRAME_BASE::m_regulators_fileNameCtrl.

Referenced by OnClosePcbCalc(), OnDataFileSelection(), and Regulators_WriteConfig().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

Indicate that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 128 of file tools_holder.h.

128 { return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:170

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 134 of file tools_holder.h.

134 { return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:174

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory	(	int	cmdId,
		const wxString &	type,
		FILE_HISTORY *	aFileHistory = `nullptr`
	)

inherited

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.

Parameters

cmdId	The command ID associated with the aFileHistory object.
type	Please document me!
aFileHistory	The FILE_HISTORY in use. If null, the main application file history is used

Returns: a wxString containing the selected filename

Definition at line 838 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     int baseId = aFileHistory->GetBaseId();
 
     wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
 
     unsigned i = cmdId - baseId;
 
     if( i < aFileHistory->GetCount() )
     {
         wxString fn = aFileHistory->GetHistoryFile( i );
 
         if( wxFileName::FileExists( fn ) )
             return fn;
         else
         {
             wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
             wxMessageBox( msg );
 
             aFileHistory->RemoveFileFromHistory( i );
         }
     }
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 
     return wxEmptyString;
 }

References _, Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )

inlineinherited

Get the frame's main file history.

Returns: the main file history

Definition at line 404 of file eda_base_frame.h.

     {
         return *m_fileHistory;
     }

References EDA_BASE_FRAME::m_fileHistory.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 193 of file eda_base_frame.h.

193 { return m_ident; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:661

References EDA_BASE_FRAME::m_ident.

◆ GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

Returns: the WX_INFOBAR that can be displayed on the top of the canvas.

Definition at line 216 of file eda_base_frame.h.

216 { return m_infoBar; }

EDA_BASE_FRAME::m_infoBar

WX_INFOBAR * m_infoBar

Definition: eda_base_frame.h:675

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibraryPartAux(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurPart(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), and SCH_DRAWING_TOOLS::SingleClickPlace().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 563 of file eda_base_frame.h.

563 { return m_undoRedoCountMax; }

EDA_BASE_FRAME::m_undoRedoCountMax

int m_undoRedoCountMax

Definition: eda_base_frame.h:689

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

Indicate that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are allergic to mouse warping.

Definition at line 140 of file tools_holder.h.

140 { return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:176

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SYMBOL_EDITOR_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 411 of file eda_base_frame.h.

411 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:694

References EDA_BASE_FRAME::m_mruPath.

Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveEEFile(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ GetPrmValue()

double PCB_CALCULATOR_FRAME::GetPrmValue ( enum PRMS_ID aPrmId ) const

Function GetPrmValue Returns a param value.

Parameters

aPrmId = param id to write

Returns: the value always in normalized unit (meter, Hz, Ohm, radian)

Definition at line 139 of file params_read_write.cpp.

 {
     TRANSLINE_IDENT* tr_ident = m_transline_list[m_currTransLineType];
     for( unsigned ii = 0; ii < tr_ident->GetPrmsCount(); ii++ )
     {
         TRANSLINE_PRM* prm = tr_ident->GetPrm( ii );
         if( aPrmId == prm->m_Id )
             return prm->m_NormalizedValue;
     }
     return 1.0;
 }

References TRANSLINE_IDENT::GetPrm(), TRANSLINE_IDENT::GetPrmsCount(), m_currTransLineType, TRANSLINE_PRM::m_Id, TRANSLINE_PRM::m_NormalizedValue, and m_transline_list.

Referenced by GetPropertyInDialog().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 561 of file eda_base_frame.h.

561 { return m_redoList.m_CommandsList.size(); }

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:310

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:692

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), and EDITOR_CONDITIONS::redoFunc().

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 128 of file eda_base_frame.h.

128 { return m_settingsManager; }

EDA_BASE_FRAME::m_settingsManager

SETTINGS_MANAGER * m_settingsManager

Definition: eda_base_frame.h:680

References EDA_BASE_FRAME::m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::Save_File(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

130 { return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

Definition: ui_common.h:84

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow* PCB_CALCULATOR_FRAME::GetToolCanvas ( ) const

inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 361 of file pcb_calculator_frame.h.

     {
         return nullptr;
     }

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

55 { return m_toolManager; }

TOOLS_HOLDER::m_toolManager

TOOL_MANAGER * m_toolManager

Definition: tools_holder.h:157

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::doGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), ROUTER_TOOL::InlineBreakTrack(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), DIALOG_INSPECTION_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ 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().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 560 of file eda_base_frame.h.

560 { return m_undoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:691

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:310

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inlineinherited

Return the user units currently in use.

Definition at line 114 of file eda_base_frame.h.

     {
         return m_userUnits;
     }

References EDA_BASE_FRAME::m_userUnits.

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters

aCfg	is this frame's config object

Reimplemented in FOOTPRINT_WIZARD_FRAME, SIM_PLOT_FRAME, FOOTPRINT_VIEWER_FRAME, SYMBOL_VIEWER_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 713 of file eda_base_frame.cpp.

 {
     return &aCfg->m_Window;
 }

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns: the undecorated window size

Definition at line 1125 of file eda_base_frame.cpp.

 {
 #ifdef __WXGTK__
     // GTK includes the window decorations in the normal GetSize call,
     // so we have to use a GTK-specific sizing call that returns the
     // non-decorated window size.
     int width  = 0;
     int height = 0;
     GTKDoGetSize( &width, &height );
 
     wxSize winSize( width, height );
 #else
     wxSize winSize = GetSize();
 #endif
 
     return winSize;
 }

Referenced by EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

Update the UI in response to a change in the system colors.

Definition at line 1144 of file eda_base_frame.cpp.

 {
     // Update the icon theme when the system theme changes and update the toolbars
     if( GetBitmapStore()->ThemeChanged() )
         ThemeChanged();
 
     // This isn't handled by ThemeChanged()
     if( GetMenuBar() )
     {
         // For icons in menus, icon scaling & hotkeys
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent	(	wxUpdateUIEvent &	aEvent,
		EDA_BASE_FRAME *	aFrame,
		ACTION_CONDITIONS	aCond
	)

staticinherited

Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters

aEvent	is the wxUpdateUIEvent to be processed.
aFrame	is the frame to get the selection from
aCond	are the #UI SELECTION_CONDITIONS used

Definition at line 350 of file eda_base_frame.cpp.

 {
     bool       checkRes  = false;
     bool       enableRes = true;
     bool       showRes   = true;
     SELECTION& selection = aFrame->GetCurrentSelection();
 
     try
     {
         checkRes  = aCond.checkCondition( selection );
         enableRes = aCond.enableCondition( selection );
         showRes   = aCond.showCondition( selection );
     }
     catch( std::exception& )
     {
         // Something broke with the conditions, just skip the event.
         aEvent.Skip();
         return;
     }
 
     aEvent.Enable( enableRes );
     aEvent.Show( showRes );
 
     // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
     // checked, since wxMenuItems don't want to be checked unless they actually are checkable
 #if wxCHECK_VERSION( 3, 1, 5 )
     if( aEvent.IsCheckable() )
         aEvent.Check( checkRes );
 #else
     bool canCheck = true;
 
     // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
     // see if they can be and can't just universally apply a check in this event.
     if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
         canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
 
     if( canCheck )
         aEvent.Check( checkRes );
 #endif
 }

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 732 of file eda_base_frame.cpp.

 {
     return Kiface().GetHelpFileName();
 }

References KIFACE_I::GetHelpFileName(), and Kiface().

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile	(	std::map< std::string, TOOL_ACTION * >	aActionMap,
		const wxString &	aDefaultShortname
	)

inherited

Prompt the user for a hotkey file to read, and read it.

Parameters

aActionMap	current hotkey map (over which the imported hotkeys will be applied).
aDefaultShortname	a default short name (extension not needed) like Eeschema, KiCad...

◆ initColorCodePanel()

void PCB_CALCULATOR_FRAME::initColorCodePanel ( )

private

Definition at line 27 of file colorcode.cpp.

 {
     m_ccValueNamesBitmap  = KiBitmapNew( BITMAPS::color_code_value_and_name );
     m_ccValuesBitmap      = KiBitmapNew( BITMAPS::color_code_value );
     m_ccMultipliersBitmap = KiBitmapNew( BITMAPS::color_code_multiplier );
     m_ccTolerancesBitmap  = KiBitmapNew( BITMAPS::color_code_tolerance );
 }

References color_code_multiplier, color_code_tolerance, color_code_value, color_code_value_and_name, KiBitmapNew(), m_ccMultipliersBitmap, m_ccTolerancesBitmap, m_ccValueNamesBitmap, and m_ccValuesBitmap.

Referenced by PCB_CALCULATOR_FRAME().

◆ initESeriesPanel()

void PCB_CALCULATOR_FRAME::initESeriesPanel ( )

private

Definition at line 394 of file eserie.cpp.

 {
     wxString msg;
 
     // show markdown formula explanation in lower help panel
     ConvertMarkdown2Html( wxGetTranslation( eseries_help ), msg );
     m_panelESeriesHelp->SetPage( msg );
 }

References ConvertMarkdown2Html(), eseries_help, and PCB_CALCULATOR_FRAME_BASE::m_panelESeriesHelp.

Referenced by PCB_CALCULATOR_FRAME().

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )

protectedinherited

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1035 of file eda_base_frame.cpp.

 {
     wxAcceleratorEntry entries[1];
     entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
     wxAcceleratorTable accel( 1, entries );
     SetAcceleratorTable( accel );
 }

◆ initTrackWidthPanel()

void PCB_CALCULATOR_FRAME::initTrackWidthPanel ( )

private

Panel-specific initializers.

Definition at line 420 of file tracks_width_versus_current.cpp.

 {
     wxString msg;
 
     // Disable calculations while we initialise.
     m_TWNested = true;
 
     // Read parameter values.
     auto cfg = static_cast<PCB_CALCULATOR_SETTINGS*>( Kiface().KifaceSettings() );
 
     m_TrackCurrentValue->SetValue( cfg->m_TrackWidth.current );
     m_TrackDeltaTValue->SetValue( cfg->m_TrackWidth.delta_tc );
     m_TrackLengthValue->SetValue( cfg->m_TrackWidth.track_len );
     m_TW_CuLength_choiceUnit->SetSelection( cfg->m_TrackWidth.track_len_units );
 #if 0   // the IPC formula is valid for copper traces, so we do not currently adjust the resistivity
     m_TWResistivity->SetValue( cfg->m_TrackWidth.resistivity );
 #else
     m_TWResistivity->SetValue( wxString::Format( "%g", copper_resistivity ) );
 #endif
     m_ExtTrackWidthValue->SetValue( cfg->m_TrackWidth.ext_track_width );
     m_TW_ExtTrackWidth_choiceUnit->SetSelection( cfg->m_TrackWidth.ext_track_width_units );
     m_ExtTrackThicknessValue->SetValue( cfg->m_TrackWidth.ext_track_thickness );
     m_ExtTrackThicknessUnit->SetSelection( cfg->m_TrackWidth.ext_track_thickness_units );
     m_IntTrackWidthValue->SetValue( cfg->m_TrackWidth.int_track_width );
     m_TW_IntTrackWidth_choiceUnit->SetSelection( cfg->m_TrackWidth.int_track_width_units );
     m_IntTrackThicknessValue->SetValue( cfg->m_TrackWidth.int_track_thickness );
     m_IntTrackThicknessUnit->SetSelection( cfg->m_TrackWidth.int_track_thickness_units );
 
     if( tracks_width_versus_current_formula.StartsWith( "<!" ) )
         m_htmlWinFormulas->SetPage( tracks_width_versus_current_formula );
     else
     {
         wxString html_txt;
         ConvertMarkdown2Html( wxGetTranslation( tracks_width_versus_current_formula ), html_txt );
         m_htmlWinFormulas->SetPage( html_txt );
     }
 
     // Make sure the correct master mode is displayed.
     TWUpdateModeDisplay();
 
     // Enable calculations and perform the initial one.
     m_TWNested = false;
     wxCommandEvent dummy;
     OnTWParametersChanged( dummy );
 }

Referenced by PCB_CALCULATOR_FRAME().

◆ initViaSizePanel()

void PCB_CALCULATOR_FRAME::initViaSizePanel ( )

private

Definition at line 127 of file via.cpp.

 {
     auto cfg = static_cast<PCB_CALCULATOR_SETTINGS*>( Kiface().KifaceSettings() );
 
     m_textCtrlHoleDia->SetValue( cfg->m_ViaSize.hole_diameter );
     m_choiceHoleDia->SetSelection( cfg->m_ViaSize.hole_diameter_units );
 
     m_textCtrlPlatingThickness->SetValue( cfg->m_ViaSize.thickness );
     m_choicePlatingThickness->SetSelection( cfg->m_ViaSize.thickness_units );
 
     m_textCtrlViaLength->SetValue( cfg->m_ViaSize.length );
     m_choiceViaLength->SetSelection( cfg->m_ViaSize.length_units );
 
     m_textCtrlViaPadDia->SetValue( cfg->m_ViaSize.pad_diameter );
     m_choiceViaPadDia->SetSelection( cfg->m_ViaSize.pad_diameter_units );
 
     m_textCtrlClearanceDia->SetValue( cfg->m_ViaSize.clearance_diameter );
     m_choiceClearanceDia->SetSelection( cfg->m_ViaSize.clearance_diameter_units );
 
     m_textCtrlImpedance->SetValue( cfg->m_ViaSize.characteristic_impedance );
     m_choiceImpedance->SetSelection( cfg->m_ViaSize.characteristic_impedance_units );
 
     m_textCtrlAppliedCurrent->SetValue( cfg->m_ViaSize.applied_current );
     m_textCtrlPlatingResistivity->SetValue( cfg->m_ViaSize.plating_resistivity );
     m_textCtrlPlatingPermittivity->SetValue( cfg->m_ViaSize.permittivity );
     m_textCtrlTemperatureDiff->SetValue( cfg->m_ViaSize.temp_rise );
     m_textCtrlRiseTime->SetValue( cfg->m_ViaSize.pulse_rise_time );
 }

Referenced by PCB_CALCULATOR_FRAME().

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences	(	PAGED_DIALOG *	,
		PANEL_HOTKEYS_EDITOR *
	)

inlinevirtualinherited

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters

aParent a paged dialog into which the preference panels should be installed.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 279 of file eda_base_frame.h.

279 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 598 of file eda_base_frame.h.

598 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )

virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns: true if the contents of the frame have not been saved

Reimplemented in SCH_EDIT_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 1028 of file eda_base_frame.cpp.

 {
     // This function should be overridden in child classes
     return false;
 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION & aAction ) const

inherited

Definition at line 108 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return &aAction == &ACTIONS::selectionTool;
     else
         return m_toolStack.back() == aAction.GetName();
 }

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by BOARD_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

Returns: false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 155 of file kiway_player.cpp.

 {
     return !m_modal_loop;
 }

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 170 of file kiway_player.h.

170 { return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:193

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsPrmSelected()

bool PCB_CALCULATOR_FRAME::IsPrmSelected ( enum PRMS_ID aPrmId ) const

Function IsPrmSelected.

Returns: true if the param aPrmId is selected Has meaning only for params that have a radio button

Definition at line 241 of file params_read_write.cpp.

 {
     switch( aPrmId )
     {
     default:
         wxMessageBox( wxT( "IsPrmSelected() error" ) );
         break;
 
     case PHYS_WIDTH_PRM:
     case PHYS_DIAM_IN_PRM:
         return m_radioBtnPrm1->GetValue();
         break;
 
     case PHYS_S_PRM:
     case PHYS_DIAM_OUT_PRM:
         return m_radioBtnPrm2->GetValue();
         break;
     }
     return false;
 }

References PCB_CALCULATOR_FRAME_BASE::m_radioBtnPrm1, PCB_CALCULATOR_FRAME_BASE::m_radioBtnPrm2, PHYS_DIAM_IN_PRM, PHYS_DIAM_OUT_PRM, PHYS_S_PRM, and PHYS_WIDTH_PRM.

Referenced by IsSelectedInDialog().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 192 of file eda_base_frame.h.

192 { return m_ident == aType; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:661

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName & aFileName )

inherited

Checks if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

Note: The file name path must be set or an assertion will be raised on debug builds and return false on release builds.

Parameters

aFileName The full path and/or file name of the file to test.

Returns: False if aFileName cannot be written.

Definition at line 937 of file eda_base_frame.cpp.

 {
     wxString msg;
     wxFileName fn = aFileName;
 
     // Check for absence of a file path with a file name.  Unfortunately KiCad
     // uses paths relative to the current project path without the ./ part which
     // confuses wxFileName. Making the file name path absolute may be less than
     // elegant but it solves the problem.
     if( fn.GetPath().IsEmpty() && fn.HasName() )
         fn.MakeAbsolute();
 
     wxCHECK_MSG( fn.IsOk(), false,
                  wxT( "File name object is invalid.  Bad programmer!" ) );
     wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
                  wxT( "File name object path <" ) + fn.GetFullPath() +
                  wxT( "> is not set.  Bad programmer!" ) );
 
     if( fn.IsDir() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
                     fn.GetPath() );
     }
     else if( !fn.FileExists() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
                     fn.GetFullName(), fn.GetPath() );
     }
     else if( fn.FileExists() && !fn.IsFileWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
                     fn.GetFullPath() );
     }
 
     if( !msg.IsEmpty() )
     {
         wxMessageBox( msg );
         return false;
     }
 
     return true;
 }

References _.

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ 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.

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

 {
     // logging support
     KiwayMailIn( aEvent );     // call the virtual, override in derived.
 }

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, and CVPCB_MAINFRAME.

Definition at line 70 of file kiway_player.cpp.

 {
     // override this in derived classes.
 }

Referenced by KIWAY_PLAYER::kiway_express(), and KIWAY::ProcessEvent().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

 {
     int id = event.GetId();
 
     // tell all the KIWAY_PLAYERs about the language change.
     Kiway().SetLanguage( id );
 }

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

◆ LoadSettings()

void PCB_CALCULATOR_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overrideprivatevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 281 of file pcb_calculator_frame.cpp.

 {
     if( aCfg == NULL )
         return;
 
     EDA_BASE_FRAME::LoadSettings( aCfg );
 
     PCB_CALCULATOR_SETTINGS* cfg = static_cast<PCB_CALCULATOR_SETTINGS*>( aCfg );
 
     m_currTransLineType = static_cast<TRANSLINE_TYPE_ID>( cfg->m_TransLine.type );
     m_Notebook->ChangeSelection( cfg->m_LastPage );
     m_rbToleranceSelection->SetSelection( cfg->m_ColorCodeTolerance );
     m_AttenuatorsSelection->SetSelection( cfg->m_Attenuators.type );
     m_BoardClassesUnitsSelector->SetSelection( cfg->m_BoardClassUnits );
 
     // Regul panel config:
     m_RegulR1Value->SetValue( cfg->m_Regulators.r1 );
     m_RegulR2Value->SetValue( cfg->m_Regulators.r2 );
     m_RegulVrefValue->SetValue( cfg->m_Regulators.vref );
     m_RegulVoutValue->SetValue( cfg->m_Regulators.vout );
     SetDataFilename( cfg->m_Regulators.data_file );
     m_lastSelectedRegulatorName = cfg->m_Regulators.selected_regulator;
     m_choiceRegType->SetSelection( cfg->m_Regulators.type );
 
     wxRadioButton* regprms[3] = { m_rbRegulR1, m_rbRegulR2, m_rbRegulVout };
 
     if( cfg->m_Regulators.last_param >= 3 )
         cfg->m_Regulators.last_param = 0;
 
     for( int ii = 0; ii < 3; ii++ )
         regprms[ii]->SetValue( cfg->m_Regulators.last_param == ii );
 
     // Electrical panel config
     m_ElectricalSpacingUnitsSelector->SetSelection( cfg->m_Electrical.spacing_units );
     m_ElectricalSpacingVoltage->SetValue( cfg->m_Electrical.spacing_voltage );
 
     for( TRANSLINE_IDENT* transline : m_transline_list )
         transline->ReadConfig();
 
     for( ATTENUATOR* attenuator : m_attenuator_list )
         attenuator->ReadConfig();
 }

Referenced by PCB_CALCULATOR_FRAME().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

Load window settings from the given settings object.

Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 613 of file eda_base_frame.cpp.

 {
     LoadWindowState( aCfg->state );
 
     if( m_hasAutoSave )
         m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
 
     m_perspective = aCfg->perspective;
     m_mruPath = aCfg->mru_path;
 
     TOOLS_HOLDER::CommonSettingsChanged( false, false );
 }

References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 488 of file eda_base_frame.cpp.

 {
     if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
         return;
 
     const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
 
     if( state != nullptr )
     {
         LoadWindowState( state->window );
     }
 }

References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowSettings(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 502 of file eda_base_frame.cpp.

 {
     bool wasDefault = false;
 
     m_framePos.x  = aState.pos_x;
     m_framePos.y  = aState.pos_y;
     m_frameSize.x = aState.size_x;
     m_frameSize.y = aState.size_y;
 
     wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // Ensure minimum size is set if the stored config was zero-initialized
     if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
     {
         m_frameSize = defaultSize( m_ident );
         wasDefault  = true;
 
         wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
     }
 
     wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
 
     if( aState.display >= wxDisplay::GetCount() )
     {
         wxLogTrace( traceDisplayLocation, "Previous display not found" );
 
         // If it isn't attached, use the first display
         // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
         const unsigned int index = 0;
         wxDisplay display( index );
         wxRect    clientSize = display.GetGeometry();
 
         m_framePos = wxDefaultPosition;
 
         // Ensure the window fits on the display, since the other one could have been larger
         if( m_frameSize.x > clientSize.width )
             m_frameSize.x = clientSize.width;
 
         if( m_frameSize.y > clientSize.height )
             m_frameSize.y = clientSize.height;
     }
     else
     {
         wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
         wxPoint upperLeft( m_framePos.x, m_framePos.y );
 
         wxDisplay display( aState.display );
         wxRect clientSize = display.GetClientArea();
 
 #ifndef _WIN32
         // The percentage size (represented in decimal) of the region around the screen's border where
         // an upper corner is not allowed
         #define SCREEN_BORDER_REGION 0.10
 #else
         // Windows uses a very rectangular clearly defined display region, there is no ambigious "screen border region"
         // GetClientArea already accounts for the taskbar stealing display space
         #define SCREEN_BORDER_REGION 0
 #endif
 
         int yLimTop   = clientSize.y + ( clientSize.height * ( SCREEN_BORDER_REGION ) );
         int yLimBottom = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
         int xLimLeft  = clientSize.x + ( clientSize.width  * SCREEN_BORDER_REGION );
         int xLimRight = clientSize.x + ( clientSize.width  * ( 1.0 - SCREEN_BORDER_REGION ) );
 
         if( upperLeft.x  > xLimRight ||  // Upper left corner too close to right edge of screen
             upperRight.x < xLimLeft  ||  // Upper right corner too close to left edge of screen
             upperLeft.y < yLimTop ||   // Upper corner too close to the bottom of the screen
             upperLeft.y > yLimBottom )
         {
             m_framePos = wxDefaultPosition;
             wxLogTrace( traceDisplayLocation, "Resetting to default position" );
         }
     }
 
     // Ensure Window title bar is visible
 #if defined( __WXOSX__ )
     // for macOSX, the window must be below system (macOSX) toolbar
     int Ypos_min = 20;
 #else
     int Ypos_min = 0;
 #endif
     if( m_framePos.y < Ypos_min )
         m_framePos.y = Ypos_min;
 
     wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // Center the window if we reset to default
     if( m_framePos.x == -1 )
     {
         wxLogTrace( traceDisplayLocation, "Centering window" );
         Center();
         m_framePos = GetPosition();
     }
 
     // Record the frame sizes in an un-maximized state
     m_normalFrameSize = m_frameSize;
     m_normalFramePos  = m_framePos;
 
     // Maximize if we were maximized before
     if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
     {
         wxLogTrace( traceDisplayLocation, "Maximizing window" );
         Maximize();
     }
 }

References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 565 of file eda_base_frame.h.

     {
         m_isNonUserClose = true;
         return Close( aForce );
     }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ OnAddRegulator()

void PCB_CALCULATOR_FRAME::OnAddRegulator ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 167 of file regulators_funct.cpp.

 {
     DIALOG_REGULATOR_FORM dlg( this, wxEmptyString );
     if( dlg.ShowModal() != wxID_OK )
         return;
     if( !dlg.IsOK() )
     {
         wxMessageBox( _("Bad or missing parameters!") );
         return;
     }
 
     REGULATOR_DATA * new_item = dlg.BuildRegulatorFromData();
 
     // Add new item, if not existing
     if( m_RegulatorList.GetReg( new_item->m_Name ) == NULL )
     {
         // Add item in list
         m_RegulatorList.Add( new_item );
         m_RegulatorListChanged = true;
         m_choiceRegulatorSelector->Clear();
         m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
         m_lastSelectedRegulatorName = new_item->m_Name;
         SelectLastSelectedRegulator();
     }
     else
     {
         wxMessageBox( _("This regulator is already in list. Aborted") );
         delete new_item;
     }
 }

References _, REGULATOR_LIST::Add(), DIALOG_REGULATOR_FORM::BuildRegulatorFromData(), REGULATOR_LIST::GetReg(), REGULATOR_LIST::GetRegList(), DIALOG_REGULATOR_FORM::IsOK(), PCB_CALCULATOR_FRAME_BASE::m_choiceRegulatorSelector, m_lastSelectedRegulatorName, REGULATOR_DATA::m_Name, m_RegulatorList, m_RegulatorListChanged, NULL, and SelectLastSelectedRegulator().

◆ OnAttenuatorSelection()

void PCB_CALCULATOR_FRAME::OnAttenuatorSelection ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 37 of file attenuators.cpp.

 {
     SetAttenuator( (unsigned) event.GetSelection() );
     Refresh();
 }

References Refresh(), and SetAttenuator().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 294 of file eda_base_frame.cpp.

 {
     if( !doAutoSave() )
         m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
 }

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnBoardClassesUnitsSelection()

void PCB_CALCULATOR_FRAME::OnBoardClassesUnitsSelection ( wxCommandEvent & event )

overridevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 86 of file board_classes_values.cpp.

 {
     BoardClassesUpdateData( m_BoardClassesUnitsSelector->GetUnitScale() );
 }

References BoardClassesUpdateData(), UNIT_SELECTOR_LEN::GetUnitScale(), and PCB_CALCULATOR_FRAME_BASE::m_BoardClassesUnitsSelector.

◆ OnCalculateAttenuator()

void PCB_CALCULATOR_FRAME::OnCalculateAttenuator ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 58 of file attenuators.cpp.

 {
     TransfPanelDataToAttenuator();
     m_currAttenuator->Calculate();
     TransfAttenuatorResultsToPanel();
 }

References ATTENUATOR::Calculate(), m_currAttenuator, TransfAttenuatorResultsToPanel(), and TransfPanelDataToAttenuator().

◆ OnCalculateESeries()

void PCB_CALCULATOR_FRAME::OnCalculateESeries ( wxCommandEvent & event )

overrideprivatevirtual

Called on calculate button and executes all E-series calculations.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 289 of file eserie.cpp.

 {
     double   reqr;            // required resistor stored in local copy
     double   error, err3 = 0;
     wxString es, fs;          // error and formula strings
 
     reqr = ( 1000 * DoubleFromString( m_ResRequired->GetValue() ) );
     r.SetRequiredValue( reqr ); // keep a local copy of requred resistor value
     r.NewCalc();     // assume all values available
     /*
      * Exclude itself. For the case, a value from the available series is found as required value,
      * the calculator assumes this value needs a replacement for the reason of being not available.
      * Two further exclude values can be entered to exclude and are skipped as not being availabe.
      * All values entered in KiloOhms are converted to Ohm for internal calculation
      */
     r.Exclude( 1000 * DoubleFromString( m_ResRequired->GetValue()));
     r.Exclude( 1000 * DoubleFromString( m_ResExclude1->GetValue()));
     r.Exclude( 1000 * DoubleFromString( m_ResExclude2->GetValue()));
     r.Calculate();
 
     fs = r.get_rslt()[S2R].e_name;               // show 2R solution formula string
     m_ESeries_Sol2R->SetValue( fs );
     error = reqr + r.get_rslt()[S2R].e_value;    // absolute value of solution
     error = ( reqr / error - 1 ) * 100;          // error in percent
 
     if( error )
     {
         if( std::abs( error ) < 0.01 )
             es.Printf( "<%.2f", 0.01 );
         else
             es.Printf( "%+.2f",error);
     }
     else
     {
         es = _( "Exact" );
     }
 
     m_ESeriesError2R->SetValue( es );            // anyway show 2R error string
 
     if( r.get_rslt()[S3R].e_use )                // if 3R solution available
     {
         err3 = reqr + r.get_rslt()[S3R].e_value; // calculate the 3R
         err3 = ( reqr / err3 - 1 ) * 100;        // error in percent
 
         if( err3 )
         {
             if( std::abs( err3 ) < 0.01 )
                 es.Printf( "<%.2f", 0.01 );
             else
                 es.Printf( "%+.2f",err3);
         }
         else
         {
             es = _( "Exact" );
         }
 
         m_ESeriesError3R->SetValue( es );         // show 3R error string
         fs = r.get_rslt()[S3R].e_name;
         m_ESeries_Sol3R->SetValue( fs );         // show 3R formula string
     }
     else                                         // nothing better than 2R found
     {
         fs = _( "Not worth using" );
         m_ESeries_Sol3R->SetValue( fs );
         m_ESeriesError3R->SetValue( wxEmptyString );
     }
 
     fs = wxEmptyString;
 
     if( r.get_rslt()[S4R].e_use )                 // show 4R solution if available
     {
         fs = r.get_rslt()[S4R].e_name;
 
         error = reqr + r.get_rslt()[S4R].e_value; // absolute value of solution
         error = ( reqr / error - 1 ) * 100;       // error in percent
 
         if( error )
             es.Printf( "%+.2f",error );
         else
             es = _( "Exact" );
 
         m_ESeriesError4R->SetValue( es );
     }
     else                                          // no 4R solution
     {
         fs = _( "Not worth using" );
         es = wxEmptyString;
         m_ESeriesError4R->SetValue( es );
     }
 
     m_ESeries_Sol4R->SetValue( fs );
 }

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 307 of file eda_base_frame.cpp.

 {
     wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
 
     // Key events can be filtered here.
     // Currently no filtering is made.
     aKeyEvent.Skip();
 }

References dump(), and kicadTraceKeyEvent.

◆ OnClosePcbCalc()

void PCB_CALCULATOR_FRAME::OnClosePcbCalc ( wxCloseEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 248 of file pcb_calculator_frame.cpp.

 {
     if( m_RegulatorListChanged )
     {
         wxString msg;
         wxString title = _( "Write Data Failed" );
 
         if( GetDataFilename().IsEmpty() )
         {
             msg = _( "No data filename to save modifications.\n"
                      "Do you want to exit and abandon your changes?" );
 
             if( wxMessageBox( msg, title, wxYES_NO | wxICON_QUESTION ) == wxNO )
                 return;
         }
         else
         {
             if( !WriteDataFile() )
             {
                 msg.Printf( _( "Unable to write file '%s'\n"
                                "Do you want to exit and abandon your changes?"),
                             GetDataFilename() );
 
                 if( wxMessageBox( msg, title, wxYES_NO | wxICON_ERROR ) == wxNO )
                     return;
             }
         }
     }
 
     event.Skip();
 }

References _, GetDataFilename(), m_RegulatorListChanged, and WriteDataFile().

◆ OnDataFileSelection()

void PCB_CALCULATOR_FRAME::OnDataFileSelection ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 121 of file regulators_funct.cpp.

 {
     wxString fullfilename = GetDataFilename();
 
     wxString wildcard;
     wildcard.Printf( _("PCB Calculator data file (*.%s)|*.%s"),
                      DataFileNameExt, DataFileNameExt );
 
     wxFileDialog dlg( m_panelRegulators,
                       _("Select PCB Calculator Data File"),
                       wxEmptyString, fullfilename,
                       wildcard, wxFD_OPEN );
 
     if (dlg.ShowModal() == wxID_CANCEL)
         return;
 
     fullfilename = dlg.GetPath();
 
     if( fullfilename == GetDataFilename() )
         return;
 
     SetDataFilename( fullfilename );
     if( wxFileExists( fullfilename ) && m_RegulatorList.GetCount() > 0 )  // Read file
     {
         if( wxMessageBox( _("Do you want to load this file and replace current regulator list?" ) )
                          != wxID_OK )
             return;
     }
 
     if( ReadDataFile() )
     {
         m_RegulatorListChanged = false;
         m_choiceRegulatorSelector->Clear();
         m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
         SelectLastSelectedRegulator();
     }
 
     else
     {
         wxString msg;
         msg.Printf( _("Unable to read data file \"%s\""), fullfilename );
         wxMessageBox( msg );
     }
 }

References _, DataFileNameExt, REGULATOR_LIST::GetCount(), GetDataFilename(), REGULATOR_LIST::GetRegList(), PCB_CALCULATOR_FRAME_BASE::m_choiceRegulatorSelector, PCB_CALCULATOR_FRAME_BASE::m_panelRegulators, m_RegulatorList, m_RegulatorListChanged, ReadDataFile(), SelectLastSelectedRegulator(), and SetDataFilename().

◆ OnEditRegulator()

void PCB_CALCULATOR_FRAME::OnEditRegulator ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 199 of file regulators_funct.cpp.

 {
     wxString name = m_choiceRegulatorSelector->GetStringSelection();
     REGULATOR_DATA * item  = m_RegulatorList.GetReg( name );
     if( item == NULL )
         return;
 
     DIALOG_REGULATOR_FORM dlg( this, name );
 
     dlg.CopyRegulatorDataToDialog( item );
     if( dlg.ShowModal() != wxID_OK )
         return;
 
     REGULATOR_DATA * new_item = dlg.BuildRegulatorFromData();
     m_RegulatorList.Replace( new_item );
 
     m_RegulatorListChanged = true;
 
     SelectLastSelectedRegulator();
 }

References DIALOG_REGULATOR_FORM::BuildRegulatorFromData(), DIALOG_REGULATOR_FORM::CopyRegulatorDataToDialog(), REGULATOR_LIST::GetReg(), PCB_CALCULATOR_FRAME_BASE::m_choiceRegulatorSelector, m_RegulatorList, m_RegulatorListChanged, name, NULL, REGULATOR_LIST::Replace(), and SelectLastSelectedRegulator().

◆ OnElectricalSpacingRefresh()

void PCB_CALCULATOR_FRAME::OnElectricalSpacingRefresh ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 110 of file electrical_spacing_values.cpp.

 {
     ElectricalSpacingUpdateData( m_ElectricalSpacingUnitsSelector->GetUnitScale() );
 }

References ElectricalSpacingUpdateData(), UNIT_SELECTOR_LEN::GetUnitScale(), and PCB_CALCULATOR_FRAME_BASE::m_ElectricalSpacingUnitsSelector.

◆ OnElectricalSpacingUnitsSelection()

void PCB_CALCULATOR_FRAME::OnElectricalSpacingUnitsSelection ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 105 of file electrical_spacing_values.cpp.

 {
     ElectricalSpacingUpdateData( m_ElectricalSpacingUnitsSelector->GetUnitScale() );
 }

References ElectricalSpacingUpdateData(), UNIT_SELECTOR_LEN::GetUnitScale(), and PCB_CALCULATOR_FRAME_BASE::m_ElectricalSpacingUnitsSelector.

◆ OnESeriesSelection()

void PCB_CALCULATOR_FRAME::OnESeriesSelection ( wxCommandEvent & event )

overrideprivatevirtual

Radio Buttons to select the E-serie for the resistor calculator.

Parameters

event contains the radio button state

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 382 of file eserie.cpp.

 {
     if( event.GetEventObject() == m_e1 )
         r.SetSeries( E1 );
     else if( event.GetEventObject() == m_e3 )
         r.SetSeries( E3 );
     else if( event.GetEventObject() == m_e12 )
         r.SetSeries( E12 );
     else
         r.SetSeries( E6 );
 }

References E1, E12, E3, E6, PCB_CALCULATOR_FRAME_BASE::m_e1, PCB_CALCULATOR_FRAME_BASE::m_e12, PCB_CALCULATOR_FRAME_BASE::m_e3, and eserie::SetSeries().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 896 of file eda_base_frame.cpp.

 {
     void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
     ShowAboutDialog( this );
 }

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1103 of file eda_base_frame.cpp.

 {
     // When we maximize the window, we want to save the old information
     // so that we can add it to the settings on next window load.
     // Contrary to the documentation, this event seems to be generated
     // when the window is also being unmaximized on OSX, so we only
     // capture the size information when we maximize the window when on OSX.
 #ifdef __WXOSX__
     if( !IsMaximized() )
 #endif
     {
         m_normalFrameSize = GetWindowSize();
         m_normalFramePos  = GetPosition();
         wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
                     m_normalFramePos.x, m_normalFramePos.y, m_normalFrameSize.x, m_normalFrameSize.y );
     }
 
     // Skip event to actually maximize the window
     aEvent.Skip();
 }

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, and traceDisplayLocation.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 317 of file eda_base_frame.cpp.

 {
     if( !m_toolDispatcher )
         aEvent.Skip();
     else
         m_toolDispatcher->DispatchWxEvent( aEvent );
 }

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 181 of file eda_base_frame.h.

     {
         aEvent.Skip();
     }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 903 of file eda_base_frame.cpp.

 {
     PAGED_DIALOG dlg( this, _( "Preferences" ), true );
     wxTreebook* book = dlg.GetTreebook();
 
     book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
 
     book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
 
     PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
     book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
 
     for( unsigned i = 0; i < KIWAY_PLAYER_COUNT;  ++i )
     {
         KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
 
         if( frame )
             frame->InstallPreferences( &dlg, hotkeysPanel );
     }
 
     // The Kicad manager frame is not a player so we have to add it by hand
     wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
 
     if( manager )
         static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
 
     for( size_t i = 0; i < book->GetPageCount(); ++i )
         book->GetPage( i )->Layout();
 
     if( dlg.ShowModal() == wxID_OK )
         dlg.Kiway().CommonSettingsChanged( false, false );
 }

References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, and KIWAY::Player().

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

◆ OnRegulatorCalcButtonClick()

void PCB_CALCULATOR_FRAME::OnRegulatorCalcButtonClick ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 39 of file regulators_funct.cpp.

 {
     RegulatorsSolve();
 }

References RegulatorsSolve().

◆ OnRegulatorResetButtonClick()

void PCB_CALCULATOR_FRAME::OnRegulatorResetButtonClick ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 45 of file regulators_funct.cpp.

 {
     m_RegulR1Value->SetValue( wxT( "10" ) );
     m_RegulR2Value->SetValue( wxT( "10" ) );
     m_RegulVrefValue->SetValue( wxT( "3" ) );
     m_RegulVoutValue->SetValue( wxT( "12" ) );
     m_choiceRegType->SetSelection( 0 );
     m_rbRegulR1->SetValue(1);
     m_rbRegulR2->SetValue(0);
     m_rbRegulVout->SetValue(0);
     RegulatorPageUpdate();
 }

References PCB_CALCULATOR_FRAME_BASE::m_choiceRegType, PCB_CALCULATOR_FRAME_BASE::m_rbRegulR1, PCB_CALCULATOR_FRAME_BASE::m_rbRegulR2, PCB_CALCULATOR_FRAME_BASE::m_rbRegulVout, PCB_CALCULATOR_FRAME_BASE::m_RegulR1Value, PCB_CALCULATOR_FRAME_BASE::m_RegulR2Value, PCB_CALCULATOR_FRAME_BASE::m_RegulVoutValue, PCB_CALCULATOR_FRAME_BASE::m_RegulVrefValue, and RegulatorPageUpdate().

◆ OnRegulatorSelection()

void PCB_CALCULATOR_FRAME::OnRegulatorSelection ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 96 of file regulators_funct.cpp.

 {
     wxString name = m_choiceRegulatorSelector->GetStringSelection();
     REGULATOR_DATA * item = m_RegulatorList.GetReg( name );
     if( item )
     {
         m_lastSelectedRegulatorName = item->m_Name;
         m_choiceRegType->SetSelection( item->m_Type );
         wxString value;
         value.Printf( wxT("%g"), item->m_Vref );
         m_RegulVrefValue->SetValue( value );
         value.Printf( wxT("%g"), item->m_Iadj );
         m_RegulIadjValue->SetValue( value );
     }
 
     // Call RegulatorPageUpdate to enable/sisable tools,
     // even if no item selected
     RegulatorPageUpdate();
 }

References REGULATOR_LIST::GetReg(), PCB_CALCULATOR_FRAME_BASE::m_choiceRegType, PCB_CALCULATOR_FRAME_BASE::m_choiceRegulatorSelector, REGULATOR_DATA::m_Iadj, m_lastSelectedRegulatorName, REGULATOR_DATA::m_Name, m_RegulatorList, PCB_CALCULATOR_FRAME_BASE::m_RegulIadjValue, PCB_CALCULATOR_FRAME_BASE::m_RegulVrefValue, REGULATOR_DATA::m_Type, REGULATOR_DATA::m_Vref, name, and RegulatorPageUpdate().

Referenced by SelectLastSelectedRegulator().

◆ OnRegulTypeSelection()

void PCB_CALCULATOR_FRAME::OnRegulTypeSelection ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 90 of file regulators_funct.cpp.

 {
     RegulatorPageUpdate();
 }

References RegulatorPageUpdate().

◆ OnRemoveRegulator()

void PCB_CALCULATOR_FRAME::OnRemoveRegulator ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 221 of file regulators_funct.cpp.

 {
     wxString name = wxGetSingleChoice( _("Remove Regulator"), wxEmptyString,
                                        m_RegulatorList.GetRegList() );
     if( name.IsEmpty() )
         return;
 
     m_RegulatorList.Remove( name );
     m_RegulatorListChanged = true;
     m_choiceRegulatorSelector->Clear();
     m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
     if( m_lastSelectedRegulatorName == name )
         m_lastSelectedRegulatorName.Empty();
 
     SelectLastSelectedRegulator();
 }

References _, REGULATOR_LIST::GetRegList(), PCB_CALCULATOR_FRAME_BASE::m_choiceRegulatorSelector, m_lastSelectedRegulatorName, m_RegulatorList, m_RegulatorListChanged, name, REGULATOR_LIST::Remove(), and SelectLastSelectedRegulator().

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1160 of file eda_base_frame.cpp.

 {
     // Call the handler to update the colors used in the frame
     HandleSystemColorChange();
 
     // Skip the change event to ensure the rest of the window controls get it
     aEvent.Skip();
 }

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnToleranceSelection()

void PCB_CALCULATOR_FRAME::OnToleranceSelection ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 36 of file colorcode.cpp.

 {
     ToleranceSelection( event.GetSelection() );
 }

References ToleranceSelection().

◆ OnTranslineAnalyse()

void PCB_CALCULATOR_FRAME::OnTranslineAnalyse ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTranslineAnalyse Run a new analyse for the current transline with current parameters and displays the electrical parameters.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 366 of file pcb_calculator_frame.cpp.

 {
     if( m_currTransLine )
     {
         TransfDlgDataToTranslineParams();
         m_currTransLine->analyze();
     }
 }

References TRANSLINE::analyze(), m_currTransLine, and TransfDlgDataToTranslineParams().

◆ OnTranslineEpsilonR_Button()

void PCB_CALCULATOR_FRAME::OnTranslineEpsilonR_Button ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTranslineEpsilonR_Button Shows a list of current relative dielectric constant(Er) and set the selected value in main dialog frame.

Function OnEpsilonR_Button Shows a list of current relative dielectric constant(Er) and set the selected value in main dialog frame.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 116 of file transline_dlg_funct.cpp.

 {
     wxArrayString list = StandardRelativeDielectricConstantList();
     list.Add( "" );  // Add an empty line for no selection
 
     // Find the previous choice index:
     wxString prevChoiceStr = m_Value_EpsilonR->GetValue();
     int prevChoice = 0;
     findMatch( list, prevChoiceStr, prevChoice );
 
     int index = wxGetSingleChoiceIndex( wxEmptyString, _( "Relative Dielectric Constants" ),
                                         list, prevChoice );
 
     if( index >= 0 && !list.Item( index ).IsEmpty() )   // i.e. non canceled.
         m_Value_EpsilonR->SetValue( list.Item( index ).BeforeFirst( ' ' ) );
 }

References _, findMatch(), PCB_CALCULATOR_FRAME_BASE::m_Value_EpsilonR, and StandardRelativeDielectricConstantList().

◆ OnTransLineResetButtonClick()

void PCB_CALCULATOR_FRAME::OnTransLineResetButtonClick ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTransLineResetButtonClick Called when the user clicks the reset button; sets the parameters to their default values.

Function OnTransLineResetButtonClick Called when the user clicks the reset button.

This sets the parameters to their default values.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 462 of file transline_dlg_funct.cpp.

 {
     TranslineTypeSelection( DEFAULT_TYPE );
     m_TranslineSelection->SetSelection( DEFAULT_TYPE );
 
     m_panelTransline->GetSizer()->Layout();
     m_panelTransline->Refresh();
 }

References DEFAULT_TYPE, PCB_CALCULATOR_FRAME_BASE::m_panelTransline, PCB_CALCULATOR_FRAME_BASE::m_TranslineSelection, and TranslineTypeSelection().

◆ OnTranslineRho_Button()

void PCB_CALCULATOR_FRAME::OnTranslineRho_Button ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTranslineRho_Button Shows a list of current Specific resistance list (rho) and set the selected value in main dialog frame.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 162 of file transline_dlg_funct.cpp.

 {
     wxArrayString list = StandardResistivityList();
     list.Add( "" );  // Add an empty line for no selection
 
     // Find the previous choice index:
     wxString prevChoiceStr = m_Value_Rho->GetValue();
     int prevChoice = 0;
     findMatch( list, prevChoiceStr, prevChoice );
 
     int index = wxGetSingleChoiceIndex( wxEmptyString, _( "Specific Resistance" ), list,
                                         prevChoice, NULL );
 
     if( index >= 0 && !list.Item( index ).IsEmpty() )   // i.e. non canceled.
         m_Value_Rho->SetValue( list.Item( index ).BeforeFirst( ' ' ) );
 }

References _, findMatch(), PCB_CALCULATOR_FRAME_BASE::m_Value_Rho, NULL, and StandardResistivityList().

◆ OnTranslineSelection()

void PCB_CALCULATOR_FRAME::OnTranslineSelection ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTranslineSelection Called on new transmission line selection.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 444 of file transline_dlg_funct.cpp.

 {
     enum TRANSLINE_TYPE_ID id = (enum TRANSLINE_TYPE_ID) event.GetSelection();
 
     TranslineTypeSelection( id );
 
     // Texts and units choice widgets can have their size modified:
     // The new size must be taken in account
     m_panelTransline->GetSizer()->Layout();
     m_panelTransline->Refresh();
 }

References PCB_CALCULATOR_FRAME_BASE::m_panelTransline, and TranslineTypeSelection().

◆ OnTranslineSynthetize()

void PCB_CALCULATOR_FRAME::OnTranslineSynthetize ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTranslineSynthetize Run a new synthezis for the current transline with current parameters and displays the geometrical parameters.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 381 of file pcb_calculator_frame.cpp.

 {
     if( m_currTransLine )
     {
         TransfDlgDataToTranslineParams();
         m_currTransLine->synthesize();
     }
 }

References m_currTransLine, TRANSLINE::synthesize(), and TransfDlgDataToTranslineParams().

◆ OnTranslineTanD_Button()

void PCB_CALCULATOR_FRAME::OnTranslineTanD_Button ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTranslineTanD_Button Shows a list of current dielectric loss factor (tangent delta) and set the selected value in main dialog frame.

Function OnTanD_Button Shows a list of current dielectric loss factor (tangent delta) and set the selected value in main dialog frame.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 139 of file transline_dlg_funct.cpp.

 {
     wxArrayString list = StandardLossTangentList();
     list.Add( "" );  // Add an empty line for no selection
 
     // Find the previous choice index:
     wxString prevChoiceStr = m_Value_TanD->GetValue();
     int prevChoice = 0;
     findMatch( list, prevChoiceStr, prevChoice );
 
     int index = wxGetSingleChoiceIndex( wxEmptyString, _( "Dielectric Loss Factor" ), list,
                                         prevChoice, NULL );
 
     if( index >= 0 && !list.Item( index ).IsEmpty() )   // i.e. non canceled.
         m_Value_TanD->SetValue( list.Item( index ).BeforeFirst( ' ' ) );
 }

References _, findMatch(), PCB_CALCULATOR_FRAME_BASE::m_Value_TanD, NULL, and StandardLossTangentList().

◆ OnTWCalculateFromCurrent()

void PCB_CALCULATOR_FRAME::OnTWCalculateFromCurrent ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTWCalculateFromCurrent Called when the user changes the desired maximum current.

This sets the current as the controlling value and performs the calculations.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 85 of file tracks_width_versus_current.cpp.

 {
     // Setting the calculated values generates further events. Stop them.
     if( m_TWNested )
     {
         event.StopPropagation();
         return;
     }
 
     m_TWNested = true;
 
     // Update state.
     if( m_TWMode != TW_MASTER_CURRENT )
     {
         m_TWMode = TW_MASTER_CURRENT;
         TWUpdateModeDisplay();
     }
 
     // Prepare parameters:
     double current      = std::abs( DoubleFromString( m_TrackCurrentValue->GetValue() ) );
     double extThickness = std::abs( DoubleFromString( m_ExtTrackThicknessValue->GetValue() ) );
     double intThickness = std::abs( DoubleFromString( m_IntTrackThicknessValue->GetValue() ) );
     double deltaT_C     = std::abs( DoubleFromString( m_TrackDeltaTValue->GetValue() ) );
 
     // Normalize by units.
     extThickness *= m_ExtTrackThicknessUnit->GetUnitScale();
     intThickness *= m_IntTrackThicknessUnit->GetUnitScale();
 
     // Calculate the widths.
     double extTrackWidth = TWCalculateWidth( current, extThickness, deltaT_C, false );
     double intTrackWidth = TWCalculateWidth( current, intThickness, deltaT_C, true );
 
     // Update the display.
     TWDisplayValues( current, extTrackWidth, intTrackWidth, extThickness, intThickness );
 
     // Re-enable the events.
     m_TWNested = false;
 }

References DoubleFromString(), UNIT_SELECTOR_THICKNESS::GetUnitScale(), PCB_CALCULATOR_FRAME_BASE::m_ExtTrackThicknessUnit, PCB_CALCULATOR_FRAME_BASE::m_ExtTrackThicknessValue, PCB_CALCULATOR_FRAME_BASE::m_IntTrackThicknessUnit, PCB_CALCULATOR_FRAME_BASE::m_IntTrackThicknessValue, PCB_CALCULATOR_FRAME_BASE::m_TrackCurrentValue, PCB_CALCULATOR_FRAME_BASE::m_TrackDeltaTValue, m_TWMode, m_TWNested, TW_MASTER_CURRENT, TWCalculateWidth(), TWDisplayValues(), and TWUpdateModeDisplay().

Referenced by OnTWParametersChanged().

◆ OnTWCalculateFromExtWidth()

void PCB_CALCULATOR_FRAME::OnTWCalculateFromExtWidth ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTWCalculateFromExtWidth Called when the user changes the desired external trace width.

This sets the external width as the controlling value and performs the calculations.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 125 of file tracks_width_versus_current.cpp.

 {
     // Setting the calculated values generates further events. Stop them.
     if( m_TWNested )
     {
         event.StopPropagation();
         return;
     }
     m_TWNested = true;
 
     // Update state.
     if( m_TWMode != TW_MASTER_EXT_WIDTH )
     {
         m_TWMode = TW_MASTER_EXT_WIDTH;
         TWUpdateModeDisplay();
     }
 
     // Load parameters.
     double current;
     double extThickness  = std::abs( DoubleFromString( m_ExtTrackThicknessValue->GetValue() ) );
     double intThickness  = std::abs( DoubleFromString( m_IntTrackThicknessValue->GetValue() ) );
     double deltaT_C      = std::abs( DoubleFromString( m_TrackDeltaTValue->GetValue() ) );
     double extTrackWidth = std::abs( DoubleFromString( m_ExtTrackWidthValue->GetValue() ) );
     double intTrackWidth;
 
     // Normalize units.
     extThickness  *= m_ExtTrackThicknessUnit->GetUnitScale();
     intThickness  *= m_IntTrackThicknessUnit->GetUnitScale();
     extTrackWidth *= m_TW_ExtTrackWidth_choiceUnit->GetUnitScale();
 
     // Calculate the maximum current.
     current = TWCalculateCurrent( extTrackWidth, extThickness, deltaT_C, false );
 
     // And now calculate the corresponding internal width.
     intTrackWidth = TWCalculateWidth( current, intThickness, deltaT_C, true );
 
     // Update the display.
     TWDisplayValues( current, extTrackWidth, intTrackWidth, extThickness, intThickness );
 
     // Re-enable the events.
     m_TWNested = false;
 }

References DoubleFromString(), UNIT_SELECTOR_LEN::GetUnitScale(), UNIT_SELECTOR_THICKNESS::GetUnitScale(), PCB_CALCULATOR_FRAME_BASE::m_ExtTrackThicknessUnit, PCB_CALCULATOR_FRAME_BASE::m_ExtTrackThicknessValue, PCB_CALCULATOR_FRAME_BASE::m_ExtTrackWidthValue, PCB_CALCULATOR_FRAME_BASE::m_IntTrackThicknessUnit, PCB_CALCULATOR_FRAME_BASE::m_IntTrackThicknessValue, PCB_CALCULATOR_FRAME_BASE::m_TrackDeltaTValue, PCB_CALCULATOR_FRAME_BASE::m_TW_ExtTrackWidth_choiceUnit, m_TWMode, m_TWNested, TW_MASTER_EXT_WIDTH, TWCalculateCurrent(), TWCalculateWidth(), TWDisplayValues(), and TWUpdateModeDisplay().

Referenced by OnTWParametersChanged().

◆ OnTWCalculateFromIntWidth()

void PCB_CALCULATOR_FRAME::OnTWCalculateFromIntWidth ( wxCommandEvent & event )

overrideprivatevirtual

Function OnTWCalculateFromIntWidth Called when the user changes the desired internal trace width.

This sets the internal width as the controlling value and performs the calculations.

Reimplemented from PCB_CALCULATOR_FRAME_BASE.

Definition at line 169 of file tracks_width_versus_current.cpp.

 {
     // Setting the calculated values generates further events. Stop them.
     if( m_TWNested )
     {
         event.StopPropagation();
         return;
     }
 
     m_TWNested = true;
 
     // Update state.
     if( m_TWMode != TW_MASTER_INT_WIDTH )
     {
         m_TWMode = TW_MASTER_INT_WIDTH;
         TWUpdateModeDisplay();
     }
 
     // Load parameters.
     double current;
     double extThickness  = std::abs( DoubleFromString( m_ExtTrackThicknessValue->GetValue() ) );
     double intThickness  = std::abs( DoubleFromString( m_IntTrackThicknessValue->GetValue() ) );
     double deltaT_C      = std::abs( DoubleFromString( m_TrackDeltaTValue->GetValue() ) );
     double extTrackWidth;
     double intTrackWidth = std::abs( DoubleFromString( m_IntTrackWidthValue->GetValue() ) );
 
     // Normalize units.
     extThickness  *= m_ExtTrackThicknessUnit->GetUnitScale();
     intThickness  *= m_IntTrackThicknessUnit->GetUnitScale();
     intTrackWidth *= m_TW_IntTrackWidth_choiceUnit->GetUnitScale();
 
     // Calculate the maximum current.
     current = TWCalculateCurrent( intTrackWidth, intThickness, deltaT_C, true );
 
     // And now calculate the corresponding external width.
     extTrackWidth = TWCalculateWidth( current, extThickness, deltaT_C, false );
 
     // Update the display.
     TWDisplayValues( current, extTrackWidth, intTrackWidth, extThickness, intThickness );
 
     // Re-enable the events.
     m_TWNested = false;
 }

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ PCB_CALCULATOR_FRAME()

◆ ~PCB_CALCULATOR_FRAME()

Member Function Documentation

◆ AddStandardHelpMenu()

◆ BoardClassesUpdateData()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateInfoBar()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ ElectricalSpacingUpdateData()

◆ FinishAUIInitialization()

◆ GetAboutTitle()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDataFilename()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFrameType()

◆ GetInfoBar()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetPrmValue()

◆ GetRedoCommandCount()

◆ GetSettingsManager()

◆ GetSeverity()

◆ GetToolCanvas()

◆ GetToolManager()

◆ GetType()

◆ GetUndoCommandCount()

◆ GetUserUnits()

◆ GetWindowSettings()

◆ GetWindowSize()

◆ HandleSystemColorChange()

◆ HandleUpdateUIEvent()

◆ help_name()

◆ ImportHotkeyConfigFromFile()

◆ initColorCodePanel()

◆ initESeriesPanel()

◆ initExitKey()

◆ initTrackWidthPanel()

◆ initViaSizePanel()

◆ InstallPreferences()

◆ isAutoSaveRequired()

◆ IsContentModified()

◆ IsCurrentTool()

◆ IsDismissed()