KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2020 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#include <wx/string.h>
28
29#include <search_stack.h>
30
32
40struct BIN_MOD
41{
42 BIN_MOD( const char* aName );
43 ~BIN_MOD();
44
45 void Init();
46 void End();
47
53 void InitSettings( APP_SETTINGS_BASE* aPtr ) { m_config = aPtr; }
54
55 const char* m_name;
56
58 wxString m_help_file;
59
61};
62
63#endif // BIN_MOD_H_
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Look for files in a number of paths.
Definition: search_stack.h:43
Pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod").
Definition: bin_mod.h:41
~BIN_MOD()
Definition: bin_mod.cpp:62
void End()
Definition: bin_mod.cpp:50
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:57
void Init()
Definition: bin_mod.cpp:38
SEARCH_STACK m_search
Definition: bin_mod.h:60
wxString m_help_file
Definition: bin_mod.h:58
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:55
void InitSettings(APP_SETTINGS_BASE *aPtr)
Takes ownership of a new application settings object.
Definition: bin_mod.h:53