KiCad PCB EDA Suite
pgm_base.h File Reference

see class PGM_BASE More...

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

Go to the source code of this file.

Classes

class  FILE_HISTORY
 
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 DEFAULT_FILE_HISTORY_SIZE   9
 The default file history size is 9. More...
 
#define MAX_FILE_HISTORY_SIZE   99
 
#define VTBL_ENTRY   virtual
 
#define USE_ICONS_IN_MENUS_KEY   wxT( "UseIconsInMenus" )
 
#define ICON_SCALE_KEY   wxT( "IconScale" )
 
#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" )
 

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
 

Enumerations

enum  FILE_HISTORY_IDS { ID_FILE = 4200, ID_FILE1, ID_FILEMAX = ID_FILE + MAX_FILE_HISTORY_SIZE }
 

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 DEFAULT_FILE_HISTORY_SIZE   9
#define MAX_FILE_HISTORY_SIZE   99

Definition at line 59 of file pgm_base.h.

Referenced by FILE_HISTORY::SetMaxFiles().

#define VTBL_ENTRY   virtual

Typedef Documentation

typedef std::map<wxString, ENV_VAR_ITEM> ENV_VAR_MAP

Definition at line 129 of file pgm_base.h.

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

Definition at line 131 of file pgm_base.h.

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

Definition at line 130 of file pgm_base.h.

Enumeration Type Documentation

Enumerator
ID_FILE 
ID_FILE1 
ID_FILEMAX 

Definition at line 72 of file pgm_base.h.

73 {
74  ID_FILE = 4200,
75  ID_FILE1,
77 };
#define MAX_FILE_HISTORY_SIZE
Definition: pgm_base.h:59

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 66 of file kicad.cpp.

References process, and program.

Referenced by TREEPROJECT_ITEM::Activate(), add_search_paths(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), AddMenuItem(), CONTEXT_MENU::appendCopy(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), WS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), EDA_BASE_FRAME::CheckForAutoSaveFile(), DIALOG_BOM::choosePlugin(), EDA_DRAW_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PROJECT::ConfigSave(), CreateHeaderInfoData(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), PGM_KICAD::Destroy(), 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(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), KIWAY::dso_search_path(), EDA_3D_VIEWER::EDA_3D_VIEWER(), EDA_DRAW_PANEL::EDA_DRAW_PANEL(), FindKicadFile(), NETLIST_EXPORTER_PSPICE::Format(), GERBVIEW_FRAME::GERBVIEW_FRAME(), get_scale_factor(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), BIN_MOD::Init(), KicadDatasPath(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), SCH_LEGACY_PLUGIN_CACHE::Load(), S3D_PLUGIN_MANAGER::loadPlugins(), EDA_DRAW_FRAME::LoadSettings(), APP_KICAD::MacOpenFile(), FOOTPRINT_PREVIEW_PANEL::New(), NETLIST_DIALOG_ADD_PLUGIN::OnBrowsePlugins(), PCB_EDIT_FRAME::OnCloseWindow(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditPlugin(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), TREE_PROJECT_FRAME::OnOpenSelectedFileWithTextEditor(), KICAD_MANAGER_FRAME::OnOpenTextEditor(), PANEL_COMMON_SETTINGS::OnPDFViewerClick(), APP_SINGLE_TOP::OnRun(), GERBVIEW_FRAME::OnShowGerberSourceFile(), PANEL_COMMON_SETTINGS::OnTextEditorClick(), OpenPDF(), PANEL_PREV_3D::PANEL_PREV_3D(), PCB_EDIT_FRAME::PCB_EDIT_FRAME(), pcbnewInitPythonScripting(), PCB_EDIT_FRAME::PrepareLayerIndicator(), preparePreferencesMenu(), PCB_EDIT_FRAME::Process_Special_Functions(), PyScriptingPath(), CVPCB_MAINFRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SearchHelpFileFullPath(), set_wxMenuIcon(), KIWAY::SetLanguage(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SystemDirsAppend(), DIALOG_ERC::TestErc(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), DIALOG_CONFIGURE_PATHS::TransferDataFromWindow(), PANEL_COMMON_SETTINGS::TransferDataToWindow(), DIALOG_CONFIGURE_PATHS::TransferDataToWindow(), WIZARD_3DSHAPE_LIBS_DOWNLOADER::WIZARD_3DSHAPE_LIBS_DOWNLOADER(), CACHE_WRAPPER::~CACHE_WRAPPER(), and WIZARD_3DSHAPE_LIBS_DOWNLOADER::~WIZARD_3DSHAPE_LIBS_DOWNLOADER().

67 {
68  return program;
69 }
static PGM_KICAD program
Definition: kicad.cpp:63