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...
 

Variables

LANGUAGE_DESCR LanguagesList []
 An array containing all the languages that KiCad supports. 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 102 of file single_top.cpp.

103 {
104  return program;
105 }
PGM_SINGLE_TOP program

References process, and program.

Referenced by AddBitmapToMenuItem(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), ACTION_TOOLBAR::AddScaledSeparator(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), BOARD_ADAPTER::BOARD_ADAPTER(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), WS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), EDA_BASE_FRAME::CheckForAutoSaveFile(), DIALOG_BOM::chooseGenerator(), KICAD_MANAGER_FRAME::CloseProject(), EDA_DRAW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), TOOLS_HOLDER::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::CommonSettingsChanged(), CreateHeaderInfoData(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_EXPORT_SVG::CreateSVGFile(), PANEL_COLOR_SETTINGS::createThemeList(), BMP2CMP::IFACE::CreateWindow(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_SHIM::DIALOG_SHIM(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), LIB_DRAWING_TOOLS::DrawShape(), KIWAY::dso_search_path(), EDA_3D_CANVAS::EDA_3D_CANVAS(), EDA_BASE_FRAME::EDA_BASE_FRAME(), BIN_MOD::End(), EVT_TOOL_RANGE(), 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(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), DISPLAY_FOOTPRINTS_FRAME::GetColorSettings(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), PCB_BASE_EDIT_FRAME::GetColorSettings(), EDA_DRAW_FRAME::GetColorSettings(), LIB_EDIT_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_SHEET::GetDefaultFieldName(), PCB_BASE_FRAME::GetFootprintEditorSettings(), GERBVIEW_FRAME::GetGridColor(), GetLastPinLength(), GetLastPinNameSize(), GetLastPinNumSize(), GetLayerColor(), GERBVIEW_FRAME::GetLayerColor(), PCB_BASE_FRAME::GetPcbNewSettings(), KICAD_MANAGER_FRAME::GetProjectFileName(), FOOTPRINT_EDIT_FRAME::GetSettings(), GERBVIEW_FRAME::GetVisibleElementColor(), 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(), loadKicadProject(), S3D_PLUGIN_MANAGER::loadPlugins(), KICAD_MANAGER_FRAME::LoadProject(), PCB_TEST_FRAME_BASE::LoadSettings(), LIB_VIEW_FRAME::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), EDA_3D_VIEWER::LoadSettings(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadWindowSettings(), EDA_BASE_FRAME::LoadWindowState(), main(), SCH_MOVE_TOOL::Main(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_PREVIEW_PANEL::New(), KICAD_MANAGER_CONTROL::NewFromTemplate(), SIM_PLOT_FRAME::NewPlotPanel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), NETLIST_DIALOG_ADD_GENERATOR::OnBrowseGenerators(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditGenerator(), KICAD_MANAGER_FRAME::OnIdle(), GERBER_LAYER_WIDGET::OnLayerColorChange(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), TREE_PROJECT_FRAME::OnOpenSelectedFileWithTextEditor(), PANEL_COMMON_SETTINGS::OnPDFViewerClick(), DIALOG_PRINT_GENERIC::onPrintButtonClick(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PANEL_COMMON_SETTINGS::OnTextEditorClick(), PANEL_COLOR_SETTINGS::OnThemeChanged(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), OpenPDF(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_MODEDIT_COLOR_SETTINGS::PANEL_MODEDIT_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), pcbnewInitPythonScripting(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), DIALOG_PLOT::Plot(), PCB_EDIT_FRAME::PrepareLayerIndicator(), SCH_PRINTOUT::PrintPage(), KIWAY::Prj(), EDA_3D_VIEWER::Process_Special_Functions(), PyScriptingPath(), PCB_EDIT_FRAME::PythonSyncEnvironmentVariables(), SCH::readSchematicFromFile(), EDA_3D_CANVAS::ReloadRequest(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), SCH_EDIT_FRAME::SaveProject(), LIB_VIEW_FRAME::SaveSettings(), EDA_3D_VIEWER::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), GERBVIEW_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), SearchHelpFileFullPath(), GERBVIEW_FRAME::SetGridColor(), KIWAY::SetLanguage(), GERBVIEW_FRAME::SetLayerColor(), SetTopFrame(), EDA_BASE_FRAME::setupUIConditions(), GERBVIEW_FRAME::SetVisibleElementColor(), GERBVIEW_INSPECTION_TOOL::ShowSource(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SystemDirsAppend(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_MODEDIT_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_CONFIGURE_PATHS::TransferDataFromWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_MOUSE_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::TransferDataToWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), PANEL_COMMON_SETTINGS::TransferDataToWindow(), DIALOG_CONFIGURE_PATHS::TransferDataToWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), PANEL_MOUSE_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), PCB_DRAW_PANEL_GAL::UpdateColors(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::WIZARD_3DSHAPE_LIBS_DOWNLOADER(), PCB_CALCULATOR_DATAFILE::WriteHeader(), DIALOG_CHOOSE_FOOTPRINT::~DIALOG_CHOOSE_FOOTPRINT(), DIALOG_FOOTPRINT_WIZARD_LIST::~DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_LIB_SYMBOL_PROPERTIES::~DIALOG_LIB_SYMBOL_PROPERTIES(), LIB_EDIT_FRAME::~LIB_EDIT_FRAME(), S3D_CACHE::~S3D_CACHE(), and WIZARD_3DSHAPE_LIBS_DOWNLOADER::~WIZARD_3DSHAPE_LIBS_DOWNLOADER().

◆ 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 BOARD_ADAPTER::BOARD_ADAPTER(), WS_DRAW_ITEM_LIST::BuildFullText(), BOARD::ComputeBoundingBox(), and LIB_PIN::LIB_PIN().

Variable Documentation

◆ LanguagesList

LANGUAGE_DESCR LanguagesList[]

An array containing all the languages that KiCad supports.

Definition at line 71 of file pgm_base.cpp.

Referenced by AddMenuLanguageList(), PGM_BASE::SetLanguage(), KIWAY::SetLanguage(), PGM_BASE::SetLanguageIdentifier(), and EDA_BASE_FRAME::setupUIConditions().