KiCad PCB EDA Suite
app.h
Go to the documentation of this file.
1 /*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2020 Mark Roszko <[email protected]>
5 * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20 
21 #ifndef KIPLATFORM_APP_H_
22 #define KIPLATFORM_APP_H_
23 
24 class wxString;
25 class wxWindow;
26 
27 namespace KIPLATFORM
28 {
29  namespace APP
30  {
37  bool Init();
38 
46 
52  bool RegisterApplicationRestart( const wxString& aCommandLine );
53 
60 
65 
75  void SetShutdownBlockReason( wxWindow* aWindow, const wxString& aReason );
76 
82  void RemoveShutdownBlockReason( wxWindow* aWindow );
83 
94 
102  void AddDynamicLibrarySearchPath( const wxString& aPath );
103  }
104 }
105 
106 #endif // KIPLATFORM_UI_H_
bool IsOperatingSystemUnsupported()
Checks if the Operating System is explicitly unsupported and we want to prevent users from sending bu...
Definition: gtk/app.cpp:51
void AddDynamicLibrarySearchPath(const wxString &aPath)
Inserts a search path for loading dynamic libraries.
Definition: gtk/app.cpp:93
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:83
void ForceTimerMessagesToBeCreatedIfNecessary()
Forces wxTimers to fire more promptly on Win32.
Definition: gtk/app.cpp:88
Definition: app.h:27
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:72
bool UnregisterApplicationRestart()
Unregisters the application from automatic restart.
Definition: gtk/app.cpp:65
bool Init()
Perform application-specific initialization tasks.
Definition: gtk/app.cpp:40
void RemoveShutdownBlockReason(wxWindow *aWindow)
Removes any shutdown block reason set.
Definition: gtk/app.cpp:78
bool RegisterApplicationRestart(const wxString &aCommandLine)
Registers the application for restart with the OS with the given command line string to pass as args.
Definition: gtk/app.cpp:58