KiCad PCB EDA Suite
display_footprints_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) 2018 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 2007-2018 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
28 #ifndef DISPLAY_FOOTPRINTS_FRAME_H
29 #define DISPLAY_FOOTPRINTS_FRAME_H
30 
31 #include <pcb_base_frame.h>
32 
33 // The name (for wxWidgets) of the footprint viewer frame
34 #define FOOTPRINTVIEWER_FRAME_NAME wxT( "FootprintViewerFrame" )
35 
36 
42 {
43  bool m_autoZoom;
44  double m_lastZoom;
45 
46 public:
47  DISPLAY_FOOTPRINTS_FRAME( KIWAY* aKiway, wxWindow* aParent );
48  ~DISPLAY_FOOTPRINTS_FRAME() override;
49 
50  void OnCloseWindow( wxCloseEvent& Event ) override;
51 
52  void ReCreateHToolbar() override;
53  void ReCreateVToolbar() override;
54  void ReCreateOptToolbar() override;
55 
62  void InitDisplay();
63 
67  void updateView();
68 
69  void LoadSettings( wxConfigBase* aCfg ) override;
70  void SaveSettings( wxConfigBase* aCfg ) override;
71 
74 
76  void UpdateMsgPanel() override;
77 
78  bool GetAutoZoom() const { return m_autoZoom; }
79  void SetAutoZoom( bool aEnable ) { m_autoZoom = aEnable; }
80 
85  bool IsGridVisible() const override;
86 
93  void SetGridVisibility( bool aVisible ) override;
98  COLOR4D GetGridColor() override;
99 
100  void InstallOptionsDisplay( wxCommandEvent& event );
101  MODULE* Get_Module( const wxString& CmpName );
102 
103  /* SaveCopyInUndoList() virtual
104  * currently: do nothing in CvPcb.
105  * but but be defined because it is a pure virtual in PCB_BASE_FRAME
106  */
107  void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy, UNDO_REDO_T aTypeCommand = UR_UNSPECIFIED,
108  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) override
109  {
110  }
111 
112 
122  void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO_T aTypeCommand,
123  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) override
124  {
125  // currently: do nothing in CvPcb.
126  }
127 
128  void SyncToolbars() override;
129 
130  DECLARE_EVENT_TABLE()
131 };
132 
133 #endif // DISPLAY_FOOTPRINTS_FRAME_H
COLOR4D GetGridColor() override
Function GetGridColor() , virtual.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void InstallOptionsDisplay(wxCommandEvent &event)
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
void ApplyDisplaySettingsToGAL()
Updates the GAL with display settings changes.
MODULE * Get_Module(const wxString &CmpName)
DISPLAY_FOOTPRINTS_FRAME(KIWAY *aKiway, wxWindow *aParent)
void updateView()
update the gal canvas (view, colors ...)
Class DISPLAY_FOOTPRINTS_FRAME is used to display footprints.
void OnCloseWindow(wxCloseEvent &Event) override
Classes used in Pcbnew, CvPcb and GerbView.
bool IsGridVisible() const override
Function IsGridVisible() , virtual.
void SaveCopyInUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
Function SaveCopyInUndoList (overloaded).
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:258
void SyncToolbars() override
Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state.
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
void SaveSettings(wxConfigBase *aCfg) override
Saves common frame parameters to a configuration data file.
void InitDisplay()
Function InitDisplay Refresh the full display for this frame: Set the title, the status line and redr...
void SetGridVisibility(bool aVisible) override
Function SetGridVisibility() , virtual It may be overloaded by derived classes if you want to store/r...
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void SaveCopyInUndoList(BOARD_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand=UR_UNSPECIFIED, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39