KiCad PCB EDA Suite
pgm_kicad.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) 2014 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2014 KiCad Developers, see CHANGELOG.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef PGM_KICAD_H_
26 #define PGM_KICAD_H_
27 
28 #include <pgm_base.h>
29 #include <bin_mod.h>
30 #include "kicad_settings.h"
31 
39 class PGM_KICAD : public PGM_BASE
40 {
41 public:
43  m_bm( "kicad" ) // indicates a "$HOME/.kicad wxConfig like" config file.
44  {}
45 
46  ~PGM_KICAD() throw()
47  {
48  Destroy();
49  }
50 
51  bool OnPgmInit();
52  void OnPgmExit();
53 
54  void MacOpenFile( const wxString& aFileName ) override;
55 
57 
59 
60  wxString GetHelpFileName() { return m_bm.m_help_file; }
61 
62  // The PGM_* classes can have difficulties at termination if they
63  // are not destroyed soon enough. Relying on a static destructor can be
64  // too late for contained objects like wxSingleInstanceChecker.
65  void Destroy();
66 
67 protected:
68 
70 };
71 
72 
73 extern PGM_KICAD& PgmTop();
74 
75 
76 #endif // PGM_KICAD_H_
SEARCH_STACK & SysSearch()
Definition: pgm_kicad.h:58
Struct BIN_MOD pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod").
Definition: bin_mod.h:48
PGM_BASE keeps program (whole process) data for KiCad programs.
Definition: pgm_base.h:137
PGM_KICAD extends PGM_BASE to bring in FileHistory() and PdfBrowser() which were moved from EDA_APP i...
Definition: pgm_kicad.h:39
void MacOpenFile(const wxString &aFileName) override
Function MacOpenFile is specific to MacOSX (not used under Linux or Windows).
Definition: kicad.cpp:197
PGM_KICAD()
Definition: pgm_kicad.h:42
SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
bool OnPgmInit()
Definition: kicad.cpp:78
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:64
~PGM_KICAD()
Definition: pgm_kicad.h:46
void Destroy()
Definition: kicad.cpp:210
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
SEARCH_STACK m_search
Definition: bin_mod.h:67
wxString m_help_file
Definition: bin_mod.h:65
BIN_MOD m_bm
Definition: pgm_kicad.h:69
see class PGM_BASE
APP_SETTINGS_BASE * PgmSettings()
Definition: pgm_kicad.h:56
wxString GetHelpFileName()
Definition: pgm_kicad.h:60
PGM_KICAD & PgmTop()
Definition: kicad.cpp:72
void OnPgmExit()
Definition: kicad.cpp:180