footprint_wizard_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) 2012 Miguel Angel Ajo Pelayo, [email protected]
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2004-2021 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef FOOTPRINT_WIZARD_FRAME_H_
#define FOOTPRINT_WIZARD_FRAME_H_
 
#include <wx/gdicmn.h>
#include <footprint_wizard.h>
#include <pcb_base_edit_frame.h>
 
class wxSashLayoutWindow;
class wxSashEvent;
class wxListBox;
class WX_GRID;
class wxGridEvent;
class FOOTPRINT_EDIT_FRAME;
 
 
enum WizardParameterColumnNames
{
 WIZ_COL_NAME = 0,
 WIZ_COL_VALUE,
 WIZ_COL_UNITS
};
 
class FOOTPRINT_WIZARD_FRAME : public PCB_BASE_EDIT_FRAME
{
public:
 FOOTPRINT_WIZARD_FRAME( KIWAY* aKiway, wxWindow* parent, FRAME_T aFrameType );
 
 ~FOOTPRINT_WIZARD_FRAME();
 
 BOARD_ITEM_CONTAINER* GetModel() const override;
 
 FOOTPRINT* GetBuiltFootprint();
 
 void PythonPluginsReload();
 
 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
 
private:
 
 void OnSize( wxSizeEvent& event ) override;
 void OnGridSize( wxSizeEvent& aSizeEvent );
 
 void UpdateMsgPanel() override;
 
 void updateView();
 
 void ExportSelectedFootprint( wxCommandEvent& aEvent );
 
 void OnSashDrag( wxSashEvent& event );
 
 void ReCreatePageList();
 
 void ReCreateParameterList();
 
 void ResizeParamColumns();
 
 void initParameterGrid();
 
 void SelectFootprintWizard();
 
 void ReloadFootprint();
 
 void DisplayBuildMessage( wxString& aMessage );
 
 FOOTPRINT_WIZARD* GetMyWizard();
 
 void Process_Special_Functions( wxCommandEvent& event );
 
 void DisplayWizardInfos();
 
 void doCloseWindow() override;
 void ReCreateHToolbar() override;
 void ReCreateVToolbar() override;
 void ClickOnPageList( wxCommandEvent& event );
 
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 void OnActivate( wxActivateEvent& event );
 
 void SelectCurrentWizard( wxCommandEvent& event );
 
 void DefaultParameters( wxCommandEvent& event );
 
 void ParametersUpdated( wxGridEvent& event );
 
 void Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle = nullptr ) override;
 
 /*
 * Not used here but needed by PCB_BASE_EDIT_FRAME.
 */
 void SaveCopyInUndoList( EDA_ITEM*, UNDO_REDO ) override {}
 void SaveCopyInUndoList( const PICKED_ITEMS_LIST&, UNDO_REDO ) override {}
 void OnEditItemRequest( BOARD_ITEM* aItem ) override {}
 
 DECLARE_EVENT_TABLE()
 
protected:
 wxString m_wizardName; 
 wxString m_wizardDescription; 
 wxString m_wizardStatus; 
 
private:
 wxPanel* m_parametersPanel; 
 wxListBox* m_pageList; 
 WX_GRID* m_parameterGrid; 
 int m_parameterGridPage; 
 wxTextCtrl* m_buildMessageBox;
 
 wxString m_auiPerspective; 
 
 bool m_wizardListShown; 
};
 
 
 
#endif // FOOTPRINT_WIZARD_FRM_H_