PGM_KICAD extends PGM_BASE to bring in FileHistory() and PdfBrowser() which were moved from EDA_APP into KIFACE_BASE. More...

#include <pgm_kicad.h>

Inheritance diagram for PGM_KICAD:

Public Member Functions
	PGM_KICAD ()

	~PGM_KICAD () throw ()

bool	OnPgmInit ()

void	OnPgmExit ()

int	OnPgmRun ()

void	MacOpenFile (const wxString &aFileName) override
	Specific to MacOSX (not used under Linux or Windows). More...

APP_SETTINGS_BASE *	PgmSettings ()

SEARCH_STACK &	SysSearch ()

wxString	GetHelpFileName ()

void	Destroy ()

void	BuildArgvUtf8 ()
	Builds the UTF8 based argv variable. More...

virtual SETTINGS_MANAGER &	GetSettingsManager () const

virtual COMMON_SETTINGS *	GetCommonSettings () const

virtual BACKGROUND_JOBS_MONITOR &	GetBackgroundJobMonitor () const

virtual NOTIFICATIONS_MANAGER &	GetNotificationsManager () const

virtual void	SetTextEditor (const wxString &aFileName)

virtual const wxString &	GetTextEditor (bool aCanShowFileChooser=true)
	Return the path to the preferred text editor application. More...

virtual const wxString	AskUserForPreferredEditor (const wxString &aDefaultEditor=wxEmptyString)
	Shows a dialog that instructs the user to select a new preferred editor. More...

virtual bool	IsKicadEnvVariableDefined () const

virtual const wxString &	GetKicadEnvVariable () const

virtual const wxString &	GetExecutablePath () const

virtual wxLocale *	GetLocale ()

virtual const wxString &	GetPdfBrowserName () const

virtual void	SetPdfBrowserName (const wxString &aFileName)

virtual bool	UseSystemPdfBrowser () const

virtual void	ForceSystemPdfBrowser (bool aFlg)
	Force the use of system PDF browser, even if a preferred PDF browser is set. More...

virtual bool	SetLanguage (wxString &aErrMsg, bool first_time=false)
	Set the dictionary file name for internationalization. More...

bool	SetDefaultLanguage (wxString &aErrMsg)
	Set the default language without reference to any preferences. More...

virtual void	SetLanguageIdentifier (int menu_id)
	Set in .m_language_id member the wxWidgets language identifier ID from the KiCad menu id (internal menu identifier). More...

virtual int	GetSelectedLanguageIdentifier () const

virtual wxString	GetLanguageTag ()

virtual void	SetLanguagePath ()

virtual void	ReadPdfBrowserInfos ()
	Read the PDF browser choice from the common configuration. More...

virtual void	WritePdfBrowserInfos ()
	Save the PDF browser choice to the common configuration. More...

virtual bool	SetLocalEnvVariable (const wxString &aName, const wxString &aValue)
	Sets the environment variable aName to aValue. More...

virtual void	SetLocalEnvVariables ()
	Updates the local environment with the contents of the current ENV_VAR_MAP stored in the COMMON_SETTINGS. More...

virtual ENV_VAR_MAP &	GetLocalEnvVariables () const

virtual wxApp &	App ()
	Returns a bare naked wxApp which may come from wxPython, SINGLE_TOP, or kicad.exe. More...

bool	InitPgm (bool aHeadless=false, bool aSkipPyInit=false, bool aIsUnitTest=false)
	Initialize this program. More...

void	SaveCommonSettings ()
	Save the program (process) settings subset which are stored .kicad_common. More...

void	HandleException (std::exception_ptr aPtr)
	A exception handler to be used at the top level if exceptions bubble up that for. More...

void	HandleAssert (const wxString &aFile, int aLine, const wxString &aFunc, const wxString &aCond, const wxString &aMsg)
	A common assert handler to be used between single_top and kicad. More...

bool	IsGUI ()
	Determine if the application is running with a GUI. More...

void	ShowSplash ()

void	HideSplash ()

std::unique_ptr< wxSingleInstanceChecker > &	SingleInstance ()
	Allows access to the wxSingleInstanceChecker to test for other running KiCads. More...

Public Attributes
bool	m_Printing
	wxWidgets on MSW tends to crash if you spool up more than one print job at a time. More...

std::vector< void * >	m_ModalDialogs

bool	m_Quitting

Static Public Attributes
static const wxChar	workingDirKey []

Protected Member Functions
void	loadCommonSettings ()
	Loads internal settings from COMMON_SETTINGS. More...

void	setLanguageId (int aId)
	Trap all changes in here, simplifies debugging. More...

Protected Attributes
BIN_MOD	m_bm

std::unique_ptr< SETTINGS_MANAGER >	m_settings_manager

std::unique_ptr< BACKGROUND_JOBS_MONITOR >	m_background_jobs_monitor

std::unique_ptr< NOTIFICATIONS_MANAGER >	m_notifications_manager

std::unique_ptr< SCRIPTING >	m_python_scripting

std::unique_ptr< wxSingleInstanceChecker >	m_pgm_checker
	Checks if there is another copy of Kicad running at the same time. More...

wxString	m_kicad_env

wxLocale *	m_locale
	The KICAD system environment variable. More...

int	m_language_id

bool	m_use_system_pdf_browser

wxString	m_pdf_browser

wxString	m_text_editor
	Filename of the app selected for browsing PDFs. More...

char **	m_argvUtf8

int	m_argcUtf8
	argv parameters converted to utf8 form, because wxwidgets has opinions and will return argv as either force converted to ascii in char* or wchar_t only More...

wxSplashScreen *	m_splash

Detailed Description

PGM_KICAD extends PGM_BASE to bring in FileHistory() and PdfBrowser() which were moved from EDA_APP into KIFACE_BASE.

KIFACE_BASE is not applicable in the project manager since it is not a KIFACE. This header is in the kicad directory since nobody else needs to know about it.

Definition at line 37 of file pgm_kicad.h.

Constructor & Destructor Documentation

◆ PGM_KICAD()

PGM_KICAD::PGM_KICAD ( )

inline

Definition at line 40 of file pgm_kicad.h.

◆ ~PGM_KICAD()

PGM_KICAD::~PGM_KICAD	(	)
throw	(
	)

inline

Definition at line 44 of file pgm_kicad.h.

References Destroy().

Member Function Documentation

◆ App()

wxApp & PGM_BASE::App ( )

virtualinherited

Returns a bare naked wxApp which may come from wxPython, SINGLE_TOP, or kicad.exe.

This should return what wxGetApp() returns.

Definition at line 175 of file pgm_base.cpp.

Referenced by PGM_BASE::BuildArgvUtf8(), PGM_BASE::InitPgm(), PGM_SINGLE_TOP::MacOpenFile(), MacOpenFile(), PGM_TEST_FRAME::MacOpenFile(), and OnPgmInit().

◆ AskUserForPreferredEditor()

const wxString PGM_BASE::AskUserForPreferredEditor ( const wxString & aDefaultEditor = wxEmptyString )

virtualinherited

Shows a dialog that instructs the user to select a new preferred editor.

Parameters

aDefaultEditor Default full path for the default editor this dialog should show by default.

Returns: Returns the full path of the editor, or an empty string if no editor was chosen.

Definition at line 225 of file pgm_base.cpp.

References _, name, and path.

Referenced by PGM_BASE::GetTextEditor().

◆ BuildArgvUtf8()

void PGM_BASE::BuildArgvUtf8 ( )

inherited

Builds the UTF8 based argv variable.

Definition at line 404 of file pgm_base.cpp.

References PGM_BASE::App(), PGM_BASE::m_argcUtf8, and PGM_BASE::m_argvUtf8.

◆ Destroy()

void PGM_KICAD::Destroy ( )

Definition at line 397 of file kicad.cpp.

References PGM_BASE::Destroy(), BIN_MOD::End(), and m_bm.

Referenced by OnPgmExit(), and ~PGM_KICAD().

◆ ForceSystemPdfBrowser()

virtual void PGM_BASE::ForceSystemPdfBrowser ( bool aFlg )

inlinevirtualinherited

Force the use of system PDF browser, even if a preferred PDF browser is set.

Definition at line 195 of file pgm_base.h.

References PGM_BASE::m_use_system_pdf_browser.

Referenced by PGM_BASE::PGM_BASE().

◆ GetBackgroundJobMonitor()

virtual BACKGROUND_JOBS_MONITOR & PGM_BASE::GetBackgroundJobMonitor ( ) const

inlinevirtualinherited

Definition at line 143 of file pgm_base.h.

References PGM_BASE::m_background_jobs_monitor.

◆ GetCommonSettings()

COMMON_SETTINGS * PGM_BASE::GetCommonSettings ( ) const

virtualinherited

Definition at line 634 of file pgm_base.cpp.

References PGM_BASE::m_settings_manager.

Referenced by PGM_BASE::GetLocalEnvVariables(), PGM_BASE::InitPgm(), PGM_BASE::loadCommonSettings(), PGM_BASE::ReadPdfBrowserInfos(), PGM_BASE::SaveCommonSettings(), PGM_BASE::SetLanguage(), PGM_BASE::SetLocalEnvVariables(), PGM_BASE::SetTextEditor(), and PGM_BASE::WritePdfBrowserInfos().

◆ GetExecutablePath()

const wxString & PGM_BASE::GetExecutablePath ( ) const

virtualinherited

Definition at line 955 of file pgm_base.cpp.

References PATHS::GetExecutablePath().

Referenced by PGM_SINGLE_TOP::OnPgmInit(), and PGM_BASE::SetLanguagePath().

◆ GetHelpFileName()

wxString PGM_KICAD::GetHelpFileName ( )

inline

Definition at line 59 of file pgm_kicad.h.

References m_bm, and BIN_MOD::m_help_file.

Referenced by KICAD_MANAGER_FRAME::help_name().

◆ GetKicadEnvVariable()

virtual const wxString & PGM_BASE::GetKicadEnvVariable ( ) const

inlinevirtualinherited

Definition at line 172 of file pgm_base.h.

References PGM_BASE::m_kicad_env.

◆ GetLanguageTag()

wxString PGM_BASE::GetLanguageTag ( )

virtualinherited

Returns: the current selected language in rfc3066 format

Definition at line 797 of file pgm_base.cpp.

References PGM_BASE::m_language_id.

◆ GetLocale()

virtual wxLocale * PGM_BASE::GetLocale ( )

inlinevirtualinherited

Definition at line 176 of file pgm_base.h.

References PGM_BASE::m_locale.

◆ GetLocalEnvVariables()

ENV_VAR_MAP & PGM_BASE::GetLocalEnvVariables ( ) const

virtualinherited

Definition at line 871 of file pgm_base.cpp.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_Env, and COMMON_SETTINGS::ENVIRONMENT::vars.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FILENAME_RESOLVER::GetKicadPaths(), and OnPgmInit().

◆ GetNotificationsManager()

virtual NOTIFICATIONS_MANAGER & PGM_BASE::GetNotificationsManager ( ) const

inlinevirtualinherited

Definition at line 145 of file pgm_base.h.

References PGM_BASE::m_notifications_manager.

Referenced by PGM_BASE::InitPgm().

◆ GetPdfBrowserName()

virtual const wxString & PGM_BASE::GetPdfBrowserName ( ) const

inlinevirtualinherited

Definition at line 178 of file pgm_base.h.

References PGM_BASE::m_pdf_browser.

Referenced by PGM_BASE::WritePdfBrowserInfos().

◆ GetSelectedLanguageIdentifier()

virtual int PGM_BASE::GetSelectedLanguageIdentifier ( ) const

inlinevirtualinherited

Returns: the wxWidgets language identifier Id of the language currently selected.

Definition at line 229 of file pgm_base.h.

References PGM_BASE::m_language_id.

◆ GetSettingsManager()

virtual SETTINGS_MANAGER & PGM_BASE::GetSettingsManager ( ) const

inlinevirtualinherited

Definition at line 139 of file pgm_base.h.

References PGM_BASE::m_settings_manager.

Referenced by PGM_BASE::InitPgm(), LIB_PIN::LIB_PIN(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), OnPgmInit(), and PGM_BASE::SetLanguage().

◆ GetTextEditor()

const wxString & PGM_BASE::GetTextEditor ( bool aCanShowFileChooser = true )

virtualinherited

Return the path to the preferred text editor application.

Parameters

aCanShowFileChooser If no editor is currently set and this argument is 'true' then this method will show a file chooser dialog asking for the editor's executable.

Returns: Returns the full path of the editor, or an empty string if no editor has been set.

Definition at line 189 of file pgm_base.cpp.

References _, PGM_BASE::AskUserForPreferredEditor(), DisplayInfoMessage(), PGM_BASE::m_text_editor, and PGM_BASE::SetTextEditor().

◆ HandleAssert()

void PGM_BASE::HandleAssert	(	const wxString &	aFile,
		int	aLine,
		const wxString &	aFunc,
		const wxString &	aCond,
		const wxString &	aMsg
	)

inherited

A common assert handler to be used between single_top and kicad.

This lets us have a common set of assert handling, including triggering sentry reports

Parameters

aFile	the file path of the assert
aLine	the line number of the assert
aFunc	the function name the assert is within
aCond	the condition of the assert
aMsg	the attached assert message (can be empty)

Definition at line 921 of file pgm_base.cpp.

◆ HandleException()

void PGM_BASE::HandleException ( std::exception_ptr aPtr )

inherited

A exception handler to be used at the top level if exceptions bubble up that for.

The purpose is to have a central place to log a wxWidgets error message and/or sentry report

Parameters

aPtr	Pass the std::current_exception() from within the catch block

Definition at line 886 of file pgm_base.cpp.

References From_UTF8(), name, and IO_ERROR::What().

Referenced by APP_KICAD::OnRun(), and APP_KICAD_CLI::OnRun().

◆ HideSplash()

void PGM_BASE::HideSplash ( )

inherited

Definition at line 430 of file pgm_base.cpp.

References PGM_BASE::m_splash.

Referenced by OnPgmInit(), and PGM_BASE::~PGM_BASE().

◆ InitPgm()

bool PGM_BASE::InitPgm	(	bool	aHeadless = `false`,
		bool	aSkipPyInit = `false`,
		bool	aIsUnitTest = `false`
	)

inherited

Initialize this program.

Initialize the process in a KiCad standard way using some generalized techniques:

Default paths (help, libs, bin) and configuration file names
Language and locale
fonts

Note: Do not initialize anything relating to DSOs or projects.

Parameters

aHeadless	If true, run in headless mode (e.g. for unit tests)
aSkipPyInit	If true, do not init python stuff. Useful in application that do not use python, to disable python dependency at run time

Returns: true if success, false if failure and program is to terminate.

Should never happen but boost unit_test isn't playing nicely in some cases

Definition at line 441 of file pgm_base.cpp.

References _, PGM_BASE::App(), DisplayErrorMessage(), PATHS::EnsureUserPathsExist(), ADVANCED_CFG::GetCfg(), PGM_BASE::GetCommonSettings(), PGM_BASE::GetNotificationsManager(), PGM_BASE::GetSettingsManager(), KICAD_CURL::Init(), COMMON_SETTINGS::InitializeEnvironment(), NOTIFICATIONS_MANAGER::Load(), SETTINGS_MANAGER::Load(), PGM_BASE::loadCommonSettings(), SETTINGS_MANAGER::LoadProject(), PGM_BASE::m_background_jobs_monitor, PGM_BASE::m_kicad_env, PGM_BASE::m_notifications_manager, PGM_BASE::m_pgm_checker, PGM_BASE::m_python_scripting, PGM_BASE::m_settings_manager, PGM_BASE::ReadPdfBrowserInfos(), PGM_BASE::SetDefaultLanguage(), PGM_BASE::SetLanguage(), PGM_BASE::SetLanguagePath(), PGM_BASE::ShowSplash(), UNIX_STRING_DIR_SEP, WarnUserIfOperatingSystemUnsupported(), WIN_STRING_DIR_SEP, and wxPGGlobalVars.

Referenced by OnPgmInit().

◆ IsGUI()

bool PGM_BASE::IsGUI ( )

inherited

Determine if the application is running with a GUI.

Returns: true if there is a GUI and false otherwise

Definition at line 877 of file pgm_base.cpp.

◆ IsKicadEnvVariableDefined()

virtual bool PGM_BASE::IsKicadEnvVariableDefined ( ) const

inlinevirtualinherited

Definition at line 170 of file pgm_base.h.

References PGM_BASE::m_kicad_env.

◆ loadCommonSettings()

void PGM_BASE::loadCommonSettings ( )

protectedinherited

Loads internal settings from COMMON_SETTINGS.

Definition at line 598 of file pgm_base.cpp.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_System, PGM_BASE::m_text_editor, PROJECT_VAR_NAME, PGM_BASE::SetLocalEnvVariable(), COMMON_SETTINGS::SYSTEM::text_editor, and traceEnvVars.

Referenced by PGM_BASE::InitPgm().

◆ MacOpenFile()

void PGM_KICAD::MacOpenFile ( const wxString & aFileName )

overridevirtual

Specific to MacOSX (not used under Linux or Windows).

MacOSX requires it for file association.

See also: http://wiki.wxwidgets.org/WxMac-specific_topics

Implements PGM_BASE.

Definition at line 384 of file kicad.cpp.

References PGM_BASE::App(), and KICAD_MANAGER_FRAME::LoadProject().

◆ OnPgmExit()

void PGM_KICAD::OnPgmExit ( )

Definition at line 367 of file kicad.cpp.

References Destroy(), Kiway, PGM_BASE::m_settings_manager, KIWAY::OnKiwayEnd(), and PGM_BASE::SaveCommonSettings().

Referenced by APP_KICAD::OnExit(), APP_KICAD_CLI::OnExit(), APP_KICAD::OnInit(), APP_KICAD_CLI::OnInit(), and OnPgmInit().

◆ OnPgmInit()

bool PGM_KICAD::OnPgmInit ( )

Definition at line 94 of file kicad.cpp.

References _, SEARCH_STACK::AddPaths(), PGM_BASE::App(), FRAME_BM2CMP, FRAME_CALC, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_T_COUNT, EDA_BASE_FRAME::GetAboutTitle(), PGM_BASE::GetLocalEnvVariables(), PGM_BASE::GetSettingsManager(), PATHS::GetUserTemplatesPath(), PGM_BASE::HideSplash(), BIN_MOD::Init(), PGM_BASE::InitPgm(), BIN_MOD::InitSettings(), KFCTL_CPP_PROJECT_SUITE, KFCTL_STANDALONE, KICAD_MAIN_FRAME_T, Kiway, LegacyProjectFileExtension, KICAD_MANAGER_FRAME::LoadProject(), m_bm, KICAD_SETTINGS::m_OpenProjects, BIN_MOD::m_search, name, OnPgmExit(), KIWAY_PLAYER::OpenProjectFiles(), PgmSettings(), KIWAY::Player(), ProjectFileExtension, SETTINGS_MANAGER::RegisterSettings(), KIWAY::SetCtlBits(), SETTINGS_MANAGER::SetKiway(), KIWAY::SetTop(), and SystemDirsAppend().

Referenced by APP_KICAD::OnInit(), and APP_KICAD_CLI::OnInit().

◆ OnPgmRun()

int PGM_KICAD::OnPgmRun ( )

Definition at line 361 of file kicad.cpp.

Referenced by APP_KICAD_CLI::OnRun().

◆ PgmSettings()

APP_SETTINGS_BASE * PGM_KICAD::PgmSettings ( )

inline

Definition at line 55 of file pgm_kicad.h.

References m_bm, and BIN_MOD::m_config.

Referenced by KICAD_MANAGER_FRAME::config(), and OnPgmInit().

◆ ReadPdfBrowserInfos()

void PGM_BASE::ReadPdfBrowserInfos ( )

virtualinherited

Read the PDF browser choice from the common configuration.

Definition at line 37 of file eda_doc.cpp.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_System, PGM_BASE::m_use_system_pdf_browser, PGM_BASE::SetPdfBrowserName(), and COMMON_SETTINGS::SYSTEM::use_system_pdf_viewer.

Referenced by PGM_BASE::InitPgm().

◆ SaveCommonSettings()

void PGM_BASE::SaveCommonSettings ( )

inherited

Save the program (process) settings subset which are stored .kicad_common.

Definition at line 625 of file pgm_base.cpp.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_System, and COMMON_SETTINGS::SYSTEM::working_dir.

Referenced by PGM_SINGLE_TOP::OnPgmExit(), and OnPgmExit().

◆ SetDefaultLanguage()

bool PGM_BASE::SetDefaultLanguage ( wxString & aErrMsg )

inherited

Set the default language without reference to any preferences.

Can be used to set the language for dialogs that show before preferences are loaded

Parameters

aErrMsg String to return the error message(s) in

Returns: false if the language could not be set

Definition at line 740 of file pgm_base.cpp.

References _, PGM_BASE::m_language_id, PGM_BASE::m_locale, PGM_BASE::setLanguageId(), and traceLocale.

Referenced by PGM_BASE::InitPgm().

◆ SetLanguage()

bool PGM_BASE::SetLanguage	(	wxString &	aErrMsg,
		bool	first_time = `false`
	)

virtualinherited

Set the dictionary file name for internationalization.

The files are in kicad/internat/xx or kicad/internat/xx_XX and are named kicad.mo

Parameters

aErrMsg	is the string to return the error message it.
first_time	must be set to true the first time this function is called, false otherwise.

Returns: false if there was an error setting the language.

Definition at line 640 of file pgm_base.cpp.

References _, PGM_BASE::GetCommonSettings(), PGM_BASE::GetSettingsManager(), COMMON_SETTINGS::SYSTEM::language, LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, LANGUAGE_DESCR::m_Lang_Label, PGM_BASE::m_language_id, PGM_BASE::m_locale, COMMON_SETTINGS::m_System, JSON_SETTINGS::SaveToFile(), PGM_BASE::setLanguageId(), and traceLocale.

Referenced by PGM_BASE::InitPgm().

◆ setLanguageId()

void PGM_BASE::setLanguageId ( int aId )

inlineprotectedinherited

Trap all changes in here, simplifies debugging.

Definition at line 388 of file pgm_base.h.

References PGM_BASE::m_language_id.

Referenced by PGM_BASE::PGM_BASE(), PGM_BASE::SetDefaultLanguage(), PGM_BASE::SetLanguage(), and PGM_BASE::SetLanguageIdentifier().

◆ SetLanguageIdentifier()

void PGM_BASE::SetLanguageIdentifier ( int menu_id )

virtualinherited

Set in .m_language_id member the wxWidgets language identifier ID from the KiCad menu id (internal menu identifier).

Parameters

menu_id The KiCad menuitem id (returned by Menu Event, when clicking on a menu item)

Definition at line 781 of file pgm_base.cpp.

References arrayDim(), LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, PGM_BASE::setLanguageId(), and traceLocale.

◆ SetLanguagePath()

void PGM_BASE::SetLanguagePath ( )

virtualinherited

Definition at line 813 of file pgm_base.cpp.

References PGM_BASE::GetExecutablePath(), PATHS::GetLocaleDataPath(), and Pgm().

Referenced by PGM_BASE::InitPgm().

◆ SetLocalEnvVariable()

bool PGM_BASE::SetLocalEnvVariable	(	const wxString &	aName,
		const wxString &	aValue
	)

virtualinherited

Sets the environment variable aName to aValue.

This function first checks to see if the environment variable aName is already defined. If it is not defined, then the environment variable aName is set to a value. Otherwise, the environment variable is left unchanged. This allows the user to override environment variables for testing purposes.

Parameters

aName	is a wxString containing the environment variable name.
aValue	is a wxString containing the environment variable value.

Returns: true if the environment variable Name was set to aValue.

Definition at line 827 of file pgm_base.cpp.

References traceEnvVars.

Referenced by PGM_BASE::loadCommonSettings().

◆ SetLocalEnvVariables()

void PGM_BASE::SetLocalEnvVariables ( )

virtualinherited

Updates the local environment with the contents of the current ENV_VAR_MAP stored in the COMMON_SETTINGS.

See also: GetLocalEnvVariables()

Definition at line 856 of file pgm_base.cpp.

References PGM_BASE::GetCommonSettings(), and traceEnvVars.

◆ SetPdfBrowserName()

virtual void PGM_BASE::SetPdfBrowserName ( const wxString & aFileName )

inlinevirtualinherited

Definition at line 180 of file pgm_base.h.

References PGM_BASE::m_pdf_browser.

Referenced by PGM_BASE::ReadPdfBrowserInfos().

◆ SetTextEditor()

void PGM_BASE::SetTextEditor ( const wxString & aFileName )

virtualinherited

Definition at line 182 of file pgm_base.cpp.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_System, PGM_BASE::m_text_editor, and COMMON_SETTINGS::SYSTEM::text_editor.

Referenced by PGM_BASE::GetTextEditor().

◆ ShowSplash()

void PGM_BASE::ShowSplash ( )

inherited

Definition at line 419 of file pgm_base.cpp.

References KiBitmap(), and PGM_BASE::m_splash.

Referenced by PGM_BASE::InitPgm().

◆ SingleInstance()

std::unique_ptr< wxSingleInstanceChecker > & PGM_BASE::SingleInstance ( )

inlineinherited

Allows access to the wxSingleInstanceChecker to test for other running KiCads.

Definition at line 369 of file pgm_base.h.

References PGM_BASE::m_pgm_checker.

◆ SysSearch()

SEARCH_STACK & PGM_KICAD::SysSearch ( )

inline

Definition at line 57 of file pgm_kicad.h.

References m_bm, and BIN_MOD::m_search.

Referenced by KICAD_MANAGER_FRAME::sys_search().

◆ UseSystemPdfBrowser()

virtual bool PGM_BASE::UseSystemPdfBrowser ( ) const

inlinevirtualinherited

Returns: true if the PDF browser is the default (system) PDF browser and false if the PDF browser is the preferred (selected) browser, else returns false if there is no selected browser.

Definition at line 187 of file pgm_base.h.

References PGM_BASE::m_pdf_browser, and PGM_BASE::m_use_system_pdf_browser.

◆ WritePdfBrowserInfos()

void PGM_BASE::WritePdfBrowserInfos ( )

virtualinherited

Save the PDF browser choice to the common configuration.

Definition at line 44 of file eda_doc.cpp.

References PGM_BASE::GetCommonSettings(), PGM_BASE::GetPdfBrowserName(), COMMON_SETTINGS::m_System, PGM_BASE::m_use_system_pdf_browser, COMMON_SETTINGS::SYSTEM::pdf_viewer_name, and COMMON_SETTINGS::SYSTEM::use_system_pdf_viewer.

Member Data Documentation

◆ m_argcUtf8

int PGM_BASE::m_argcUtf8

protectedinherited

argv parameters converted to utf8 form, because wxwidgets has opinions and will return argv as either force converted to ascii in char* or wchar_t only

Definition at line 426 of file pgm_base.h.

Referenced by PGM_BASE::BuildArgvUtf8(), PGM_BASE::PGM_BASE(), and PGM_BASE::~PGM_BASE().

◆ m_argvUtf8

char** PGM_BASE::m_argvUtf8

protectedinherited

Definition at line 423 of file pgm_base.h.

Referenced by PGM_BASE::BuildArgvUtf8(), PGM_BASE::PGM_BASE(), and PGM_BASE::~PGM_BASE().

◆ m_background_jobs_monitor

std::unique_ptr<BACKGROUND_JOBS_MONITOR> PGM_BASE::m_background_jobs_monitor

protectedinherited

Definition at line 398 of file pgm_base.h.

Referenced by PGM_BASE::GetBackgroundJobMonitor(), and PGM_BASE::InitPgm().

◆ m_bm

BIN_MOD PGM_KICAD::m_bm

protected

Definition at line 68 of file pgm_kicad.h.

Referenced by Destroy(), GetHelpFileName(), OnPgmInit(), PgmSettings(), and SysSearch().

◆ m_kicad_env

wxString PGM_BASE::m_kicad_env

protectedinherited

Definition at line 407 of file pgm_base.h.

Referenced by PGM_BASE::GetKicadEnvVariable(), PGM_BASE::InitPgm(), and PGM_BASE::IsKicadEnvVariableDefined().

◆ m_language_id

int PGM_BASE::m_language_id

protectedinherited

Definition at line 410 of file pgm_base.h.

Referenced by PGM_BASE::GetLanguageTag(), PGM_BASE::GetSelectedLanguageIdentifier(), PGM_BASE::SetDefaultLanguage(), PGM_BASE::SetLanguage(), and PGM_BASE::setLanguageId().

◆ m_locale

wxLocale* PGM_BASE::m_locale

protectedinherited

The KICAD system environment variable.

Definition at line 409 of file pgm_base.h.

Referenced by PGM_BASE::Destroy(), PGM_BASE::GetLocale(), PGM_BASE::PGM_BASE(), PGM_BASE::SetDefaultLanguage(), and PGM_BASE::SetLanguage().

◆ m_ModalDialogs

std::vector<void*> PGM_BASE::m_ModalDialogs

inherited

Definition at line 379 of file pgm_base.h.

Referenced by APP_KICAD::FilterEvent().

◆ m_notifications_manager

std::unique_ptr<NOTIFICATIONS_MANAGER> PGM_BASE::m_notifications_manager

protectedinherited

Definition at line 399 of file pgm_base.h.

Referenced by PGM_BASE::GetNotificationsManager(), and PGM_BASE::InitPgm().

◆ m_pdf_browser

wxString PGM_BASE::m_pdf_browser

protectedinherited

Definition at line 413 of file pgm_base.h.

Referenced by PGM_BASE::GetPdfBrowserName(), PGM_BASE::SetPdfBrowserName(), and PGM_BASE::UseSystemPdfBrowser().

◆ m_pgm_checker

std::unique_ptr<wxSingleInstanceChecker> PGM_BASE::m_pgm_checker

protectedinherited

Checks if there is another copy of Kicad running at the same time.

Definition at line 404 of file pgm_base.h.

Referenced by PGM_BASE::Destroy(), PGM_BASE::InitPgm(), and PGM_BASE::SingleInstance().

◆ m_Printing

bool PGM_BASE::m_Printing

inherited

wxWidgets on MSW tends to crash if you spool up more than one print job at a time.

Definition at line 377 of file pgm_base.h.

Referenced by PGM_BASE::PGM_BASE().

◆ m_python_scripting

std::unique_ptr<SCRIPTING> PGM_BASE::m_python_scripting

protectedinherited

Definition at line 401 of file pgm_base.h.

Referenced by PGM_BASE::InitPgm().

◆ m_Quitting

bool PGM_BASE::m_Quitting

inherited

Definition at line 381 of file pgm_base.h.

Referenced by PGM_BASE::PGM_BASE().

◆ m_settings_manager

std::unique_ptr<SETTINGS_MANAGER> PGM_BASE::m_settings_manager

protectedinherited

Definition at line 397 of file pgm_base.h.

Referenced by PGM_BASE::GetCommonSettings(), PGM_BASE::GetSettingsManager(), PGM_BASE::InitPgm(), PGM_SINGLE_TOP::OnPgmExit(), and OnPgmExit().

◆ m_splash

wxSplashScreen* PGM_BASE::m_splash

protectedinherited

Definition at line 428 of file pgm_base.h.

Referenced by PGM_BASE::HideSplash(), PGM_BASE::PGM_BASE(), and PGM_BASE::ShowSplash().

◆ m_text_editor

wxString PGM_BASE::m_text_editor

protectedinherited

Filename of the app selected for browsing PDFs.

Definition at line 415 of file pgm_base.h.

Referenced by PGM_BASE::GetTextEditor(), PGM_BASE::loadCommonSettings(), and PGM_BASE::SetTextEditor().

◆ m_use_system_pdf_browser

bool PGM_BASE::m_use_system_pdf_browser

protectedinherited

Definition at line 412 of file pgm_base.h.

Referenced by PGM_BASE::ForceSystemPdfBrowser(), PGM_BASE::ReadPdfBrowserInfos(), PGM_BASE::UseSystemPdfBrowser(), and PGM_BASE::WritePdfBrowserInfos().

◆ workingDirKey

const wxChar PGM_BASE::workingDirKey[]

staticinherited

Definition at line 278 of file pgm_base.h.

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PGM_KICAD()

◆ ~PGM_KICAD()

Member Function Documentation

◆ App()

◆ AskUserForPreferredEditor()

◆ BuildArgvUtf8()

◆ Destroy()

◆ ForceSystemPdfBrowser()

◆ GetBackgroundJobMonitor()

◆ GetCommonSettings()

◆ GetExecutablePath()

◆ GetHelpFileName()

◆ GetKicadEnvVariable()

◆ GetLanguageTag()

◆ GetLocale()

◆ GetLocalEnvVariables()

◆ GetNotificationsManager()

◆ GetPdfBrowserName()

◆ GetSelectedLanguageIdentifier()

◆ GetSettingsManager()

◆ GetTextEditor()

◆ HandleAssert()

◆ HandleException()

◆ HideSplash()

◆ InitPgm()

◆ IsGUI()

◆ IsKicadEnvVariableDefined()

◆ loadCommonSettings()

◆ MacOpenFile()

◆ OnPgmExit()

◆ OnPgmInit()

◆ OnPgmRun()

◆ PgmSettings()

◆ ReadPdfBrowserInfos()

◆ SaveCommonSettings()

◆ SetDefaultLanguage()

◆ SetLanguage()

◆ setLanguageId()

◆ SetLanguageIdentifier()

◆ SetLanguagePath()

◆ SetLocalEnvVariable()

◆ SetLocalEnvVariables()

◆ SetPdfBrowserName()

◆ SetTextEditor()

◆ ShowSplash()

◆ SingleInstance()

◆ SysSearch()

◆ UseSystemPdfBrowser()

◆ WritePdfBrowserInfos()

Member Data Documentation

◆ m_argcUtf8

◆ m_argvUtf8

◆ m_background_jobs_monitor

◆ m_bm

◆ m_kicad_env

◆ m_language_id

◆ m_locale

◆ m_ModalDialogs

◆ m_notifications_manager

◆ m_pdf_browser

◆ m_pgm_checker

◆ m_Printing

◆ m_python_scripting

◆ m_Quitting

◆ m_settings_manager

◆ m_splash

◆ m_text_editor

◆ m_use_system_pdf_browser

◆ workingDirKey