kicad/cvpcb/class_DisplayFootprintsFrame.h

136 lines
4.5 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2007-2011 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 class_DisplayFootprintsFrame.h
*/
2010-02-01 21:23:27 +00:00
#include <wxBasePcbFrame.h>
2010-02-01 21:23:27 +00:00
// The name (for wxWidgets) of the footprint viewer frame
#define FOOTPRINTVIEWER_FRAME_NAME wxT( "FootprintViewerFrame" )
class CVPCB_MAINFRAME;
/**
* Class 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:
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
DISPLAY_FOOTPRINTS_FRAME( KIWAY* aKiway, CVPCB_MAINFRAME* aParent );
2010-02-01 21:23:27 +00:00
~DISPLAY_FOOTPRINTS_FRAME();
void OnCloseWindow( wxCloseEvent& Event );
/*
* Draws the current highlighted footprint.
*/
2010-02-01 21:23:27 +00:00
void RedrawActiveWindow( wxDC* DC, bool EraseBg );
2010-02-01 21:23:27 +00:00
void ReCreateHToolbar();
void ReCreateVToolbar();
void ReCreateOptToolbar();
2010-02-01 21:23:27 +00:00
void RecreateMenuBar();
void OnSelectOptionToolbar( wxCommandEvent& event );
void OnUpdateTextDrawMode( wxUpdateUIEvent& aEvent );
void OnUpdateLineDrawMode( wxUpdateUIEvent& aEvent );
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();
2010-11-12 15:17:10 +00:00
/**
* Function IsGridVisible() , virtual
2010-02-01 21:23:27 +00:00
* @return true if the grid must be shown
*/
virtual bool IsGridVisible() const;
2010-02-01 21:23:27 +00:00
2010-11-12 15:17:10 +00:00
/**
* Function SetGridVisibility() , virtual
2010-02-01 21:23:27 +00:00
* It may be overloaded by derived classes
* if you want to store/retrieve the grid visibility in configuration.
2010-02-01 21:23:27 +00:00
* @param aVisible = true if the grid must be shown
*/
virtual void SetGridVisibility( bool aVisible );
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
*/
virtual EDA_COLOR_T GetGridColor() const;
2010-02-01 21:23:27 +00:00
void OnLeftClick( wxDC* DC, const wxPoint& MousePos );
void OnLeftDClick( wxDC* DC, const wxPoint& MousePos );
bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu );
bool GeneralControl( wxDC* DC, const wxPoint& aPosition, int aHotKey = 0 );
2010-02-01 21:23:27 +00:00
void InstallOptionsDisplay( wxCommandEvent& event );
MODULE* Get_Module( const wxString& CmpName );
void Process_Settings( wxCommandEvent& event );
/**
* Display 3D frame of current footprint selection.
*/
2010-02-01 21:23:27 +00:00
void Show3D_Frame( wxCommandEvent& event );
/* 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
*/
virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy,
UNDO_REDO_T aTypeCommand = UR_UNSPECIFIED,
2010-02-01 21:23:27 +00:00
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
{
}
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
* @param aTypeCommand = command type (see enum UNDO_REDO_T)
2010-02-01 21:23:27 +00:00
* @param aTransformPoint = the reference point of the transformation,
* for commands like move
*/
virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
UNDO_REDO_T aTypeCommand,
2010-02-01 21:23:27 +00:00
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
{
// currently: do nothing in CvPcb.
2010-02-01 21:23:27 +00:00
}
DECLARE_EVENT_TABLE()
};