KiCad PCB EDA Suite
pgm_base.h File Reference

see class PGM_BASE More...

#include <map>
#include <memory>
#include <wx/filename.h>
#include <search_stack.h>
#include <wx/gdicmn.h>
#include <bitmaps_png/bitmap_def.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
 
#define USE_ICONS_IN_MENUS_KEY   wxT( "UseIconsInMenus" )
 
#define ICON_SCALE_KEY   wxT( "IconScale" )
 
#define CANVAS_SCALE_KEY   wxT( "CanvasScale" )
 
#define AUTOSAVE_INTERVAL_KEY   wxT( "AutoSaveInterval" )
 
#define ENBL_ZOOM_NO_CENTER_KEY   wxT( "ZoomNoCenter" )
 
#define ENBL_MOUSEWHEEL_PAN_KEY   wxT( "MousewheelPAN" )
 
#define MIDDLE_BUTT_PAN_LIMITED_KEY   wxT( "MiddleBtnPANLimited" )
 
#define ENBL_AUTO_PAN_KEY   wxT( "AutoPAN" )
 
#define FILE_HISTORY_SIZE_KEY   wxT( "FileHistorySize" )
 
#define GAL_DISPLAY_OPTIONS_KEY   wxT( "GalDisplayOptions" )
 
#define GAL_ANTIALIASING_MODE_KEY   wxT( "OpenGLAntialiasingMode" )
 
#define CAIRO_ANTIALIASING_MODE_KEY   wxT( "CairoAntialiasingMode" )
 
#define WARP_MOUSE_ON_MOVE_KEY   wxT( "MoveWarpsCursor" )
 
#define IMMEDIATE_ACTIONS_KEY   wxT( "ImmediateActions" )
 
#define PREFER_SELECT_TO_DRAG_KEY   wxT( "PreferSelectionToDragging" )
 

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 97 of file pgm_base.h.

Typedef Documentation

◆ ENV_VAR_MAP

typedef std::map<wxString, ENV_VAR_ITEM> ENV_VAR_MAP

Definition at line 136 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 138 of file pgm_base.h.

◆ ENV_VAR_MAP_ITER

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

Definition at line 137 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 98 of file single_top.cpp.

99 {
100  return program;
101 }
PGM_SINGLE_TOP program

References process, and program.

Referenced by AddBitmapToMenuItem(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), AddMenuLanguageList(), BM2CMP_FRAME::BM2CMP_FRAME(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), WS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), EDA_BASE_FRAME::CheckForAutoSaveFile(), DIALOG_BOM::chooseGenerator(), EDA_DRAW_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::CommonSettingsChanged(), PROJECT::ConfigSave(), CreateHeaderInfoData(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_SHIM::DIALOG_SHIM(), KIWAY::dso_search_path(), EVT_UPDATE_UI_RANGE(), KICAD_MANAGER_CONTROL::Execute(), FindKicadFile(), NETLIST_EXPORTER_PSPICE::Format(), GERBVIEW_FRAME::GERBVIEW_FRAME(), get_scale_factor(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), BIN_MOD::Init(), DIALOG_BOM::installGeneratorsList(), 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(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), KICAD_MANAGER_CONTROL::NewFromTemplate(), NETLIST_DIALOG_ADD_GENERATOR::OnBrowseGenerators(), PCB_EDIT_FRAME::OnCloseWindow(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditGenerator(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), TREE_PROJECT_FRAME::OnOpenSelectedFileWithTextEditor(), PANEL_COMMON_SETTINGS::OnPDFViewerClick(), DIALOG_PRINT_GENERIC::onPrintButtonClick(), GERBVIEW_FRAME::OnShowGerberSourceFile(), PANEL_COMMON_SETTINGS::OnTextEditorClick(), OpenPDF(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), pcbnewInitPythonScripting(), PCB_EDIT_FRAME::PrepareLayerIndicator(), PyScriptingPath(), SearchHelpFileFullPath(), KIWAY::SetLanguage(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SystemDirsAppend(), DIALOG_ERC::TestErc(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), DIALOG_CONFIGURE_PATHS::TransferDataFromWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::TransferDataToWindow(), PANEL_COMMON_SETTINGS::TransferDataToWindow(), DIALOG_CONFIGURE_PATHS::TransferDataToWindow(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::WIZARD_3DSHAPE_LIBS_DOWNLOADER(), PCB_CALCULATOR_DATAFILE::WriteHeader(), KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS(), 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 110 of file cvpcb/cvpcb.cpp.

111 {
112  return process;
113 }
static PGM_BASE * process
Definition: cvpcb/cvpcb.cpp:86

References process, and program.

Referenced by BOARD::ComputeBoundingBox().