Functions
bool	Init ()
	Perform application-specific initialization tasks.

void	EnableDarkMode (bool aForce)

bool	AttachConsole (bool aTryAlloc)
	Tries to attach a console window with stdout, stderr and stdin.

bool	IsOperatingSystemUnsupported ()
	Checks if the Operating System is explicitly unsupported and we want to prevent users from sending bug reports and show them a disclaimer on startup.

bool	RegisterApplicationRestart (const wxString &aCommandLine)
	Registers the application for restart with the OS with the given command line string to pass as args.

bool	UnregisterApplicationRestart ()
	Unregisters the application from automatic restart.

bool	SupportsShutdownBlockReason ()
	Whether or not the window supports setting a shutdown block reason.

void	SetShutdownBlockReason (wxWindow *aWindow, const wxString &aReason)
	Sets the block reason why the window/application is preventing OS shutdown.

void	RemoveShutdownBlockReason (wxWindow *aWindow)
	Removes any shutdown block reason set.

void	ForceTimerMessagesToBeCreatedIfNecessary ()
	Forces wxTimers to fire more promptly on Win32.

void	AddDynamicLibrarySearchPath (const wxString &aPath)
	Inserts a search path for loading dynamic libraries.

bool	SetCurrentThreadPriority (bool aRaise)
	Raise or lower the scheduling priority of the calling thread.

Function Documentation

◆ AddDynamicLibrarySearchPath()

void KIPLATFORM::APP::AddDynamicLibrarySearchPath ( const wxString & aPath )

Inserts a search path for loading dynamic libraries.

The exact place this new path ends up in the dynamic library search order is platform-dependent, but generally this can be used to make sure dynamic libraries are found in non-standard runtime situations.

Parameters

aPath is the full path to insert

Definition at line 118 of file unix/app.cpp.

Referenced by KIWAY::KiFACE().

◆ AttachConsole()

bool KIPLATFORM::APP::AttachConsole ( bool aTryAlloc )

Tries to attach a console window with stdout, stderr and stdin.

Parameters

aTryAlloc try to allocate the console if cannot attach to it.

Returns: true if attach successful, false if unsuccessful

Definition at line 69 of file unix/app.cpp.

◆ EnableDarkMode()

void KIPLATFORM::APP::EnableDarkMode ( bool aForce )

Definition at line 64 of file unix/app.cpp.

Referenced by PGM_KICAD::OnPgmInit(), and PGM_SINGLE_TOP::OnPgmInit().

◆ ForceTimerMessagesToBeCreatedIfNecessary()

void KIPLATFORM::APP::ForceTimerMessagesToBeCreatedIfNecessary ( )

Forces wxTimers to fire more promptly on Win32.

wxTimers on win32 are not real timers They live in the message pump at the absolute lowest priority (only when no other events are pending) This functions "peeks" the message pump which causes them to get queued immediately

Call as needed in an application to ensure timers are dispatched

Definition at line 113 of file unix/app.cpp.

Referenced by TOOL_DISPATCHER::DispatchWxEvent().

◆ Init()

bool KIPLATFORM::APP::Init ( )

Perform application-specific initialization tasks.

These tasks should be called after the wxApp is constructed (e.g. inside the OnInit method).

Returns: true if init successful, false if unsuccessful

Definition at line 46 of file unix/app.cpp.

References nullLogWriter().

Referenced by fuzz_init(), init_unit_test(), APP_KICAD::OnInit(), APP_KICAD_CLI::OnInit(), and APP_SINGLE_TOP::OnInit().

◆ IsOperatingSystemUnsupported()

bool KIPLATFORM::APP::IsOperatingSystemUnsupported ( )

Checks if the Operating System is explicitly unsupported and we want to prevent users from sending bug reports and show them a disclaimer on startup.

Returns: true if unsupported

Definition at line 76 of file unix/app.cpp.

Referenced by buildKicadAboutBanner(), GetVersionInfoData(), and WarnUserIfOperatingSystemUnsupported().

◆ RegisterApplicationRestart()

bool KIPLATFORM::APP::RegisterApplicationRestart ( const wxString & aCommandLine )

Registers the application for restart with the OS with the given command line string to pass as args.

Parameters

aCommandLine is string the OS will invoke the application with

Definition at line 83 of file unix/app.cpp.

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

◆ RemoveShutdownBlockReason()

void KIPLATFORM::APP::RemoveShutdownBlockReason ( wxWindow * aWindow )

Removes any shutdown block reason set.

Parameters

aWindow that has a shutdown block reason set

Definition at line 103 of file unix/app.cpp.

Referenced by EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ SetCurrentThreadPriority()

bool KIPLATFORM::APP::SetCurrentThreadPriority ( bool aRaise )

Raise or lower the scheduling priority of the calling thread.

Raising it may need privileges the process does not have.

Parameters

aRaise is true to schedule the thread above normal, false to schedule it below.

Returns: true if the priority was changed.

Definition at line 123 of file unix/app.cpp.

◆ SetShutdownBlockReason()

void KIPLATFORM::APP::SetShutdownBlockReason	(	wxWindow *	aWindow,
		const wxString &	aReason )

Sets the block reason why the window/application is preventing OS shutdown.

This should be set far ahead of any close event.

This is mainly intended for Windows platforms where this is a native feature.

Parameters

aWindow	that will have a shutdown blocker message
aReason	to display why the shutdown block is occurring

Definition at line 108 of file unix/app.cpp.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), EVT_UPDATE_UI_RANGE(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_EDIT_FRAME::OnBoardLoaded(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), and SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

◆ SupportsShutdownBlockReason()

bool KIPLATFORM::APP::SupportsShutdownBlockReason ( )

Whether or not the window supports setting a shutdown block reason.

Definition at line 97 of file unix/app.cpp.

Referenced by CVPCB_MAINFRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), PL_EDITOR_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), and SYMBOL_EDIT_FRAME::canCloseWindow().

◆ UnregisterApplicationRestart()

bool KIPLATFORM::APP::UnregisterApplicationRestart ( )

Unregisters the application from automatic restart.

Depending on OS, this may not be required

Definition at line 90 of file unix/app.cpp.

Functions

Function Documentation

◆ AddDynamicLibrarySearchPath()

◆ AttachConsole()

◆ EnableDarkMode()

◆ ForceTimerMessagesToBeCreatedIfNecessary()

◆ Init()

◆ IsOperatingSystemUnsupported()

◆ RegisterApplicationRestart()

◆ RemoveShutdownBlockReason()

◆ SetCurrentThreadPriority()

◆ SetShutdownBlockReason()

◆ SupportsShutdownBlockReason()

◆ UnregisterApplicationRestart()