KiCad PCB EDA Suite
bin_mod.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 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef BIN_MOD_H_
25 #define BIN_MOD_H_
26 
27 #if 0
28  #include <wx/filehistory.h> // wx 3.0:
29 #else
30  #include <wx/docview.h>
31 #endif
32 
33 #include <wx/string.h>
34 
35 #include <search_stack.h>
36 #include <memory>
37 
38 class APP_SETTINGS_BASE;
39 
48 struct BIN_MOD
49 {
50  BIN_MOD( const char* aName );
51  ~BIN_MOD();
52 
53  void Init();
54  void End();
55 
60  void InitSettings( APP_SETTINGS_BASE* aPtr ) { m_config = aPtr; }
61 
62  const char* m_name;
63 
65  wxString m_help_file;
66 
68 
69 
70 };
71 
72 #endif // BIN_MOD_H_
void Init()
Definition: bin_mod.cpp:41
Struct BIN_MOD pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod").
Definition: bin_mod.h:48
SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:64
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
~BIN_MOD()
Definition: bin_mod.cpp:65
void InitSettings(APP_SETTINGS_BASE *aPtr)
Takes ownership of a new application settings object.
Definition: bin_mod.h:60
SEARCH_STACK m_search
Definition: bin_mod.h:67
wxString m_help_file
Definition: bin_mod.h:65
BIN_MOD(const char *aName)
Definition: bin_mod.cpp:34
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:62
void End()
Definition: bin_mod.cpp:53