footprint_edit_frame.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef FOOTPRINT_EDIT_FRAME_H
#define FOOTPRINT_EDIT_FRAME_H
 
#include <pcb_base_frame.h>
#include <pcb_base_edit_frame.h>
#include <io_mgr.h>
#include <config_params.h>
#include <fp_tree_synchronizing_adapter.h>
 
class PCB_LAYER_BOX_SELECTOR;
class FP_LIB_TABLE;
class FOOTPRINT_TREE_PANE;
class SYMBOL_LIBRARY_MANAGER;
class FOOTPRINT_EDITOR_SETTINGS;
class EDA_LIST_DIALOG;
 
namespace PCB { struct IFACE; } // A KIFACE coded in pcbnew.cpp
 
 
class FOOTPRINT_EDIT_FRAME : public PCB_BASE_EDIT_FRAME
{
public:
 ~FOOTPRINT_EDIT_FRAME();
 
 static const wxChar* GetFootprintEditorFrameName();
 
 BOARD_ITEM_CONTAINER* GetModel() const override;
 SELECTION& GetCurrentSelection() override;
 
 bool IsContentModified() const override;
 
 bool IsCurrentFPFromBoard() const;
 
 bool CanCloseFPFromBoard( bool doClose );
 
 FOOTPRINT_EDITOR_SETTINGS* GetSettings();
 
 EDA_ANGLE GetRotationAngle() const override;
 
 APP_SETTINGS_BASE* config() const override;
 
 BOARD_DESIGN_SETTINGS& GetDesignSettings() const override;
 
 const PCB_PLOT_PARAMS& GetPlotSettings() const override;
 void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings ) override;
 
 MAGNETIC_SETTINGS* GetMagneticItemsSettings() override;
 
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
 
 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
 
 bool canCloseWindow( wxCloseEvent& Event ) override;
 void doCloseWindow() override;
 void CloseFootprintEditor( wxCommandEvent& Event );
 void OnExitKiCad( wxCommandEvent& aEvent );
 
 void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
 
 void UpdateUserInterface();
 
 void UpdateMsgPanel() override;
 
 void HardRedraw() override;
 
 void ReCreateHToolbar() override;
 
 void ReCreateVToolbar() override;
 void ReCreateOptToolbar() override;
 void UpdateToolbarControlSizes() override;
 
 void ReCreateLayerBox( bool aForceResizeToolbar = true );
 
 void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
 
 void SelectLayer( wxCommandEvent& event );
 
 // The Tool Framework initialization, for GAL mode
 void setupTools();
 
 void OnSaveFootprintAsPng( wxCommandEvent& event );
 
 bool IsSearchTreeShown() const;
 void ToggleSearchTree();
 void ToggleLayersManager();
 
 bool SaveLibraryAs( const wxString& aLibraryPath );
 
 void OnUpdateLoadFootprintFromBoard( wxUpdateUIEvent& aEvent );
 void OnUpdateSaveFootprintToBoard( wxUpdateUIEvent& aEvent );
 
 void OnEditItemRequest( BOARD_ITEM* aItem ) override;
 
 void OnLoadFootprintFromBoard( wxCommandEvent& event );
 
 void OnSaveFootprintToBoard( wxCommandEvent& event );
 
 void LoadFootprintFromLibrary( LIB_ID aFPID );
 
 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& GetLibTreeAdapter() { return m_adapter; }
 
 bool SaveFootprint( FOOTPRINT* aFootprint );
 bool DuplicateFootprint( FOOTPRINT* aFootprint );
 bool SaveFootprintAs( FOOTPRINT* aFootprint );
 bool SaveFootprintToBoard( bool aAddNew );
 bool SaveFootprintInLibrary( FOOTPRINT* aFootprint, const wxString& aLibraryName );
 bool RevertFootprint();
 
 void OnModify() override;
 
 bool Clear_Pcb( bool aQuery );
 
 LIB_ID GetTreeFPID() const;
 
 LIB_TREE_NODE* GetCurrentTreeNode() const;
 
 LIB_ID GetLoadedFPID() const;
 
 LIB_ID GetTargetFPID() const;
 
 void ClearModify();
 
 void ExportFootprint( FOOTPRINT* aFootprint );
 
 FOOTPRINT* ImportFootprint( const wxString& aName = wxT( "" ) );
 
 bool LoadFootprintFromBoard( FOOTPRINT* aFootprint );
 
 FOOTPRINT* SelectFootprintFromBoard( BOARD* aPcb );
 
 bool DeleteFootprintFromLibrary( const LIB_ID& aFPID, bool aConfirm );
 
 COLOR4D GetGridColor() override;
 
 void SetActiveLayer( PCB_LAYER_ID aLayer ) override;
 
 void OnDisplayOptionsChanged() override;
 
 void ActivateGalCanvas() override;
 
 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
 
 void AddFootprintToBoard( FOOTPRINT* aFootprint ) override;
 
 void ReloadFootprint( FOOTPRINT* aFootprint ) override;
 
 void ShowChangedLanguage() override;
 
 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
 
 void SyncLibraryTree( bool aProgress );
 
 void RegenerateLibraryTree();
 
 void RefreshLibraryTree();
 
 void UpdateLibraryTree( const wxDataViewItem& treeItem, FOOTPRINT* aFootprint );
 
 void UpdateView();
 
 void UpdateTitle();
 
 void FocusOnLibID( const LIB_ID& aLibID );
 
 void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
 
 DECLARE_EVENT_TABLE()
 
protected:
 FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
 
 EDA_LIST_DIALOG* buildSaveAsDialog( const wxString& aFootprintName,
 const wxString& aLibraryPreselect );
 
 void initLibraryTree();
 
 void restoreLastFootprint();
 void retainLastFootprint();
 
 void doReCreateMenuBar() override;
 
 void editFootprintProperties( FOOTPRINT* aFootprint );
 
 void setupUIConditions() override;
 
 void centerItemIdleHandler( wxIdleEvent& aEvent );
 
protected:
 PCB_LAYER_BOX_SELECTOR* m_selLayerBox; // a combo box to display and select active layer
 FOOTPRINT_EDITOR_SETTINGS* m_editorSettings;
 
private:
 friend struct PCB::IFACE;
 
 FOOTPRINT_TREE_PANE* m_treePane;
 LIB_ID m_centerItemOnIdle;
 
 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
 
 bool m_show_layer_manager_tools;
 
 std::unique_ptr<FOOTPRINT> m_originalFootprintCopy;
 wxString m_footprintNameWhenLoaded;
 std::map<KIID, KIID> m_boardFootprintUuids;
};
 
#endif // FOOTPRINT_EDIT_FRAME_H