KiCad PCB EDA Suite
pgm_base.h File Reference

see class PGM_BASE More...

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

Go to the source code of this file.

Classes

struct  LANGUAGE_DESCR
 A small class to handle the list of existing translations. More...
 
class  ENV_VAR_ITEM
 ENV_VAR_ITEM. More...
 
class  PGM_BASE
 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...
 
PGM_BASEPgmOrNull ()
 similat to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from a script, not from a kicad appl More...
 

Detailed Description

see class PGM_BASE

Definition in file pgm_base.h.

Macro Definition Documentation

◆ VTBL_ENTRY

#define VTBL_ENTRY   virtual

Definition at line 78 of file pgm_base.h.

Typedef Documentation

◆ ENV_VAR_MAP

typedef std::map<wxString, ENV_VAR_ITEM> ENV_VAR_MAP

Definition at line 117 of file pgm_base.h.

◆ ENV_VAR_MAP_CITER

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

Definition at line 119 of file pgm_base.h.

◆ ENV_VAR_MAP_ITER

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

Definition at line 118 of file pgm_base.h.

Function Documentation

◆ Pgm()

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 103 of file single_top.cpp.

104 {
105  return program;
106 }
PGM_SINGLE_TOP program

References process, and program.

Referenced by AddBitmapToMenuItem(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), AddMenuLanguageList(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), BRDITEMS_PLOTTER::BRDITEMS_PLOTTER(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), WS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), EDA_BASE_FRAME::CheckForAutoSaveFile(), DIALOG_BOM::chooseGenerator(), CINFO3D_VISU::CINFO3D_VISU(), PCB_BASE_FRAME::ColorSettings(), EDA_DRAW_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::CommonSettingsChanged(), PROJECT::ConfigSave(), CreateHeaderInfoData(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), BMP2CMP::IFACE::CreateWindow(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_SHIM::DIALOG_SHIM(), KIWAY::dso_search_path(), EDA_3D_CANVAS::EDA_3D_CANVAS(), EDA_3D_VIEWER::EDA_3D_VIEWER(), BIN_MOD::End(), EVT_UPDATE_UI_RANGE(), KICAD_MANAGER_CONTROL::Execute(), FindKicadFile(), NETLIST_EXPORTER_PSPICE::Format(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_FRAME::GERBVIEW_FRAME(), get_scale_factor(), SCH_MARKER::getColor(), MARKER_PCB::getColor(), EDA_DRAW_FRAME::GetColorSettings(), LIB_EDIT_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_SHEET::GetDefaultFieldName(), GetLayerColor(), GERBVIEW_FRAME::GetLayerColor(), FOOTPRINT_EDIT_FRAME::GetSettings(), PCB_BASE_FRAME::GetSettings(), GERBVIEW_FRAME::GetVisibleElementColor(), BIN_MOD::Init(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_BOM::installGeneratorsList(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), PANEL_PREV_3D::loadCommonSettings(), EDA_3D_VIEWER::loadCommonSettings(), SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), S3D_PLUGIN_MANAGER::loadPlugins(), LIB_VIEW_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), EDA_3D_VIEWER::LoadSettings(), LIB_EDIT_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadWindowSettings(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_PREVIEW_PANEL::New(), KICAD_MANAGER_CONTROL::NewFromTemplate(), NETLIST_DIALOG_ADD_GENERATOR::OnBrowseGenerators(), PANEL_COLOR_SETTINGS::OnBtnOpenThemeFolderClicked(), EDA_3D_VIEWER::OnCloseWindow(), PCB_EDIT_FRAME::OnCloseWindow(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditGenerator(), SCH::IFACE::OnKifaceEnd(), GERBER_LAYER_WIDGET::OnLayerColorChange(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), TREE_PROJECT_FRAME::OnOpenSelectedFileWithTextEditor(), PANEL_COMMON_SETTINGS::OnPDFViewerClick(), DIALOG_PRINT_GENERIC::onPrintButtonClick(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBVIEW_FRAME::OnShowGerberSourceFile(), PANEL_COMMON_SETTINGS::OnTextEditorClick(), OpenPDF(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PCB_PLOT_PARAMS::PCB_PLOT_PARAMS(), pcbnewInitPythonScripting(), PCB_EDIT_FRAME::PrepareLayerIndicator(), TEXTE_PCB::Print(), PCB_TARGET::Print(), ZONE_CONTAINER::Print(), EDGE_MODULE::Print(), TRACK::Print(), TEXTE_MODULE::Print(), DIMENSION::Print(), DRAWSEGMENT::Print(), VIA::Print(), ZONE_CONTAINER::PrintFilledArea(), EDA_3D_VIEWER::Process_Special_Functions(), PyScriptingPath(), EDA_3D_CANVAS::ReloadRequest(), PANEL_EESCHEMA_COLOR_SETTINGS::saveCurrentTheme(), FOOTPRINT_EDIT_FRAME::SaveSettings(), LIB_VIEW_FRAME::SaveSettings(), EDA_3D_VIEWER::SaveSettings(), LIB_EDIT_FRAME::SaveSettings(), GERBVIEW_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), SearchHelpFileFullPath(), DIALOG_EDIT_LINE_STYLE::setColor(), KIWAY::SetLanguage(), GERBVIEW_FRAME::SetLayerColor(), GERBVIEW_FRAME::SetVisibleElementColor(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SystemDirsAppend(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), PANEL_LIBEDIT_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_CONFIGURE_PATHS::TransferDataFromWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::TransferDataToWindow(), PANEL_LIBEDIT_COLOR_SETTINGS::TransferDataToWindow(), PANEL_COMMON_SETTINGS::TransferDataToWindow(), DIALOG_CONFIGURE_PATHS::TransferDataToWindow(), PCB_DRAW_PANEL_GAL::UpdateColors(), PANEL_EESCHEMA_COLOR_SETTINGS::validateFilename(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::WIZARD_3DSHAPE_LIBS_DOWNLOADER(), PCB_CALCULATOR_DATAFILE::WriteHeader(), KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS(), DIALOG_CHOOSE_FOOTPRINT::~DIALOG_CHOOSE_FOOTPRINT(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::~DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_FOOTPRINT_WIZARD_LIST::~DIALOG_FOOTPRINT_WIZARD_LIST(), LIB_EDIT_FRAME::~LIB_EDIT_FRAME(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::~WIZARD_3DSHAPE_LIBS_DOWNLOADER(), and KIGFX::WX_VIEW_CONTROLS::~WX_VIEW_CONTROLS().

◆ PgmOrNull()

PGM_BASE* PgmOrNull ( )

similat to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from a script, not from a kicad appl

Definition at line 112 of file cvpcb/cvpcb.cpp.

113 {
114  return process;
115 }
static PGM_BASE * process
Definition: cvpcb/cvpcb.cpp:88

References process, and program.

Referenced by CINFO3D_VISU::CINFO3D_VISU(), BOARD::ComputeBoundingBox(), and PCB_PLOT_PARAMS::PCB_PLOT_PARAMS().