KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 <[email protected]>
5 * Copyright (C) 2014 KiCad Developers, see AUTHORS.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
37class PGM_KICAD : public PGM_BASE
38{
39public:
41 m_bm( "kicad" ) // indicates a "$HOME/.kicad wxConfig like" config file.
42 {}
43
44 ~PGM_KICAD() throw()
45 {
46 Destroy();
47 }
48
49 bool OnPgmInit();
50 void OnPgmExit();
51 int OnPgmRun();
52
53 void MacOpenFile( const wxString& aFileName ) override;
54
56
58
59 wxString GetHelpFileName() { return m_bm.m_help_file; }
60
61 // The PGM_* classes can have difficulties at termination if they
62 // are not destroyed soon enough. Relying on a static destructor can be
63 // too late for contained objects like wxSingleInstanceChecker.
64 void Destroy();
65
66protected:
67
69};
70
71
72extern PGM_KICAD& PgmTop();
73
74
75#endif // PGM_KICAD_H_
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Container for data for KiCad programs.
Definition: pgm_base.h:102
PGM_KICAD extends PGM_BASE to bring in FileHistory() and PdfBrowser() which were moved from EDA_APP i...
Definition: pgm_kicad.h:38
PGM_KICAD()
Definition: pgm_kicad.h:40
wxString GetHelpFileName()
Definition: pgm_kicad.h:59
bool OnPgmInit()
Definition: kicad.cpp:86
void Destroy()
Definition: kicad.cpp:408
SEARCH_STACK & SysSearch()
Definition: pgm_kicad.h:57
void MacOpenFile(const wxString &aFileName) override
Specific to MacOSX (not used under Linux or Windows).
Definition: kicad.cpp:395
void OnPgmExit()
Definition: kicad.cpp:373
APP_SETTINGS_BASE * PgmSettings()
Definition: pgm_kicad.h:55
~PGM_KICAD()
Definition: pgm_kicad.h:44
int OnPgmRun()
Definition: kicad.cpp:367
BIN_MOD m_bm
Definition: pgm_kicad.h:68
Look for files in a number of paths.
Definition: search_stack.h:43
see class PGM_BASE
PGM_KICAD & PgmTop()
Definition: kicad.cpp:80
Pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod").
Definition: bin_mod.h:41
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:57
SEARCH_STACK m_search
Definition: bin_mod.h:60
wxString m_help_file
Definition: bin_mod.h:58