KiCad PCB EDA Suite
Loading...
Searching...
No Matches
BIN_MOD Struct Reference

Pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod"). More...

#include <bin_mod.h>

Public Member Functions

 BIN_MOD (const char *aName)
 
 ~BIN_MOD ()
 
void Init ()
 
void End ()
 
void InitSettings (APP_SETTINGS_BASE *aPtr)
 Takes ownership of a new application settings object.
 

Public Attributes

const char * m_name
 name of this binary module, static C string.
 
APP_SETTINGS_BASEm_config
 maybe from $HOME/.${m_name}
 
wxString m_help_file
 
SEARCH_STACK m_search
 

Detailed Description

Pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod").

It manages miscellaneous configuration file information pertinent to one bin_mod. Because it serves in both DSO/DLLs and in EXEs, its name is neutral. Accessors are in containing (wrapper) classes.

Definition at line 40 of file bin_mod.h.

Constructor & Destructor Documentation

◆ BIN_MOD()

BIN_MOD::BIN_MOD ( const char * aName)

Definition at line 31 of file bin_mod.cpp.

References m_config, and m_name.

◆ ~BIN_MOD()

BIN_MOD::~BIN_MOD ( )

Definition at line 62 of file bin_mod.cpp.

Member Function Documentation

◆ End()

void BIN_MOD::End ( )

◆ Init()

void BIN_MOD::Init ( )

Definition at line 38 of file bin_mod.cpp.

References m_help_file, and m_name.

◆ InitSettings()

void BIN_MOD::InitSettings ( APP_SETTINGS_BASE * aPtr)
inline

Takes ownership of a new application settings object.

Parameters
aPtris the settings object for this module.

Definition at line 53 of file bin_mod.h.

References m_config.

Member Data Documentation

◆ m_config

APP_SETTINGS_BASE* BIN_MOD::m_config

maybe from $HOME/.${m_name}

Definition at line 57 of file bin_mod.h.

Referenced by BIN_MOD(), End(), and InitSettings().

◆ m_help_file

wxString BIN_MOD::m_help_file

Definition at line 58 of file bin_mod.h.

Referenced by Init().

◆ m_name

const char* BIN_MOD::m_name

name of this binary module, static C string.

Definition at line 55 of file bin_mod.h.

Referenced by BIN_MOD(), and Init().

◆ m_search

SEARCH_STACK BIN_MOD::m_search

Definition at line 60 of file bin_mod.h.


The documentation for this struct was generated from the following files: