kicad/eeschema/sch_base_frame.h

260 lines
9.4 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2015-2022 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 SCH_BASE_FRAME_H_
#define SCH_BASE_FRAME_H_
#include <eda_draw_frame.h>
#include <frame_type.h>
#include <sch_draw_panel.h>
#include <sch_screen.h>
#include <schematic_settings.h>
#include <stddef.h>
#include <utility>
#include <vector>
#include <wx/event.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
#include <template_fieldnames.h>
2018-08-14 18:52:10 +00:00
namespace KIGFX
{
class SCH_RENDER_SETTINGS;
}
class PAGE_INFO;
class TITLE_BLOCK;
2020-12-25 23:37:01 +00:00
class SYMBOL_VIEWER_FRAME;
2020-10-31 01:27:16 +00:00
class SYMBOL_EDIT_FRAME;
2021-06-10 18:51:46 +00:00
class LIB_SYMBOL;
class SYMBOL_LIB;
class SYMBOL_LIBRARY_FILTER;
class LIB_ID;
class SYMBOL_LIB_TABLE;
class EESCHEMA_SETTINGS;
2020-10-31 01:27:16 +00:00
class SYMBOL_EDITOR_SETTINGS;
/**
* Load symbol from symbol library table.
*
* Check the symbol library table for the part defined by \a aLibId and optionally
* check the optional cache library.
*
* @param aLibId is the symbol library identifier to load.
* @param aLibTable is the #SYMBOL_LIBRARY_TABLE to load the alias from.
* @param aCacheLib is an optional cache library.
2021-03-25 14:07:16 +00:00
* @param aParent is an optional parent window when displaying an error message.
* @param aShowErrorMessage set to true to show any error messages.
*
* @return The symbol found in the library or NULL if the symbol was not found.
*/
2021-06-17 21:22:10 +00:00
LIB_SYMBOL* SchGetLibSymbol( const LIB_ID& aLibId, SYMBOL_LIB_TABLE* aLibTable,
2021-07-16 20:13:26 +00:00
SYMBOL_LIB* aCacheLib = nullptr, wxWindow* aParent = nullptr,
2021-06-17 21:22:10 +00:00
bool aShowErrorMsg = false );
/**
* A shim class between EDA_DRAW_FRAME and several derived classes:
2020-12-25 23:37:01 +00:00
* SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, and SCH_EDIT_FRAME, and it brings in a
* common way of handling the provided virtual functions for the derived classes.
*
* The motivation here is to switch onto GetScreen() for the underlying data model.
*
* @author Dick Hollenbeck
*/
class SCH_BASE_FRAME : public EDA_DRAW_FRAME
{
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
SCH_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent,
FRAME_T aWindowType,
const wxString& aTitle,
const wxPoint& aPosition, const wxSize& aSize,
long aStyle, const wxString & aFrameName );
virtual ~SCH_BASE_FRAME();
void createCanvas();
SCH_DRAW_PANEL* GetCanvas() const override;
2016-09-25 17:06:49 +00:00
SCH_SCREEN* GetScreen() const override;
EESCHEMA_SETTINGS* eeconfig() const;
2020-10-31 01:27:16 +00:00
SYMBOL_EDITOR_SETTINGS* libeditconfig() const;
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
KIGFX::SCH_RENDER_SETTINGS* GetRenderSettings();
COLOR4D GetDrawBgColor() const override;
/**
* Allow some frames to show/hide hidden pins. The default impl shows all pins.
*/
virtual bool GetShowAllPins() const { return true; }
2016-09-25 17:06:49 +00:00
void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
const PAGE_INFO& GetPageSettings () const override;
const wxSize GetPageSizeIU() const override;
const VECTOR2I& GetGridOrigin() const override
{
static VECTOR2I zero;
return zero;
}
void SetGridOrigin( const VECTOR2I& aPoint ) override {}
2016-09-25 17:06:49 +00:00
const TITLE_BLOCK& GetTitleBlock() const override;
void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
2016-09-25 17:06:49 +00:00
void UpdateStatusBar() override;
/**
2021-05-05 21:41:51 +00:00
* Call the library viewer to select symbol to import into schematic.
* If the library viewer is currently running, it is closed and reopened in modal mode.
*
2021-05-05 21:41:51 +00:00
* aAllowFields chooses whether or not features that permit the user to edit fields
* (e.g. footprint selection) should be enabled. This should be false when they would
* have no effect, for example loading a part into symbol_editor.
*
* @param aFilter is an optional #SYMBOL_LIBRARY_FILTER filter to pass the allowed library names
2021-05-05 21:41:51 +00:00
* and/or the library name to load the symbol from and/or some other filter
* @param aHistoryList is the list of previously loaded symbols - will be edited
* @param aUseLibBrowser is the flag to call the library viewer to select the symbol
2021-03-25 14:07:16 +00:00
* @param aUnit is the preselected unit.
* @param aConvert is the preselected De Morgan shape.
2021-05-05 21:41:51 +00:00
* @param aHighlight is the name of symbol to highlight in the list.
2021-03-25 14:07:16 +00:00
* highlights none if there isn't one by that name.
* @param aShowFootprints is the whether to show footprints in the dialog.
* @param aAllowFields is whether to allow field editing in the dialog.
*
2021-05-05 21:41:51 +00:00
* @return the selected symbol
*/
PICKED_SYMBOL PickSymbolFromLibTree( const SYMBOL_LIBRARY_FILTER* aFilter,
2020-11-07 14:31:50 +00:00
std::vector<PICKED_SYMBOL>& aHistoryList,
bool aUseLibBrowser,
int aUnit,
int aConvert,
bool aShowFootprints,
const LIB_ID* aHighlight = nullptr,
bool aAllowFields = true );
/**
* Load symbol from symbol library table.
*
* @param aLibId is the symbol library identifier to load.
* @param aUseCacheLib set to true to fall back to cache library if symbol is not found in
* symbol library table.
* @param aShowErrorMessage set to true to show any error messages.
* @return The symbol found in the library or NULL if the symbol was not found.
*/
2021-06-17 21:22:10 +00:00
LIB_SYMBOL* GetLibSymbol( const LIB_ID& aLibId, bool aUseCacheLib = false,
bool aShowErrorMsg = false );
/**
2021-05-05 21:41:51 +00:00
* Call the library viewer to select symbol to import into schematic.
* If the library viewer is currently running, it is closed and reopened in modal mode.
2021-03-25 14:07:16 +00:00
*
* @param aParent is the caller.
* @param aFilter is a filter to pass the allowed library names
2021-03-25 14:07:16 +00:00
* and/or some other filter.
2021-05-05 21:41:51 +00:00
* @param aPreselectedLibId is the preselected symbol's #LIB_ID. Not valid if none selected.
2021-03-25 14:07:16 +00:00
* @param aUnit is the preselected unit.
* @param aConvert is the preselected deMorgan conversion.
2021-05-05 21:41:51 +00:00
* @return the selected symbol.
*/
2020-11-07 14:31:50 +00:00
PICKED_SYMBOL PickSymbolFromLibBrowser( wxTopLevelWindow* aParent,
const SYMBOL_LIBRARY_FILTER* aFilter,
2020-11-07 14:31:50 +00:00
const LIB_ID& aPreselectedLibId,
int aUnit, int aConvert );
virtual void RedrawScreen( const VECTOR2I& aCenterPoint, bool aWarpPointer );
virtual void CenterScreen( const VECTOR2I& aCenterPoint, bool aWarpPointer );
2018-09-08 20:57:56 +00:00
2019-05-28 18:44:14 +00:00
void HardRedraw() override;
2018-09-10 10:58:50 +00:00
/**
* Add an item to the screen (and view)
* aScreen is the screen the item is located on, if not the current screen
2018-09-10 10:58:50 +00:00
*/
void AddToScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen );
2018-09-10 10:58:50 +00:00
/**
* Remove an item from the screen (and view)
* aScreen is the screen the item is located on, if not the current screen
2018-09-10 10:58:50 +00:00
*/
void RemoveFromScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen );
2018-09-10 10:58:50 +00:00
/**
* Mark an item for refresh.
*/
2022-01-07 17:42:43 +00:00
virtual void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
bool aUpdateRtree = false );
2018-09-10 10:58:50 +00:00
/**
* Mark selected items for refresh.
*/
void RefreshSelection();
2018-09-10 10:58:50 +00:00
/**
* Mark all items for refresh.
*/
void SyncView();
2019-05-08 18:56:03 +00:00
/**
* Must be called after a model change in order to set the "modify" flag and
* do other frame-specific processing.
*/
virtual void OnModify() {}
void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
/**
* Helper to retrieve a layer color from the global color settings
*/
COLOR4D GetLayerColor( SCH_LAYER_ID aLayer );
2021-09-07 20:34:10 +00:00
COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
protected:
/**
2021-03-25 14:07:16 +00:00
* Save Symbol Library Tables to disk.
*
* @param aGlobal when true, the Global Table is saved.
* @param aProject when true, the Project Table is saved.
* @return True when all requested actions succeeded.
*/
bool saveSymbolLibTables( bool aGlobal, bool aProject );
2021-03-25 14:07:16 +00:00
/// These are only used by symbol_editor. Eeschema should be using the one inside
/// the SCHEMATIC.
SCHEMATIC_SETTINGS m_base_frame_defaults;
};
#endif // SCH_BASE_FRAME_H_