pgm_base.h File Reference

see class PGM_BASE More...

#include <map>
#include <memory>
#include <search_stack.h>
#include <settings/environment.h>
#include <wx/filename.h>
#include <pybind11/embed.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	PGM_BASE
	Container for data for KiCad programs. More...

Functions
PGM_BASE &	Pgm ()
	The global Program "get" accessor. More...
PGM_BASE *	PgmOrNull ()
	similar 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.

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

{
 return program;
}

References process, and program.

Referenced by AddBitmapToMenuItem(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), ACTION_TOOLBAR::AddScaledSeparator(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), BOARD_ADAPTER::BOARD_ADAPTER(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), DS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::CheckForAutoSaveFile(), KICAD_MANAGER_FRAME::CloseProject(), EDA_BASE_FRAME::commonInit(), PL_EDITOR_FRAME::CommonSettingsChanged(), TOOLS_HOLDER::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::config(), CreateHeaderInfoData(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_EXPORT_SVG::CreateSVGFile(), PANEL_COLOR_SETTINGS::createThemeList(), BMP2CMP::IFACE::CreateWindow(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_PCM::DIALOG_PCM(), DIALOG_SHIM::DIALOG_SHIM(), KICAD_MANAGER_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), drawShapes(), KIWAY::dso_search_path(), EDA_3D_CANVAS::EDA_3D_CANVAS(), EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER(), BIN_MOD::End(), EVT_TOOL_RANGE(), EVT_UPDATE_UI_RANGE(), KICAD_MANAGER_CONTROL::Execute(), APP_SINGLE_TOP::FilterEvent(), APP_KICAD::FilterEvent(), FindKicadFile(), NETLIST_EXPORTER_PSPICE::Format(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_FRAME::GERBVIEW_FRAME(), get_scale_factor(), SCH_MARKER::getColor(), PCB_MARKER::getColor(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), DISPLAY_FOOTPRINTS_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), EDA_DRAW_FRAME::GetColorSettings(), PCB_BASE_EDIT_FRAME::GetColorSettings(), SYMBOL_EDIT_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_SHEET::GetDefaultFieldName(), PCB_BASE_FRAME::GetFootprintEditorSettings(), GERBVIEW_FRAME::GetGridColor(), getGUIFont(), GetLastPinLength(), GetLastPinNameSize(), GetLastPinNumSize(), GetLayerColor(), GERBVIEW_FRAME::GetLayerColor(), PCB_BASE_FRAME::GetPcbNewSettings(), KICAD_MANAGER_FRAME::GetProjectFileName(), FOOTPRINT_EDIT_FRAME::GetSettings(), PATHS::GetStockDataPath(), PATHS::GetStockPlugins3DPath(), PATHS::GetStockPluginsPath(), GERBVIEW_FRAME::GetVisibleElementColor(), init_unit_test(), BOARD_ADAPTER::InitSettings(), KIUI::IsModalDialogFocused(), KICAD_CURL_EASY::KICAD_CURL_EASY(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), SETTINGS_MANAGER::loadAllColorSettings(), EDA_3D_VIEWER_FRAME::loadCommonSettings(), SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), loadKicadProject(), KICAD_MANAGER_FRAME::LoadProject(), PCB_TEST_FRAME_BASE::LoadSettings(), SYMBOL_VIEWER_FRAME::LoadSettings(), PANEL_PREVIEW_3D_MODEL::loadSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadWindowSettings(), EDA_BASE_FRAME::LoadWindowState(), main(), SCH_MOVE_TOOL::Main(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_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(), NETLIST_DIALOG_ADD_GENERATOR::OnBrowseGenerators(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_PACKAGES_VIEW::OnDownloadVersionClicked(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditGenerator(), DIALOG_CONFIGURE_PATHS::OnGridCellChanging(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_PCM::OnManageRepositoriesClicked(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), PROJECT_TREE_PANE::onOpenSelectedFileWithTextEditor(), PANEL_COMMON_SETTINGS::OnPDFViewerClick(), DIALOG_PRINT_GENERIC::onPrintButtonClick(), PANEL_COMMON_SETTINGS::OnTextEditorClick(), PANEL_COLOR_SETTINGS::OnThemeChanged(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), OpenPDF(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), SCH_BASE_FRAME::PickSymbolFromLibTree(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), playground_main_func(), DIALOG_PLOT::Plot(), PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER(), PCB_EDIT_FRAME::PrepareLayerIndicator(), SCH_PRINTOUT::PrintPage(), KIWAY::Prj(), EDA_3D_VIEWER_FRAME::Process_Special_Functions(), EDA_BASE_FRAME::ProcessEvent(), PCB_EDIT_FRAME::PythonSyncEnvironmentVariables(), SCH::readSchematicFromFile(), EDA_3D_CANVAS::ReloadRequest(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), SYMBOL_VIEWER_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), GERBVIEW_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), SearchHelpFileFullPath(), GERBVIEW_FRAME::SetGridColor(), KIWAY::SetLanguage(), PGM_BASE::SetLanguagePath(), GERBVIEW_FRAME::SetLayerColor(), PANEL_PACKAGES_VIEW::SetSashOnIdle(), SetTopFrame(), EDA_BASE_FRAME::setupUIConditions(), GERBVIEW_FRAME::SetVisibleElementColor(), COMMON_CONTROL::ShowHelp(), GERBVIEW_INSPECTION_TOOL::ShowSource(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SystemDirsAppend(), BITMAP_STORE::ThemeChanged(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_3D_COLORS::TransferDataFromWindow(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), DIALOG_CONFIGURE_PATHS::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_3D_COLORS::TransferDataToWindow(), DIALOG_CONFIGURE_PATHS::TransferDataToWindow(), PANEL_COMMON_SETTINGS::TransferDataToWindow(), PANEL_MOUSE_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PCB_CONTROL::unfilledZoneCheck(), PCB_DRAW_PANEL_GAL::UpdateColors(), PCB_CALCULATOR_DATAFILE::WriteHeader(), DIALOG_CHOOSE_FOOTPRINT::~DIALOG_CHOOSE_FOOTPRINT(), DIALOG_FOOTPRINT_WIZARD_LIST::~DIALOG_FOOTPRINT_WIZARD_LIST(), PANEL_PACKAGES_VIEW::~PANEL_PACKAGES_VIEW(), PANEL_SETUP_NETCLASSES::~PANEL_SETUP_NETCLASSES(), S3D_CACHE::~S3D_CACHE(), and SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME().

PgmOrNull()

PGM_BASE* PgmOrNull

(

)

similar 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 125 of file cvpcb.cpp.

{
 return process;
}

References process, and program.

Referenced by BOARD_ADAPTER::BOARD_ADAPTER(), DS_DRAW_ITEM_LIST::BuildFullText(), BOARD::ComputeBoundingBox(), LIB_PIN::LIB_PIN(), and ACTION_PLUGINS::register_action().

Variable Documentation

LanguagesList

LANGUAGE_DESCR LanguagesList[]

An array containing all the languages that KiCad supports.

Definition at line 70 of file pgm_base.cpp.

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