KiCad PCB EDA Suite
pgm_base.h File Reference

see class PGM_BASE More...

#include <map>
#include <wx/filename.h>
#include <search_stack.h>
#include <wx/gdicmn.h>

Go to the source code of this file.

Classes

class  ENV_VAR_ITEM
 Class ENV_VAR_ITEM. More...
 
class  PGM_BASE
 Class PGM_BASE keeps program (whole process) data for KiCad programs. More...
 

Macros

#define VTBL_ENTRY   virtual
 

Typedefs

typedef std::map< wxString, ENV_VAR_ITEMENV_VAR_MAP
 
typedef std::map< wxString, ENV_VAR_ITEM >::iterator ENV_VAR_MAP_ITER
 
typedef std::map< wxString, ENV_VAR_ITEM >::const_iterator ENV_VAR_MAP_CITER
 

Functions

PGM_BASEPgm ()
 The global Program "get" accessor. More...
 

Detailed Description

see class PGM_BASE

Definition in file pgm_base.h.

Macro Definition Documentation

#define VTBL_ENTRY   virtual

Definition at line 48 of file pgm_base.h.

Typedef Documentation

typedef std::map<wxString, ENV_VAR_ITEM> ENV_VAR_MAP

Definition at line 87 of file pgm_base.h.

typedef std::map<wxString, ENV_VAR_ITEM>::const_iterator ENV_VAR_MAP_CITER

Definition at line 89 of file pgm_base.h.

typedef std::map<wxString, ENV_VAR_ITEM>::iterator ENV_VAR_MAP_ITER

Definition at line 88 of file pgm_base.h.

Function Documentation

PGM_BASE& Pgm ( )

The global Program "get" accessor.

Implemented in: 1) common/single_top.cpp, 2) kicad/kicad.cpp, and 3) scripting/kiway.i

Definition at line 65 of file kicad.cpp.

References process, and program.

Referenced by TREEPROJECT_ITEM::Activate(), EDA_BASE_FRAME::AddMenuIconsOptions(), AddMenuItem(), WS_DRAW_ITEM_LIST::BuildFullText(), EDA_BASE_FRAME::CheckForAutoSaveFile(), DIALOG_BOM::choosePlugin(), PROJECT::ConfigSave(), CreateHeaderInfoData(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_SHIM::DIALOG_SHIM(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), KIWAY::dso_search_path(), EVT_UPDATE_UI_RANGE(), FindKicadFile(), InitKiCadAboutNew(), KicadDatasPath(), S3D_PLUGIN_MANAGER::loadPlugins(), APP_KICAD::MacOpenFile(), WIZARD_FPLIB_TABLE::OnBrowseButtonClick(), NETLIST_DIALOG_ADD_PLUGIN::OnBrowsePlugins(), EDA_BASE_FRAME::OnChangeIconsOptions(), PCB_EDIT_FRAME::OnCloseWindow(), DLG_3D_PATH_CONFIG::OnConfigEnvVar(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnConfigurePaths(), PCB_EDIT_FRAME::OnConfigurePaths(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditPlugin(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), TREE_PROJECT_FRAME::OnOpenSelectedFileWithTextEditor(), KICAD_MANAGER_FRAME::OnOpenTextEditor(), KICAD_MANAGER_FRAME::OnSelectDefaultPdfBrowser(), EDA_BASE_FRAME::OnSelectPreferredEditor(), KICAD_MANAGER_FRAME::OnSelectPreferredPdfBrowser(), GERBVIEW_FRAME::OnShowGerberSourceFile(), KICAD_MANAGER_FRAME::OnUpdateDefaultPdfBrowser(), KICAD_MANAGER_FRAME::OnUpdatePreferredPdfBrowser(), OpenPDF(), preparePreferencesMenu(), PCB_EDIT_FRAME::Process_Special_Functions(), PyScriptingPath(), CVPCB_MAINFRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SearchHelpFileFullPath(), KIWAY::SetLanguage(), SystemDirsAppend(), DIALOG_ERC::TestErc(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::WIZARD_3DSHAPE_LIBS_DOWNLOADER(), WIZARD_FPLIB_TABLE::WIZARD_FPLIB_TABLE(), wxBEGIN_EVENT_TABLE(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::~WIZARD_3DSHAPE_LIBS_DOWNLOADER(), and WIZARD_FPLIB_TABLE::~WIZARD_FPLIB_TABLE().

66 {
67  return program;
68 }
static PGM_KICAD program
Definition: kicad.cpp:62