PCB::IFACE Struct Reference

Inheritance diagram for PCB::IFACE:

Public Member Functions
	IFACE (const char *aName, KIWAY::FACE_T aType)
bool	OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
	Typically start_common() is called from here. More...
void	OnKifaceEnd () override
	Called just once just before the DSO is to be unloaded. More...
wxWindow *	CreateKiWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
	Create a wxWindow for the current project. More...
void *	IfaceOrAddress (int aDataId) override
	Return a pointer to the requested object. More...
void	SaveFileAs (const wxString &aProjectBasePath, const wxString &aSrcProjectName, const wxString &aNewProjectBasePath, const wxString &aNewProjectName, const wxString &aSrcFilePath, wxString &aErrors) override
	Saving a file under a different name is delegated to the various KIFACEs because the project doesn't know the internal format of the various files (which may have paths in them that need updating). More...
int	HandleJob (JOB *aJob) override
const wxString	Name ()
APP_SETTINGS_BASE *	KifaceSettings () const
void	InitSettings (APP_SETTINGS_BASE *aSettings)
int	StartFlags () const
	Return whatever was passed as aCtlBits to OnKifaceStart(). More...
bool	IsSingle () const
	Is this KIFACE running under single_top? More...
const wxString &	GetHelpFileName () const
	Return just the basename portion of the current help file. More...
SEARCH_STACK &	KifaceSearch ()
	Only for DSO specific 'non-library' files. More...
void	GetActions (std::vector< TOOL_ACTION * > &aActions) const override
	Append this Kiface's registered actions to the given list. More...
EDA_UNITS	GetUserUnits () const
void	SetUserUnits (EDA_UNITS aUnits)
const EDA_IU_SCALE &	GetIuScale () const
virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()
wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aValue in internal units into a united string. More...
wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)
wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	A lower-precision version of StringFromValue(). More...
wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)
int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aTextValue in aUnits to internal units used by the frame. More...
EDA_ANGLE	AngleValueFromString (const wxString &aTextValue)

Protected Member Functions
bool	start_common (int aCtlBits)
	Common things to do for a top program module, during OnKifaceStart(). More...
void	end_common ()
	Common things to do for a top program module, during OnKifaceEnd();. More...

Private Attributes
std::unique_ptr< PCBNEW_JOBS_HANDLER >	m_jobHandler
KIWAY::FACE_T	m_id
BIN_MOD	m_bm
int	m_start_flags
	flags provided in OnKifaceStart() More...
const EDA_IU_SCALE &	m_iuScale
EDA_UNITS	m_userUnits

Detailed Description

Definition at line 73 of file pcbnew.cpp.

Constructor & Destructor Documentation

IFACE()

PCB::IFACE::IFACE ( const char *  aName, KIWAY::FACE_T  aType  )

inline

Definition at line 77 of file pcbnew.cpp.

 :
 KIFACE_BASE( aName, aType ),
 UNITS_PROVIDER( pcbIUScale, EDA_UNITS::MILLIMETRES )
 {}

References MILLIMETRES.

Member Function Documentation

AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString &  aTextValue )

inlineinherited

Definition at line 116 of file units_provider.h.

 {
 double angle = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), EDA_UNITS::DEGREES,
 aTextValue );
 
 return EDA_ANGLE( angle, DEGREES_T );
 }

References PNS::angle(), DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by FP_TEXT_GRID_TABLE::SetValue().

CreateKiWindow()

wxWindow * PCB::IFACE::CreateKiWindow ( wxWindow *  aParent, int  aClassId, KIWAY *  aKIWAY, int  aCtlBits = 0  )

inlineoverridevirtual

Create a wxWindow for the current project.

The caller must cast the return value into the known type.

Parameters

aParent	may be NULL or is otherwise the parent to connect under. If NULL then caller may want to connect the returned wxWindow into some hierarchy after this function returns.
aClassId	identifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE.
aKIWAY	tells the window which KIWAY (and PROJECT) it is a participant in.
aCtlBits	consists of bit flags from the set of KFCTL_* #defines above.

Returns

the window created and if not NULL, should be cast into the known type using and old school cast. dynamic_cast is problematic since it needs typeinfo probably not contained in the caller's link image.

Implements KIFACE_BASE.

Definition at line 86 of file pcbnew.cpp.

 {
 switch( aClassId )
 {
 case FRAME_PCB_EDITOR:
 {
 auto frame = new PCB_EDIT_FRAME( aKiway, aParent );
 
 // give the scripting helpers access to our frame
 ScriptingSetPcbEditFrame( frame );
 
 if( Kiface().IsSingle() )
 {
 // only run this under single_top, not under a project manager.
 frame->CreateServer( KICAD_PCB_PORT_SERVICE_NUMBER );
 }
 
 return frame;
 }
 
 case FRAME_FOOTPRINT_EDITOR:
 return new FOOTPRINT_EDIT_FRAME( aKiway, aParent );
 
 case FRAME_FOOTPRINT_VIEWER:
 case FRAME_FOOTPRINT_VIEWER_MODAL:
 return new FOOTPRINT_VIEWER_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
 
 case FRAME_FOOTPRINT_WIZARD:
 return new FOOTPRINT_WIZARD_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
 
 case FRAME_FOOTPRINT_PREVIEW:
 return dynamic_cast< wxWindow* >( FOOTPRINT_PREVIEW_PANEL::New( aKiway, aParent ) );
 
 case DIALOG_CONFIGUREPATHS:
 {
 DIALOG_CONFIGURE_PATHS dlg( aParent );
 
 // The dialog's constructor probably failed to set its Kiway because the
 // dynamic_cast fails when aParent was allocated by a separate compilation
 // module. So set it directly.
 dlg.SetKiway( &dlg, aKiway );
 
 // Use QuasiModal so that HTML help window will work
 if( dlg.ShowQuasiModal() == wxID_OK )
 aKiway->CommonSettingsChanged( true, false );
 
 // Dialog has completed; nothing to return.
 return nullptr;
 }
 
 case DIALOG_PCB_LIBRARY_TABLE:
 InvokePcbLibTableEditor( aKiway, aParent );
 // Dialog has completed; nothing to return.
 return nullptr;
 
 case PANEL_FP_DISPLAY_OPTIONS:
 {
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
 
 return new PANEL_DISPLAY_OPTIONS( aParent, cfg );
 }
 
 case PANEL_FP_EDIT_OPTIONS:
 {
 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
 
 if( !frame )
 frame = aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
 
 if( !frame )
 frame = aKiway->Player( FRAME_PCB_EDITOR, false );
 
 if( frame )
 return new PANEL_EDIT_OPTIONS( aParent, frame, frame, true );
 else
 return new PANEL_EDIT_OPTIONS( aParent, this, nullptr, true );
 }
 
 case PANEL_FP_DEFAULT_VALUES:
 {
 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
 
 if( !frame )
 frame = aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
 
 if( !frame )
 frame = aKiway->Player( FRAME_PCB_EDITOR, false );
 
 if( frame )
 return new PANEL_FP_EDITOR_DEFAULTS( aParent, frame );
 else
 return new PANEL_FP_EDITOR_DEFAULTS( aParent, this );
 }
 
 case PANEL_FP_COLORS:
 return new PANEL_FP_EDITOR_COLOR_SETTINGS( aParent );
 
 case PANEL_PCB_DISPLAY_OPTIONS:
 {
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<PCBNEW_SETTINGS>();
 
 return new PANEL_DISPLAY_OPTIONS( aParent, cfg );
 }
 
 case PANEL_PCB_EDIT_OPTIONS:
 {
 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_PCB_EDITOR, false );
 
 if( !frame )
 frame = aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
 
 if( !frame )
 frame = aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
 
 if( frame )
 return new PANEL_EDIT_OPTIONS( aParent, frame, frame, false );
 else
 return new PANEL_EDIT_OPTIONS( aParent, this, nullptr, false );
 }
 
 case PANEL_PCB_COLORS:
 {
 BOARD* board = nullptr;
 EDA_BASE_FRAME* boardProvider = aKiway->Player( FRAME_PCB_EDITOR, false );
 
 if( boardProvider )
 board = static_cast<PCB_EDIT_FRAME*>( boardProvider )->GetBoard();
 
 return new PANEL_PCBNEW_COLOR_SETTINGS( aParent, board );
 }
 
 case PANEL_PCB_ACTION_PLUGINS:
 return new PANEL_PCBNEW_ACTION_PLUGINS( aParent );
 
 case PANEL_PCB_ORIGINS_AXES:
 return new PANEL_PCBNEW_DISPLAY_ORIGIN( aParent );
 
 case PANEL_3DV_DISPLAY_OPTIONS:
 return new PANEL_3D_DISPLAY_OPTIONS( aParent );
 
 case PANEL_3DV_OPENGL:
 return new PANEL_3D_OPENGL_OPTIONS( aParent );
 
 case PANEL_3DV_RAYTRACING:
 return new PANEL_3D_RAYTRACING_OPTIONS( aParent );
 
 case PANEL_3DV_COLORS:
 return new PANEL_3D_COLORS( aParent );
 
 default:
 return nullptr;
 }
 }

References KIWAY::CommonSettingsChanged(), DIALOG_CONFIGUREPATHS, DIALOG_PCB_LIBRARY_TABLE, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_PREVIEW, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, FRAME_FOOTPRINT_WIZARD, FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), InvokePcbLibTableEditor(), KIFACE_BASE::IsSingle(), KICAD_PCB_PORT_SERVICE_NUMBER, Kiface(), FOOTPRINT_PREVIEW_PANEL::New(), PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, Pgm(), KIWAY::Player(), ScriptingSetPcbEditFrame(), KIWAY_HOLDER::SetKiway(), and DIALOG_SHIM::ShowQuasiModal().

end_common()

void KIFACE_BASE::end_common ( )

protectedinherited

Common things to do for a top program module, during OnKifaceEnd();.

Definition at line 42 of file kiface_base.cpp.

{
 m_bm.End();
}

References BIN_MOD::End(), and KIFACE_BASE::m_bm.

Referenced by CV::IFACE::OnKifaceEnd(), SCH::IFACE::OnKifaceEnd(), GERBV::IFACE::OnKifaceEnd(), KIFACE_BASE::OnKifaceEnd(), PGE::IFACE::OnKifaceEnd(), PCBCALC::IFACE::OnKifaceEnd(), and OnKifaceEnd().

GetActions()

void KIFACE_BASE::GetActions ( std::vector< TOOL_ACTION * > &  aActions ) const

inlineoverridevirtualinherited

Append this Kiface's registered actions to the given list.

Implements KIFACE.

Definition at line 116 of file kiface_base.h.

 {
 for( TOOL_ACTION* action : ACTION_MANAGER::GetActionList() )
 aActions.push_back( action );
 }

References ACTION_MANAGER::GetActionList().

GetHelpFileName()

const wxString & KIFACE_BASE::GetHelpFileName ( ) const

inlineinherited

Return just the basename portion of the current help file.

Definition at line 110 of file kiface_base.h.

{ return m_bm.m_help_file; }

References KIFACE_BASE::m_bm, and BIN_MOD::m_help_file.

Referenced by EDA_BASE_FRAME::help_name().

GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

{ return m_iuScale; }

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & UNITS_PROVIDER::GetOriginTransforms ( )

inlinevirtualinherited

Reimplemented in EDA_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 48 of file units_provider.h.

 {
 static ORIGIN_TRANSFORMS identityTransform;
 
 return identityTransform;
 }

GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 42 of file units_provider.h.

{ return m_userUnits; }

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PG_UNIT_EDITOR::CreateControls(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDIT_FRAME::GenFootprintsReport(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateUserUnits(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

HandleJob()

int IFACE::HandleJob ( JOB *  aJob )

overridevirtual

Reimplemented from KIFACE.

Definition at line 485 of file pcbnew.cpp.

{
 return m_jobHandler->RunJob( aJob );
}

References m_jobHandler.

IfaceOrAddress()

void * PCB::IFACE::IfaceOrAddress ( int  aDataId )

inlineoverridevirtual

Return a pointer to the requested object.

The safest way to use this is to retrieve a pointer to a static instance of an interface, similar to how the KIFACE interface is exported. But if you know what you are doing use it to retrieve anything you want.

Parameters

aDataId

identifies which object you want the address of.

Returns

the object which must be cast into the know type.

Implements KIFACE_BASE.

Definition at line 253 of file pcbnew.cpp.

 {
 switch( aDataId )
 {
 // Return a pointer to the global instance of the footprint list.
 case KIFACE_FOOTPRINT_LIST:
 return (void*) &GFootprintList;
 
 // Return a new FP_LIB_TABLE with the global table installed as a fallback.
 case KIFACE_NEW_FOOTPRINT_TABLE:
 return (void*) new FP_LIB_TABLE( &GFootprintTable );
 
 // Return a pointer to the global instance of the global footprint table.
 case KIFACE_GLOBAL_FOOTPRINT_TABLE:
 return (void*) &GFootprintTable;
 
 case KIFACE_SCRIPTING_LEGACY:
 return reinterpret_cast<void*>( PyInit__pcbnew );
 
 default:
 return nullptr;
 }
 }

References GFootprintList, GFootprintTable, KIFACE_FOOTPRINT_LIST, KIFACE_GLOBAL_FOOTPRINT_TABLE, KIFACE_NEW_FOOTPRINT_TABLE, KIFACE_SCRIPTING_LEGACY, and PyInit__pcbnew().

InitSettings()

void KIFACE_BASE::InitSettings ( APP_SETTINGS_BASE *  aSettings )

inlineinherited

Definition at line 95 of file kiface_base.h.

{ m_bm.InitSettings( aSettings ); }

References BIN_MOD::InitSettings(), and KIFACE_BASE::m_bm.

Referenced by BMP2CMP::IFACE::CreateKiWindow(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), and OnKifaceStart().

IsSingle()

bool KIFACE_BASE::IsSingle ( ) const

inlineinherited

Is this KIFACE running under single_top?

Definition at line 105 of file kiface_base.h.

{ return m_start_flags & KFCTL_STANDALONE; }

References KFCTL_STANDALONE, and KIFACE_BASE::m_start_flags.

Referenced by ACTION_MENU::AddQuitOrClose(), SCH::IFACE::CreateKiWindow(), CreateKiWindow(), DIALOG_DRC::DIALOG_DRC(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::SendSelectItemsToPcb().

KifaceSearch()

SEARCH_STACK & KIFACE_BASE::KifaceSearch ( )

inlineinherited

Only for DSO specific 'non-library' files.

(The library search path is in the PROJECT class.)

Definition at line 114 of file kiface_base.h.

{ return m_bm.m_search; }

References KIFACE_BASE::m_bm, and BIN_MOD::m_search.

Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DS_DATA_MODEL::ResolvePath(), and EDA_BASE_FRAME::sys_search().

KifaceSettings()

APP_SETTINGS_BASE * KIFACE_BASE::KifaceSettings ( ) const

inlineinherited

Definition at line 93 of file kiface_base.h.

{ return m_bm.m_config; }

References KIFACE_BASE::m_bm, and BIN_MOD::m_config.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::AddField(), AUTOPLACER::AUTOPLACER(), EDA_BASE_FRAME::config(), BMP2CMP::IFACE::CreateKiWindow(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_ERC::DIALOG_ERC(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_PRINT_GERBVIEW::DIALOG_PRINT_GERBVIEW(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), KIGFX::eeconfig(), PCB_PLUGIN::FootprintSave(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), LAYERS_MAP_DIALOG::initDialog(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_ANNOTATE::InitValues(), DIALOG_EXPORT_NETLIST::InstallCustomPages(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), LAYERS_MAP_DIALOG::OnGetSetup(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), OnKifaceStart(), DIALOG_RESCUE_EACH::OnNeverShowClick(), SCH_EDIT_FRAME::OnResizeHierarchyNavigator(), LAYERS_MAP_DIALOG::OnStoreSetup(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize(), DIALOG_EESCHEMA_PAGE_SETTINGS::onTransferDataToWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), pcbconfig(), TRANSLINE_IDENT::ReadConfig(), PCB_EDIT_FRAME::redrawNetnames(), EDA_DRAW_FRAME::saveCanvasTypeSetting(), LIB_TREE_MODEL_ADAPTER::SaveSettings(), PCB_CALCULATOR_FRAME::SaveSettings(), PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow(), RATSNEST_VIEW_ITEM::ViewDraw(), TRANSLINE_IDENT::WriteConfig(), DIALOG_EXPORT_NETLIST::WriteCurrentNetlistSetup(), DIALOG_ANNOTATE::~DIALOG_ANNOTATE(), DIALOG_COLOR_PICKER::~DIALOG_COLOR_PICKER(), DIALOG_EESCHEMA_PAGE_SETTINGS::~DIALOG_EESCHEMA_PAGE_SETTINGS(), DIALOG_ERC::~DIALOG_ERC(), DIALOG_LABEL_PROPERTIES::~DIALOG_LABEL_PROPERTIES(), DIALOG_SHEET_PROPERTIES::~DIALOG_SHEET_PROPERTIES(), and DIALOG_SYMBOL_PROPERTIES::~DIALOG_SYMBOL_PROPERTIES().

MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( const EDA_ANGLE &  aValue, bool  aAddUnitLabel = true  )

inlineinherited

Definition at line 94 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( double  aValue, bool  aAddUnitLabel = true, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  )

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 87 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by CheckLibSymbol(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), DIALOG_NET_INSPECTOR::formatLength(), DRC_TEST_PROVIDER::formatMsg(), LIB_SHAPE::GetItemDescription(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_BITMAP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), TEXT_SEARCH_HANDLER::GetResultCell(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

Name()

const wxString KIFACE_BASE::Name ( )

inlineinherited

Definition at line 88 of file kiface_base.h.

 {
 return wxString::FromUTF8( m_bm.m_name );
 }

References KIFACE_BASE::m_bm, and BIN_MOD::m_name.

OnKifaceEnd()

void IFACE::OnKifaceEnd ( )

overridevirtual

Called just once just before the DSO is to be unloaded.

It is called before static C++ destructors are called. A default implementation is supplied.

Reimplemented from KIFACE_BASE.

Definition at line 391 of file pcbnew.cpp.

{
 end_common();
}

References KIFACE_BASE::end_common().

OnKifaceStart()

bool IFACE::OnKifaceStart ( PGM_BASE *  aProgram, int  aCtlBits  )

overridevirtual

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 341 of file pcbnew.cpp.

{
 // This is process-level-initialization, not project-level-initialization of the DSO.
 // Do nothing in here pertinent to a project!
 InitSettings( new PCBNEW_SETTINGS );
 aProgram->GetSettingsManager().RegisterSettings( KifaceSettings() );
 
 start_common( aCtlBits );
 
 wxFileName fn = FP_LIB_TABLE::GetGlobalTableFileName();
 
 if( !fn.FileExists() )
 {
 if( !( aCtlBits & KFCTL_CLI ) )
 {
 DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG fpDialog( nullptr );
 
 fpDialog.ShowModal();
 }
 }
 else
 {
 try
 {
 // The global table is not related to a specific project. All projects
 // will use the same global table. So the KIFACE::OnKifaceStart() contract
 // of avoiding anything project specific is not violated here.
 if( !FP_LIB_TABLE::LoadGlobalTable( GFootprintTable ) )
 return false;
 }
 catch( const IO_ERROR& ioe )
 {
 // if we are here, a incorrect global footprint library table was found.
 // Incorrect global symbol library table is not a fatal error:
 // the user just has to edit the (partially) loaded table.
 wxString msg = _( "An error occurred attempting to load the global footprint library "
 "table.\n"
 "Please edit this global footprint library table in Preferences "
 "menu." );
 
 DisplayErrorMessage( nullptr, msg, ioe.What() );
 }
 }
 
 m_jobHandler = std::make_unique<PCBNEW_JOBS_HANDLER>();
 
 return true;
}

References _, aProgram, DisplayErrorMessage(), FP_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetSettingsManager(), GFootprintTable, KIFACE_BASE::InitSettings(), KFCTL_CLI, KIFACE_BASE::KifaceSettings(), FP_LIB_TABLE::LoadGlobalTable(), m_jobHandler, SETTINGS_MANAGER::RegisterSettings(), KIFACE_BASE::start_common(), and IO_ERROR::What().

SaveFileAs()

void IFACE::SaveFileAs ( const wxString &  aProjectBasePath, const wxString &  aSrcProjectName, const wxString &  aNewProjectBasePath, const wxString &  aNewProjectName, const wxString &  aSrcFilePath, wxString &  aErrors  )

overridevirtual

Saving a file under a different name is delegated to the various KIFACEs because the project doesn't know the internal format of the various files (which may have paths in them that need updating).

Reimplemented from KIFACE.

Definition at line 397 of file pcbnew.cpp.

{
 wxFileName destFile( aSrcFilePath );
 wxString destPath = destFile.GetPathWithSep();
 wxUniChar pathSep = wxFileName::GetPathSeparator();
 wxString ext = destFile.GetExt();
 
 if( destPath.StartsWith( aProjectBasePath + pathSep ) )
 destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
 
 wxString srcProjectFootprintLib = pathSep + aSrcProjectName + wxT( ".pretty" ) + pathSep;
 wxString newProjectFootprintLib = pathSep + aNewProjectName + wxT( ".pretty" ) + pathSep;
 
 destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib, true );
 
 destFile.SetPath( destPath );
 
 if( ext == KiCadPcbFileExtension || ext == KiCadPcbFileExtension + BackupFileSuffix )
 {
 if( destFile.GetName() == aSrcProjectName )
 destFile.SetName( aNewProjectName );
 
 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
 }
 else if( ext == LegacyPcbFileExtension )
 {
 if( destFile.GetName() == aSrcProjectName )
 destFile.SetName( aNewProjectName );
 
 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
 }
 else if( ext == LegacyFootprintLibPathExtension || ext == KiCadFootprintFileExtension )
 {
 // Footprints are not project-specific. Keep their source names.
 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
 }
 else if( ext == FootprintAssignmentFileExtension )
 {
 // TODO
 }
 else if( ext == wxT( "rpt" ) )
 {
 // DRC must be the "gold standard". Since we can't guarantee that there aren't
 // any non-deterministic cases in the save-as algorithm, we don't want to certify
 // the result with the source's DRC report. Therefore copy it under the old
 // name.
 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
 }
 else if( destFile.GetName() == wxT( "fp-lib-table" ) )
 {
 try
 {
 FP_LIB_TABLE fpLibTable;
 fpLibTable.Load( aSrcFilePath );
 
 for( unsigned i = 0; i < fpLibTable.GetCount(); i++ )
 {
 LIB_TABLE_ROW& row = fpLibTable.At( i );
 wxString uri = row.GetFullURI();
 
 uri.Replace( wxT( "/" ) + aSrcProjectName + wxT( ".pretty" ),
 wxT( "/" ) + aNewProjectName + wxT( ".pretty" ) );
 
 row.SetFullURI( uri );
 }
 
 fpLibTable.Save( destFile.GetFullPath() );
 }
 catch( ... )
 {
 wxString msg;
 
 if( !aErrors.empty() )
 aErrors += wxT( "\n" );
 
 msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
 aErrors += msg;
 }
 }
 else
 {
 wxFAIL_MSG( wxT( "Unexpected filetype for Pcbnew::SaveFileAs()" ) );
 }
}

References _, LIB_TABLE::At(), BackupFileSuffix, FootprintAssignmentFileExtension, LIB_TABLE::GetCount(), LIB_TABLE_ROW::GetFullURI(), KiCadFootprintFileExtension, KiCadPcbFileExtension, KiCopyFile(), LegacyFootprintLibPathExtension, LegacyPcbFileExtension, LIB_TABLE::Load(), LIB_TABLE::Save(), and LIB_TABLE_ROW::SetFullURI().

SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS  aUnits )

inlineinherited

Definition at line 43 of file units_provider.h.

{ m_userUnits = aUnits; }

References UNITS_PROVIDER::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), DRC_ENGINE::RunTests(), and EDA_DRAW_FRAME::ToggleUserUnits().

start_common()

bool KIFACE_BASE::start_common ( int  aCtlBits )

protectedinherited

Common things to do for a top program module, during OnKifaceStart().

Definition at line 32 of file kiface_base.cpp.

{
 m_start_flags = aCtlBits;
 m_bm.Init();
 GlobalPathsAppend( &m_bm.m_search, m_id );
 
 return true;
}

References GlobalPathsAppend(), BIN_MOD::Init(), KIFACE_BASE::m_bm, KIFACE_BASE::m_id, BIN_MOD::m_search, and KIFACE_BASE::m_start_flags.

Referenced by BMP2CMP::IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), and OnKifaceStart().

StartFlags()

int KIFACE_BASE::StartFlags ( ) const

inlineinherited

Return whatever was passed as aCtlBits to OnKifaceStart().

Definition at line 100 of file kiface_base.h.

{ return m_start_flags; }

References KIFACE_BASE::m_start_flags.

StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue ( const EDA_ANGLE &  aValue, bool  aAddUnitLabel = false  )

inlineinherited

Definition at line 74 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue ( double  aValue, bool  aAddUnitLabel = false, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  )

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 67 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::StringFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PANEL_SETUP_BOARD_STACKUP::createRowData(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FP_TEXT_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

ValueFromString()

int UNITS_PROVIDER::ValueFromString ( const wxString &  aTextValue, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  )

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aTextValue

A reference to a wxString object containing the string to convert.

Returns

internal units value

Definition at line 108 of file units_provider.h.

 {
 double value = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), GetUserUnits(),
 aTextValue, aType );
 
 return KiROUND<double, int>( value );
 }

References EDA_UNIT_UTILS::UI::DoubleValueFromString(), UNITS_PROVIDER::GetIuScale(), and UNITS_PROVIDER::GetUserUnits().

Referenced by PIN_TABLE_DATA_MODEL::compare(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onCopperLayersSelCount(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortDiffPairsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortTrackWidthsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortViaSizesClick(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::Validate().

Member Data Documentation

m_bm

BIN_MOD KIFACE_BASE::m_bm

privateinherited

Definition at line 125 of file kiface_base.h.

Referenced by KIFACE_BASE::end_common(), KIFACE_BASE::GetHelpFileName(), KIFACE_BASE::InitSettings(), KIFACE_BASE::KifaceSearch(), KIFACE_BASE::KifaceSettings(), KIFACE_BASE::Name(), and KIFACE_BASE::start_common().

m_id

KIWAY::FACE_T KIFACE_BASE::m_id

privateinherited

Definition at line 123 of file kiface_base.h.

Referenced by KIFACE_BASE::start_common().

m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 125 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

m_jobHandler

std::unique_ptr<PCBNEW_JOBS_HANDLER> PCB::IFACE::m_jobHandler

private

Definition at line 289 of file pcbnew.cpp.

Referenced by HandleJob(), and OnKifaceStart().

m_start_flags

int KIFACE_BASE::m_start_flags

privateinherited

flags provided in OnKifaceStart()

Definition at line 127 of file kiface_base.h.

Referenced by KIFACE_BASE::IsSingle(), KIFACE_BASE::start_common(), and KIFACE_BASE::StartFlags().

m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 126 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetUserUnits(), and UNITS_PROVIDER::SetUserUnits().

---

The documentation for this struct was generated from the following file:

• pcbnew.cpp