KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_wizard_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) 2012 Miguel Angel Ajo Pelayo, [email protected]
5 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
29
30#ifndef FOOTPRINT_WIZARD_FRAME_H_
31#define FOOTPRINT_WIZARD_FRAME_H_
32
33#include <memory>
34#include <wx/gdicmn.h>
35#include <footprint_wizard.h>
36#include <pcb_base_edit_frame.h>
37#include <nlohmann/json_fwd.hpp>
38
39class wxSashLayoutWindow;
40class wxSashEvent;
43
45{
46public:
47 FOOTPRINT_WIZARD_FRAME( KIWAY* aKiway, wxWindow* parent, FRAME_T aFrameType );
48
50
52 BOARD_ITEM_CONTAINER* GetModel() const override;
53
55
56 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
57
58 void SelectCurrentWizard( wxCommandEvent& aDummy ); // Open the wizard selector dialog
59
60 void DefaultParameters(); // Reset the initial (default) values of the wizard prms
61
65 void ExportSelectedFootprint( wxCommandEvent& aEvent );
66
69
71
72private:
73 void OnSize( wxSizeEvent& event ) override;
74
80 void UpdateMsgPanel() override;
81
86 void updateView();
87
91 void OnSashDrag( wxSashEvent& event );
92
97
105
109 void RegenerateFootprint();
110
115
119 void DisplayWizardInfos();
120
121 void doCloseWindow() override;
122
123 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
124 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
125
127
132 void OnActivate( wxActivateEvent& event );
133
134
136 void Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle = nullptr ) override;
137
138 DECLARE_EVENT_TABLE()
139
140protected:
142 wxString m_wizardStatus;
143
144private:
146 wxTextCtrl* m_buildMessageBox;
147
150
152
154};
155
156
157
158#endif // FOOTPRINT_WIZARD_FRM_H_
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
Color settings are a bit different than most of the settings objects in that there can be more than o...
BOARD_ITEM_CONTAINER * GetModel() const override
FOOTPRINT_WIZARD_MANAGER * Manager() const
void OnSashDrag(wxSashEvent &event)
Resize the child windows when dragging a sash window border.
std::unique_ptr< FOOTPRINT_WIZARD_MANAGER > m_wizardManager
void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ReCreateParameterList()
Create the list of parameters for the current page.
void DisplayWizardInfos()
Show all the details about the current wizard.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
void SelectCurrentWizard(wxCommandEvent &aDummy)
bool m_wizardListShown
A show-once flag for the wizard list.
void updateView()
Rebuild the GAL view (reint tool manager, colors and drawings) must be run after any footprint change...
void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
Update the 3D view, if the viewer is opened by this frame.
wxString m_wizardStatus
current wizard status
FOOTPRINT_WIZARD * m_currentWizard
FOOTPRINT_WIZARD * GetMyWizard()
Reloads the wizard by name.
FOOTPRINT_WIZARD_FRAME(KIWAY *aKiway, wxWindow *parent, FRAME_T aFrameType)
void UpdateMsgPanel() override
Redraw the message panel.
std::unique_ptr< nlohmann::json > m_viewerAuiState
void RegenerateFootprint()
Regenerate the current footprint.
void SelectFootprintWizard()
Prepare the grid where parameters are displayed.
wxString m_auiPerspective
Encoded string describing the AUI layout.
FOOTPRINT_WIZARD_PROPERTIES_PANEL * m_parametersPanel
Panel for the parameter grid.
void ExportSelectedFootprint(wxCommandEvent &aEvent)
Will let the caller exit from the wait loop, and get the built footprint.
WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg) override
Return a pointer to the window settings for this frame.
void OnActivate(wxActivateEvent &event)
Called when the frame frame is activate to reload the libraries and component lists that can be chang...
The footprint wizard manager interfaces with API_PLUGINs that can generate footprints.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:315
PCB_BASE_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
STL class.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:33
nlohmann::json json
Definition gerbview.cpp:50
STL namespace.
Store the common settings that are saved and loaded for each window / frame.