KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_edit_frame.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef FOOTPRINT_EDIT_FRAME_H
21#define FOOTPRINT_EDIT_FRAME_H
22
23#include <pcb_base_frame.h>
24#include <pcb_base_edit_frame.h>
25#include <pcb_io/pcb_io_mgr.h>
27
29class FP_LIB_TABLE;
33class EDA_LIST_DIALOG;
34
35namespace PCB { struct IFACE; } // A KIFACE coded in pcbnew.cpp
36
37
39{
40public:
42
47 static const wxChar* GetFootprintEditorFrameName();
48
50 BOARD_ITEM_CONTAINER* GetModel() const override;
52
58 bool IsContentModified() const override;
59
60 bool IsCurrentFPFromBoard() const;
61
62 bool CanCloseFPFromBoard( bool doClose );
63
65
69 EDA_ANGLE GetRotationAngle() const override;
70
71 APP_SETTINGS_BASE* config() const override;
72
74
75 const PCB_PLOT_PARAMS& GetPlotSettings() const override;
76 void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings ) override;
77
79
80 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
81 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
82
83 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
84
85 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
86
87 bool canCloseWindow( wxCloseEvent& Event ) override;
88 void doCloseWindow() override;
89 void CloseFootprintEditor( wxCommandEvent& Event );
90 void OnExitKiCad( wxCommandEvent& aEvent );
91
97 void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
98
103 void UpdateUserInterface();
104
106 void UpdateMsgPanel() override;
107
111 void HardRedraw() override;
112
116 void ReCreateHToolbar() override;
117
118 void ReCreateVToolbar() override;
119 void ReCreateOptToolbar() override;
120 void UpdateToolbarControlSizes() override;
121
130 void ReCreateLayerBox( bool aForceResizeToolbar = true );
131
132 void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
133
134 void SelectLayer( wxCommandEvent& event );
135
136 // The Tool Framework initialization, for GAL mode
137 void setupTools();
138
139 void OnSaveFootprintAsPng( wxCommandEvent& event );
140
141 bool IsSearchTreeShown() const;
142 void ToggleSearchTree();
143 void ToggleLayersManager();
144
152 bool SaveLibraryAs( const wxString& aLibraryPath );
153
154 void OnUpdateLoadFootprintFromBoard( wxUpdateUIEvent& aEvent );
155 void OnUpdateSaveFootprintToBoard( wxUpdateUIEvent& aEvent );
156
158 void OnEditItemRequest( BOARD_ITEM* aItem ) override;
159
163 void OnLoadFootprintFromBoard( wxCommandEvent& event );
164
165 void OnSaveFootprintToBoard( wxCommandEvent& event );
166
167 void LoadFootprintFromLibrary( LIB_ID aFPID );
168
172 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& GetLibTreeAdapter() { return m_adapter; }
173
180 bool SaveFootprint( FOOTPRINT* aFootprint );
181 bool DuplicateFootprint( FOOTPRINT* aFootprint );
182 bool SaveFootprintAs( FOOTPRINT* aFootprint );
183 bool SaveFootprintToBoard( bool aAddNew );
184 bool SaveFootprintInLibrary( FOOTPRINT* aFootprint, const wxString& aLibraryName );
185 bool RevertFootprint();
186
193 void OnModify() override;
194
201 bool Clear_Pcb( bool doAskAboutUnsavedChanges );
202
204 LIB_ID GetTreeFPID() const;
205
207
209 LIB_ID GetLoadedFPID() const;
210
213 LIB_ID GetTargetFPID() const;
214
215 void ClearModify();
216
220 void ExportFootprint( FOOTPRINT* aFootprint );
221
228 FOOTPRINT* ImportFootprint( const wxString& aName = wxT( "" ) );
229
237 bool LoadFootprintFromBoard( FOOTPRINT* aFootprint );
238
245
249 bool DeleteFootprintFromLibrary( const LIB_ID& aFPID, bool aConfirm );
250
254 COLOR4D GetGridColor() override;
255
257 void SetActiveLayer( PCB_LAYER_ID aLayer ) override;
258
259 void OnDisplayOptionsChanged() override;
260
262 void ActivateGalCanvas() override;
263
273 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
274
279 void AddFootprintToBoard( FOOTPRINT* aFootprint ) override;
280
285 void ReloadFootprint( FOOTPRINT* aFootprint ) override;
286
290 void ShowChangedLanguage() override;
291
295 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
296
301 void SyncLibraryTree( bool aProgress );
302
308
312 void RefreshLibraryTree();
313
317 void UpdateLibraryTree( const wxDataViewItem& treeItem, FOOTPRINT* aFootprint );
318
320 void UpdateView();
321
322 void UpdateTitle();
323
324 void FocusOnLibID( const LIB_ID& aLibID );
325
326 void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
327
328 DECLARE_EVENT_TABLE()
329
330protected:
332 FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
333
337 void resolveCanvasType() override;
338
343 void initLibraryTree();
344
346 void retainLastFootprint();
347
351 void doReCreateMenuBar() override;
352
356 void editFootprintProperties( FOOTPRINT* aFootprint );
357
358 void setupUIConditions() override;
359
360 void centerItemIdleHandler( wxIdleEvent& aEvent );
361
362protected:
363 PCB_LAYER_BOX_SELECTOR* m_selLayerBox; // a combo box to display and select active layer
365
366private:
367 friend struct PCB::IFACE;
368
371
373
375
379};
380
381#endif // FOOTPRINT_EDIT_FRAME_H
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Container for design settings for a BOARD object.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
Color settings are a bit different than most of the settings objects in that there can be more than o...
A dialog which shows:
void CloseFootprintEditor(wxCommandEvent &Event)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Returns the BOARD_DESIGN_SETTINGS for the open project.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void editFootprintProperties(FOOTPRINT *aFootprint)
Run the Footprint Properties dialog and handle changes made in it.
void HardRedraw() override
Refresh the library tree and redraw the window.
void UpdateLibraryTree(const wxDataViewItem &treeItem, FOOTPRINT *aFootprint)
Update a single node in the library tree.
static const wxChar * GetFootprintEditorFrameName()
void SyncLibraryTree(bool aProgress)
Synchronize the footprint library tree to the current state of the footprint library table.
bool SaveFootprintInLibrary(FOOTPRINT *aFootprint, const wxString &aLibraryName)
bool SaveLibraryAs(const wxString &aLibraryPath)
Save a library to a new name and/or library type.
void OnSaveFootprintAsPng(wxCommandEvent &event)
bool SaveFootprintAs(FOOTPRINT *aFootprint)
bool DuplicateFootprint(FOOTPRINT *aFootprint)
BOARD_ITEM_CONTAINER * GetModel() const override
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Re create the layer Box by clearing the old list, and building a new one from the new layers names an...
void OnUpdateLayerSelectBox(wxUpdateUIEvent &aEvent)
bool canCloseWindow(wxCloseEvent &Event) override
void UpdateMsgPanel() override
Redraw the message panel.
void ExportFootprint(FOOTPRINT *aFootprint)
Create a file containing only one footprint.
void KiwayMailIn(KIWAY_EXPRESS &mail) override
Receive KIWAY_EXPRESS messages from other players.
LIB_ID GetTargetFPID() const
Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selec...
LIB_ID GetLoadedFPID() const
Return the LIB_ID of the part being edited.
APP_SETTINGS_BASE * config() const override
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void SelectLayer(wxCommandEvent &event)
LIB_TREE_NODE * GetCurrentTreeNode() const
bool SaveFootprintToBoard(bool aAddNew)
void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings) override
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.
LIB_ID GetTreeFPID() const
Return the LIB_ID of the part or library selected in the footprint tree.
void initLibraryTree()
Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprin...
void LoadFootprintFromLibrary(LIB_ID aFPID)
void OnLoadFootprintFromBoard(wxCommandEvent &event)
Called from the main toolbar to load a footprint from board mainly to edit it.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > & GetLibTreeAdapter()
Return the adapter object that provides the stored data.
void UpdateToolbarControlSizes() override
Update the sizes of any controls in the toolbars of the frame.
FOOTPRINT * ImportFootprint(const wxString &aName=wxT(""))
Read a file containing only one footprint.
std::map< KIID, KIID > m_boardFootprintUuids
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
FOOTPRINT * SelectFootprintFromBoard(BOARD *aPcb)
Display the list of footprints currently existing on the BOARD.
void ReCreateHToolbar() override
Create the main horizontal toolbar for the footprint editor.
void ShowChangedLanguage() override
Update visible items after a language change.
void resolveCanvasType() override
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
void OnSaveFootprintToBoard(wxCommandEvent &event)
bool IsContentModified() const override
Get if any footprints or libraries have been modified but not saved.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
FOOTPRINT_EDITOR_SETTINGS * m_editorSettings
void centerItemIdleHandler(wxIdleEvent &aEvent)
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Returns bbox of document with option to not include some items.
bool Clear_Pcb(bool doAskAboutUnsavedChanges)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:103
void OnUpdateLoadFootprintFromBoard(wxUpdateUIEvent &aEvent)
void OnUpdateSaveFootprintToBoard(wxUpdateUIEvent &aEvent)
Install the corresponding dialog editor for the given item.
void OnEditItemRequest(BOARD_ITEM *aItem) override
Install the corresponding dialog editor for the given item.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
bool CanCloseFPFromBoard(bool doClose)
void RegenerateLibraryTree()
Filter, sort, and redisplay the library tree.
void SetActiveLayer(PCB_LAYER_ID aLayer) override
void AddFootprintToBoard(FOOTPRINT *aFootprint) override
Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board,...
bool DeleteFootprintFromLibrary(const LIB_ID &aFPID, bool aConfirm)
Delete the given footprint from its library.
void OnModify() override
Must be called after a footprint change in order to set the "modify" flag of the current screen and p...
FOOTPRINT_TREE_PANE * m_treePane
COLOR4D GetGridColor() override
void OnDisplayOptionsChanged() override
void doReCreateMenuBar() override
(Re)Create the menubar for the Footprint Editor frame
void FocusOnLibID(const LIB_ID &aLibID)
const PCB_PLOT_PARAMS & GetPlotSettings() const override
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
PCB_LAYER_BOX_SELECTOR * m_selLayerBox
std::unique_ptr< FOOTPRINT > m_originalFootprintCopy
void ReloadFootprint(FOOTPRINT *aFootprint) override
Override from PCB_BASE_FRAME which reloads the footprint from the library without setting the footpri...
EDA_ANGLE GetRotationAngle() const override
Return the angle used for rotate operations.
void RefreshLibraryTree()
Redisplay the library tree.
void OnExitKiCad(wxCommandEvent &aEvent)
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl=0) override
Load a KiCad board (.kicad_pcb) from aFileName.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
MAGNETIC_SETTINGS * GetMagneticItemsSettings() override
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch the currently used canvas (Cairo / OpenGL).
bool LoadFootprintFromBoard(FOOTPRINT *aFootprint)
Load a footprint from the main board into the Footprint Editor.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
Footprint Editor pane with footprint library tree.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Definition: kiid.h:49
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition: kiway_express.h:40
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
Common, abstract interface for edit frames.
Class to display a pcb layer list in a wxBitmapComboBox.
Parameters and options when plotting/printing a board.
Class to handle modifications to the symbol libraries.
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
STL namespace.