256 lines
8.1 KiB
C++
256 lines
8.1 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2012 Miguel Angel Ajo Pelayo, miguelangel@nbee.es
|
|
* Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2004-2017 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
|
|
*/
|
|
|
|
/**
|
|
* @file footprint_wizard_frame.h
|
|
*/
|
|
|
|
#ifndef FOOTPRINT_WIZARD_FRAME_H_
|
|
#define FOOTPRINT_WIZARD_FRAME_H_
|
|
|
|
|
|
#include <wx/gdicmn.h>
|
|
#include <footprint_wizard.h>
|
|
class wxSashLayoutWindow;
|
|
class wxListBox;
|
|
class wxGrid;
|
|
class wxGridEvent;
|
|
class FOOTPRINT_EDIT_FRAME;
|
|
|
|
// A helper class to display messages when building a footprint
|
|
class FOOTPRINT_WIZARD_MESSAGES;
|
|
|
|
enum WizardParameterColumnNames
|
|
{
|
|
WIZ_COL_NAME = 0,
|
|
WIZ_COL_VALUE,
|
|
WIZ_COL_UNITS
|
|
};
|
|
|
|
/**
|
|
* Class FOOTPRINT_WIZARD_FRAME
|
|
*/
|
|
class FOOTPRINT_WIZARD_FRAME : public PCB_BASE_FRAME
|
|
{
|
|
private:
|
|
wxListBox* m_pageList; ///< The list of pages
|
|
int m_pageListWidth; ///< width of the window
|
|
wxGrid* m_parameterGrid; ///< The list of parameters
|
|
int m_parameterGridWidth; ///< size of the grid
|
|
int m_parameterGridPage; ///< the page currently displayed by m_parameterGrid
|
|
///< it is most of time the m_pageList selection, but can differ
|
|
///< during transitions between pages.
|
|
FOOTPRINT_WIZARD_MESSAGES* m_messagesFrame;
|
|
|
|
protected:
|
|
wxString m_wizardName; ///< name of the current wizard
|
|
wxString m_wizardDescription; ///< description of the wizard
|
|
wxString m_wizardStatus; ///< current wizard status
|
|
|
|
public:
|
|
|
|
FOOTPRINT_WIZARD_FRAME( KIWAY* aKiway, wxWindow* parent, FRAME_T aFrameType );
|
|
|
|
~FOOTPRINT_WIZARD_FRAME();
|
|
|
|
MODULE* GetBuiltFootprint();
|
|
|
|
/**
|
|
* Reload the Python plugins if they are newer than
|
|
* the already loaded, and load new plugins if any
|
|
* Do nothing if KICAD_SCRIPTING is not defined
|
|
*/
|
|
void PythonPluginsReload();
|
|
|
|
private:
|
|
|
|
void OnSize( wxSizeEvent& event ) override;
|
|
|
|
void OnGridSize( wxSizeEvent& aSizeEvent );
|
|
|
|
/**
|
|
* Function ExportSelectedFootprint();
|
|
* will let the caller exit from the wait loop, and get the built footprint
|
|
*
|
|
*/
|
|
void ExportSelectedFootprint( wxCommandEvent& aEvent );
|
|
|
|
/**
|
|
* Function OnSashDrag
|
|
* resizes the child windows when dragging a sash window border.
|
|
*/
|
|
|
|
void OnSashDrag( wxSashEvent& event );
|
|
|
|
/**
|
|
* Function ReCreatePageList
|
|
* Creates or recreates the list of parameter pages for the current wizard.
|
|
* This list is sorted
|
|
*/
|
|
void ReCreatePageList();
|
|
|
|
/**
|
|
* Function ReCreateParameterList
|
|
* Creates the list of parameters for the current page
|
|
*/
|
|
void ReCreateParameterList();
|
|
|
|
/**
|
|
* Expand the 'Value' column to fill available
|
|
*/
|
|
void ResizeParamColumns();
|
|
|
|
/**
|
|
* Function initParameterGrid
|
|
* Prepare the grid where parameters are displayed
|
|
*/
|
|
void initParameterGrid();
|
|
|
|
/**
|
|
* Function SelectFootprintWizard
|
|
* Shows the list of footprint wizards available into the system
|
|
*/
|
|
void SelectFootprintWizard();
|
|
|
|
/**
|
|
* Function ReloadFootprint
|
|
* Reloads the current footprint
|
|
*/
|
|
void ReloadFootprint();
|
|
|
|
/**
|
|
* Function DisplayBuildMessages
|
|
* Display the message generated by the python build footprint script
|
|
*/
|
|
void DisplayBuildMessage( wxString& aMessage );
|
|
|
|
/**
|
|
* Function GetMyWizard
|
|
* Reloads the wizard by name
|
|
*/
|
|
FOOTPRINT_WIZARD* GetMyWizard();
|
|
|
|
|
|
void Process_Special_Functions( wxCommandEvent& event );
|
|
|
|
/**
|
|
* Function DisplayWizardInfos
|
|
* Shows all the details about the current wizard
|
|
*/
|
|
void DisplayWizardInfos();
|
|
|
|
|
|
void RedrawActiveWindow( wxDC* DC, bool EraseBg ) override;
|
|
void OnCloseWindow( wxCloseEvent& Event ) override;
|
|
void ReCreateHToolbar() override;
|
|
void ReCreateVToolbar() override;
|
|
void OnLeftClick( wxDC* DC, const wxPoint& MousePos ) override;
|
|
void ClickOnPageList( wxCommandEvent& event );
|
|
void OnSetRelativeOffset( wxCommandEvent& event );
|
|
|
|
bool GeneralControl( wxDC* aDC, const wxPoint& aPosition, EDA_KEY aHotKey = 0 ) override;
|
|
|
|
void LoadSettings( wxConfigBase* aCfg ) override;
|
|
void SaveSettings( wxConfigBase* aCfg ) override;
|
|
|
|
///> @copydoc EDA_DRAW_FRAME::GetHotKeyDescription()
|
|
EDA_HOTKEY* GetHotKeyDescription( int aCommand ) const override { return NULL; }
|
|
|
|
/**
|
|
* Function OnActivate
|
|
* is called when the frame frame is activate to reload the libraries and component lists
|
|
* that can be changed by the schematic editor or the library editor.
|
|
*/
|
|
virtual void OnActivate( wxActivateEvent& event ) override;
|
|
|
|
void SelectCurrentWizard( wxCommandEvent& event );
|
|
|
|
void DefaultParameters( wxCommandEvent& event );
|
|
|
|
/**
|
|
* Function ParametersUpdated
|
|
* Update the footprint python parameters values from the values in grid
|
|
*/
|
|
void ParametersUpdated( wxGridEvent& event );
|
|
|
|
void OnParameterCellClick( wxGridEvent& event );
|
|
|
|
void OnParameterGridKeyPress( wxKeyEvent& event );
|
|
|
|
bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu ) override;
|
|
|
|
/**
|
|
* Function Show3D_Frame (virtual)
|
|
* displays 3D view of the footprint (module) being edited.
|
|
*/
|
|
void Show3D_Frame( wxCommandEvent& event ) override;
|
|
|
|
/**
|
|
* Function Update3D_Frame
|
|
* must be called after a footprint selection
|
|
* Updates the 3D view and 3D frame title.
|
|
* @param aForceReloadFootprint = true to reload data (default)
|
|
* = false to update title only -(aftre creating the 3D viewer)
|
|
*/
|
|
void Update3D_Frame( bool aForceReloadFootprint = true );
|
|
|
|
/*
|
|
* Virtual functions, not used here, but needed by PCB_BASE_FRAME
|
|
* (virtual pure functions )
|
|
*/
|
|
void OnLeftDClick( wxDC*, const wxPoint& ) override {}
|
|
void SaveCopyInUndoList( BOARD_ITEM*, UNDO_REDO_T, const wxPoint& ) override {}
|
|
void SaveCopyInUndoList( const PICKED_ITEMS_LIST&, UNDO_REDO_T, const wxPoint& ) override {}
|
|
|
|
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
|
|
// A miniframe to display messages from the builder
|
|
class FOOTPRINT_WIZARD_MESSAGES: public wxMiniFrame
|
|
{
|
|
public:
|
|
FOOTPRINT_WIZARD_MESSAGES( FOOTPRINT_WIZARD_FRAME* aParent, wxConfigBase* aCfg );
|
|
~FOOTPRINT_WIZARD_MESSAGES();
|
|
void PrintMessage( const wxString& aMessage );
|
|
void ClearScreen();
|
|
void SaveSettings();
|
|
void LoadSettings();
|
|
|
|
private:
|
|
wxTextCtrl* m_messageWindow;
|
|
wxPoint m_position;
|
|
wxSize m_size;
|
|
wxConfigBase* m_config;
|
|
bool m_canClose; // false to veto a close event, true to allow it
|
|
|
|
void OnCloseMsgWindow( wxCloseEvent& aEvent );
|
|
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
#endif // FOOTPRINT_WIZARD_FRM_H_
|