kicad/cvpcb/display_footprints_frame.h

140 lines
4.4 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2018 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2007-2018 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 display_footprints_frame.h
*/
#ifndef DISPLAY_FOOTPRINTS_FRAME_H
#define DISPLAY_FOOTPRINTS_FRAME_H
2010-02-01 21:23:27 +00:00
2018-01-29 15:39:40 +00:00
#include <pcb_base_frame.h>
#include <pcbnew_settings.h>
2010-02-01 21:23:27 +00:00
class REPORTER;
// The name (for wxWidgets) of the footprint viewer frame
#define FOOTPRINTVIEWER_FRAME_NAME wxT( "FootprintViewerFrame" )
/**
* DISPLAY_FOOTPRINTS_FRAME
* is used to display footprints.
*/
class DISPLAY_FOOTPRINTS_FRAME : public PCB_BASE_FRAME
2010-02-01 21:23:27 +00:00
{
public:
DISPLAY_FOOTPRINTS_FRAME( KIWAY* aKiway, wxWindow* aParent );
~DISPLAY_FOOTPRINTS_FRAME() override;
2010-02-01 21:23:27 +00:00
void doCloseWindow() override;
2016-09-24 18:53:15 +00:00
void ReCreateHToolbar() override;
void ReCreateVToolbar() override;
void ReCreateOptToolbar() override;
2010-02-01 21:23:27 +00:00
2012-05-31 17:41:37 +00:00
/**
* Function InitDisplay
* Refresh the full display for this frame:
* Set the title, the status line and redraw the canvas
* Must be called after the footprint to display is modifed
*/
void InitDisplay();
///> @copydoc PCB_BASE_FRAME::GetModel()
BOARD_ITEM_CONTAINER* GetModel() const override;
/**
* update the gal canvas (view, colors ...)
*/
void updateView();
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
MAGNETIC_SETTINGS* GetMagneticItemsSettings() override;
///> @copydoc EDA_DRAW_FRAME::UpdateMsgPanel()
void UpdateMsgPanel() override;
COLOR_SETTINGS* GetColorSettings() const override;
2010-11-12 15:17:10 +00:00
/**
* Function GetGridColor() , virtual
2010-02-01 21:23:27 +00:00
* @return the color of the grid
*/
COLOR4D GetGridColor() override;
2010-02-01 21:23:27 +00:00
2020-11-13 15:15:52 +00:00
FOOTPRINT* GetFootprint( const wxString& aFootprintName, REPORTER& aReporter );
2010-02-01 21:23:27 +00:00
/* SaveCopyInUndoList() virtual
* currently: do nothing in CvPcb.
* but but be defined because it is a pure virtual in PCB_BASE_FRAME
2010-02-01 21:23:27 +00:00
*/
void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED,
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) override
2010-02-01 21:23:27 +00:00
{
}
2010-11-12 15:17:10 +00:00
/**
* Function SaveCopyInUndoList (overloaded).
2010-02-01 21:23:27 +00:00
* Creates a new entry in undo list of commands.
* add a list of pickers to handle a list of items
* @param aItemsList = the list of items modified by the command to undo
2020-08-26 18:04:32 +00:00
* @param aTypeCommand = command type (see enum UNDO_REDO)
2010-02-01 21:23:27 +00:00
* @param aTransformPoint = the reference point of the transformation,
* for commands like move
*/
2020-08-26 18:04:32 +00:00
void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) override
2010-02-01 21:23:27 +00:00
{
// currently: do nothing in CvPcb.
2010-02-01 21:23:27 +00:00
}
/**
* Set if the canvas should automatically zoom to the footprint on load.
*
* @param aAutoZoom is true if it should automatically zoom
*/
void SetAutoZoom( bool aAutoZoom ) override;
/**
* Get if the canvas should automatically zoom to the footprint on load.
*
* @return true if it should automatically zoom
*/
bool GetAutoZoom() override;
SELECTION& GetCurrentSelection() override;
2010-02-01 21:23:27 +00:00
DECLARE_EVENT_TABLE()
protected:
void setupUIConditions() override;
2010-02-01 21:23:27 +00:00
};
#endif // DISPLAY_FOOTPRINTS_FRAME_H