2012-09-11 19:03:21 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2016-11-04 11:13:22 +00:00
|
|
|
* Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
2017-09-02 18:12:50 +00:00
|
|
|
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
|
2019-04-15 21:09:14 +00:00
|
|
|
* Copyright (C) 2004-2019 KiCad Developers, see AUTHORS.txt for contributors.
|
2012-09-11 19:03:21 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2018-08-27 13:28:44 +00:00
|
|
|
#ifndef LIB_VIEW_FRAME_H__
|
|
|
|
#define LIB_VIEW_FRAME_H__
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
#include <sch_base_frame.h>
|
2018-01-30 08:56:43 +00:00
|
|
|
#include <sch_screen.h>
|
2020-08-06 23:03:58 +00:00
|
|
|
#include <tool/selection.h>
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
class wxListBox;
|
2015-04-16 15:26:51 +00:00
|
|
|
class SCHLIB_FILTER;
|
2016-10-21 12:38:08 +00:00
|
|
|
class LIB_PART;
|
2017-09-02 18:12:50 +00:00
|
|
|
class SYMBOL_LIB_TABLE_ROW;
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
2017-09-02 18:12:50 +00:00
|
|
|
* Symbol library viewer main window.
|
2012-09-11 19:03:21 +00:00
|
|
|
*/
|
|
|
|
class LIB_VIEW_FRAME : public SCH_BASE_FRAME
|
|
|
|
{
|
|
|
|
public:
|
Modular-Kicad milestone B), major portions:
*) Rework the set language support, simplify it by using KIWAY. Now any major
frame with a "change language" menu can change the language for all KIWAY_PLAYERs
in the whole KIWAY. Multiple KIWAYs are not supported yet.
*) Simplify "modal wxFrame" support, and add that support exclusively to
KIWAY_PLAYER where it is inherited by all derivatives. The function
KIWAY_PLAYER::ShowModal() is in the vtable and so is cross module capable.
*) Remove the requirements and assumptions that the wxFrame hierarchy always
had PCB_EDIT_FRAME and SCH_EDIT_FRAME as immediate parents of their viewers
and editors. This is no longer the case, nor required.
*) Use KIWAY::Player() everywhere to make KIWAY_PLAYERs, this registers the
KIWAY_PLAYER within the KIWAY and makes it very easy to find an open frame
quickly. It also gives control to the KIWAY as to frame hierarchical
relationships.
*) Change single_top to use the KIWAY for loading a KIFACE and instantiating
the single KIWAY_PLAYER, see bullet immediately above.
*) Add KIWAY::OnKiwayEnd() and call it from PGM_BASE at program termination, this
gives the KIFACEs a chance to save their final configuration dope to disk.
*) Add dedicated FRAME_T's for the modal frames, so m_Ident can be tested and
these modal frames are distinctly different than their non-modal equivalents.
KIWAY_PLAYER::IsModal() is !not! a valid test during the wxFrame's constructor,
so this is another important reason for having a dedicated FRAME_T for each
modal wxFrame.
On balance, more lines were deleted than were added to achieve all this.
2014-05-03 17:40:19 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
2014-11-02 16:25:04 +00:00
|
|
|
* @param aKiway
|
|
|
|
* @param aParent = the parent frame
|
2019-05-04 11:23:04 +00:00
|
|
|
* @param aFrameType must be either FRAME_SCH_LIB_VIEWER or FRAME_SCH_LIB_VIEWER_MODAL
|
2014-11-02 16:25:04 +00:00
|
|
|
* @param aLibrary = the library to open when starting (default = NULL)
|
Modular-Kicad milestone B), major portions:
*) Rework the set language support, simplify it by using KIWAY. Now any major
frame with a "change language" menu can change the language for all KIWAY_PLAYERs
in the whole KIWAY. Multiple KIWAYs are not supported yet.
*) Simplify "modal wxFrame" support, and add that support exclusively to
KIWAY_PLAYER where it is inherited by all derivatives. The function
KIWAY_PLAYER::ShowModal() is in the vtable and so is cross module capable.
*) Remove the requirements and assumptions that the wxFrame hierarchy always
had PCB_EDIT_FRAME and SCH_EDIT_FRAME as immediate parents of their viewers
and editors. This is no longer the case, nor required.
*) Use KIWAY::Player() everywhere to make KIWAY_PLAYERs, this registers the
KIWAY_PLAYER within the KIWAY and makes it very easy to find an open frame
quickly. It also gives control to the KIWAY as to frame hierarchical
relationships.
*) Change single_top to use the KIWAY for loading a KIFACE and instantiating
the single KIWAY_PLAYER, see bullet immediately above.
*) Add KIWAY::OnKiwayEnd() and call it from PGM_BASE at program termination, this
gives the KIFACEs a chance to save their final configuration dope to disk.
*) Add dedicated FRAME_T's for the modal frames, so m_Ident can be tested and
these modal frames are distinctly different than their non-modal equivalents.
KIWAY_PLAYER::IsModal() is !not! a valid test during the wxFrame's constructor,
so this is another important reason for having a dedicated FRAME_T for each
modal wxFrame.
On balance, more lines were deleted than were added to achieve all this.
2014-05-03 17:40:19 +00:00
|
|
|
*/
|
|
|
|
LIB_VIEW_FRAME( KIWAY* aKiway, wxWindow* aParent,
|
2017-09-02 18:12:50 +00:00
|
|
|
FRAME_T aFrameType, const wxString& aLibraryName = wxEmptyString );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
~LIB_VIEW_FRAME();
|
|
|
|
|
2019-01-31 01:07:53 +00:00
|
|
|
/**
|
|
|
|
* Function ShowModal
|
|
|
|
*
|
|
|
|
* Runs the Symbol Viewer as a modal dialog.
|
|
|
|
* @param aSymbol an optional FPID string to initialize the viewer with and to
|
|
|
|
* return a selected footprint through.
|
|
|
|
*/
|
|
|
|
bool ShowModal( wxString* aSymbol, wxWindow* aParent ) override;
|
|
|
|
|
2019-06-16 18:51:47 +00:00
|
|
|
/**
|
|
|
|
* Send the selected symbol back to the caller.
|
|
|
|
*/
|
|
|
|
void FinishModal();
|
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void OnSize( wxSizeEvent& event ) override;
|
2012-09-11 19:03:21 +00:00
|
|
|
|
|
|
|
/**
|
2017-09-02 18:12:50 +00:00
|
|
|
* Creates or recreates a sorted list of currently loaded libraries.
|
2017-07-17 20:57:15 +00:00
|
|
|
*
|
|
|
|
* @return whether the selection of either library or component was changed (i.e. because the
|
|
|
|
* selected library no longer exists)
|
2012-09-11 19:03:21 +00:00
|
|
|
*/
|
2017-07-17 20:57:15 +00:00
|
|
|
bool ReCreateListLib();
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2017-07-17 20:57:15 +00:00
|
|
|
/**
|
|
|
|
* Create or recreate the list of components in the currently selected library.
|
|
|
|
*
|
|
|
|
* @return whether the selection was changed (i.e. because the selected component no longer
|
|
|
|
* exists)
|
|
|
|
*/
|
|
|
|
bool ReCreateListCmp();
|
2019-05-04 11:23:04 +00:00
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
void DisplayLibInfos();
|
2020-11-29 08:01:21 +00:00
|
|
|
void doCloseWindow() override;
|
2014-10-15 11:40:38 +00:00
|
|
|
void CloseLibraryViewer( wxCommandEvent& event );
|
2016-09-24 18:53:15 +00:00
|
|
|
void ReCreateHToolbar() override;
|
|
|
|
void ReCreateVToolbar() override;
|
2019-07-20 15:52:30 +00:00
|
|
|
void ReCreateOptToolbar() override {}
|
2016-09-24 18:53:15 +00:00
|
|
|
void ReCreateMenuBar() override;
|
2014-10-15 11:40:38 +00:00
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
void ClickOnLibList( wxCommandEvent& event );
|
|
|
|
void ClickOnCmpList( wxCommandEvent& event );
|
2016-10-21 12:38:08 +00:00
|
|
|
void OnSelectSymbol( wxCommandEvent& aEvent );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2020-01-13 01:44:19 +00:00
|
|
|
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
|
|
|
|
WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
|
2020-07-17 20:04:14 +00:00
|
|
|
void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2015-04-16 15:26:51 +00:00
|
|
|
/**
|
2017-09-02 18:12:50 +00:00
|
|
|
* Set a filter to display only libraries and/or components which match the filter.
|
2015-04-16 15:26:51 +00:00
|
|
|
*
|
2017-09-02 18:12:50 +00:00
|
|
|
* @param aFilter is a filter to pass the allowed library name list and/or some other filter
|
|
|
|
* see SCH_BASE_FRAME::SelectComponentFromLibrary() for details.
|
|
|
|
* if aFilter == NULL, remove all filtering
|
2015-04-16 15:26:51 +00:00
|
|
|
*/
|
|
|
|
void SetFilter( const SCHLIB_FILTER* aFilter );
|
|
|
|
|
2014-02-24 10:52:08 +00:00
|
|
|
/**
|
|
|
|
* Set the selected library in the library window.
|
|
|
|
*
|
|
|
|
* @param aLibName name of the library to be selected.
|
|
|
|
*/
|
|
|
|
void SetSelectedLibrary( const wxString& aLibName );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the selected component.
|
|
|
|
*
|
2014-11-02 16:25:04 +00:00
|
|
|
* @param aComponentName : the name of the component to be selected.
|
2014-02-24 10:52:08 +00:00
|
|
|
*/
|
|
|
|
void SetSelectedComponent( const wxString& aComponentName );
|
|
|
|
|
2014-11-02 16:25:04 +00:00
|
|
|
// Accessors:
|
2017-07-17 20:57:15 +00:00
|
|
|
/**
|
|
|
|
* Set unit and convert, and set flag preventing them from automatically resetting to 1
|
2017-09-02 18:12:50 +00:00
|
|
|
*
|
2017-07-17 20:57:15 +00:00
|
|
|
* @param aUnit - unit; if invalid will be set to 1
|
|
|
|
* @param aConvert - convert; if invalid will be set to 1
|
|
|
|
*/
|
|
|
|
void SetUnitAndConvert( int aUnit, int aConvert );
|
2018-08-29 18:31:43 +00:00
|
|
|
int GetUnit() const { return m_unit; }
|
|
|
|
int GetConvert() const { return m_convert; }
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2019-11-07 14:09:24 +00:00
|
|
|
LIB_PART* GetSelectedSymbol() const;
|
2019-06-01 18:36:49 +00:00
|
|
|
|
2020-09-25 07:31:56 +00:00
|
|
|
const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
|
2018-08-27 13:28:44 +00:00
|
|
|
|
2020-08-06 23:03:58 +00:00
|
|
|
SELECTION& GetCurrentSelection() override;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
void setupUIConditions() override;
|
2019-06-01 18:36:49 +00:00
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
private:
|
2019-05-04 11:23:04 +00:00
|
|
|
// Sets up the tool framework
|
|
|
|
void setupTools();
|
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
/**
|
2017-09-02 18:12:50 +00:00
|
|
|
* Called when the frame is activated to reload the libraries and component lists
|
2012-09-11 19:03:21 +00:00
|
|
|
* that can be changed by the schematic editor or the library editor.
|
|
|
|
*/
|
2019-05-30 15:11:17 +00:00
|
|
|
void OnActivate( wxActivateEvent& event );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2012-12-04 19:04:04 +00:00
|
|
|
void DClickOnCmpList( wxCommandEvent& event );
|
2012-09-11 19:03:21 +00:00
|
|
|
|
2018-08-29 18:31:43 +00:00
|
|
|
void onUpdateUnitChoice( wxUpdateUIEvent& aEvent );
|
2019-04-15 21:09:14 +00:00
|
|
|
|
2016-10-21 12:38:08 +00:00
|
|
|
void onSelectNextSymbol( wxCommandEvent& aEvent );
|
|
|
|
void onSelectPreviousSymbol( wxCommandEvent& aEvent );
|
|
|
|
void onSelectSymbolUnit( wxCommandEvent& aEvent );
|
|
|
|
|
2018-08-29 18:31:43 +00:00
|
|
|
void updatePreviewSymbol();
|
2016-10-21 12:38:08 +00:00
|
|
|
|
2015-04-16 15:26:51 +00:00
|
|
|
// Private members:
|
2018-08-29 18:31:43 +00:00
|
|
|
wxChoice* m_unitChoice;
|
2014-02-24 10:52:08 +00:00
|
|
|
|
|
|
|
// List of libraries (for selection )
|
|
|
|
wxListBox* m_libList; // The list of libs
|
|
|
|
int m_libListWidth; // Last width of the window
|
|
|
|
|
|
|
|
// List of components in the selected library
|
|
|
|
wxListBox* m_cmpList; // The list of components
|
|
|
|
int m_cmpListWidth; // Last width of the window
|
|
|
|
|
2015-04-16 15:26:51 +00:00
|
|
|
// Filters to build list of libs/list of parts
|
|
|
|
bool m_listPowerCmpOnly;
|
|
|
|
wxArrayString m_allowedLibs;
|
|
|
|
|
2019-06-17 19:02:48 +00:00
|
|
|
static wxString m_libraryName;
|
|
|
|
static wxString m_entryName;
|
2014-02-24 10:52:08 +00:00
|
|
|
|
2019-06-17 19:02:48 +00:00
|
|
|
static int m_unit;
|
|
|
|
static int m_convert;
|
2014-02-24 10:52:08 +00:00
|
|
|
|
2017-07-17 20:57:15 +00:00
|
|
|
/**
|
|
|
|
* Updated to `true` if a list rewrite on GUI activation resulted in the component
|
|
|
|
* selection changing, or if the user has changed the selection manually.
|
|
|
|
*/
|
|
|
|
bool m_selection_changed;
|
|
|
|
|
2019-11-07 14:09:24 +00:00
|
|
|
LIB_PART* m_previewItem;
|
2018-08-29 18:31:43 +00:00
|
|
|
|
2012-09-11 19:03:21 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
|
|
|
};
|
|
|
|
|
2018-08-27 13:28:44 +00:00
|
|
|
#endif // LIB_VIEW_FRAME_H__
|
|
|
|
|