kicad/eeschema/symbol_viewer_frame.h

210 lines
6.7 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2004-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 LIB_VIEW_FRAME_H__
#define LIB_VIEW_FRAME_H__
#include <sch_base_frame.h>
#include <sch_screen.h>
#include <tool/selection.h>
class WX_LISTBOX;
class wxSearchCtrl;
class SYMBOL_LIBRARY_FILTER;
2021-06-10 18:51:46 +00:00
class LIB_SYMBOL;
class SYMBOL_LIB_TABLE_ROW;
/**
* Symbol library viewer main window.
*/
2020-12-25 23:37:01 +00:00
class SYMBOL_VIEWER_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
/**
* @param aKiway
2021-03-25 21:13:01 +00:00
* @param aParent is the parent frame of the viewer.
* @param aFrameType must be either #FRAME_SCH_LIB_VIEWER or #FRAME_SCH_LIB_VIEWER_MODAL.
* @param aLibrary is 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
*/
2020-12-25 23:37:01 +00:00
SYMBOL_VIEWER_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
const wxString& aLibraryName = wxEmptyString );
2020-12-25 23:37:01 +00:00
~SYMBOL_VIEWER_FRAME();
/**
2021-03-25 21:13:01 +00:00
* 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;
/**
2021-03-25 21:13:01 +00:00
* Create o recreates a sorted list of currently loaded libraries.
*
2021-03-25 21:13:01 +00:00
* @return whether the selection of either library or symbol was changed (i.e. because the
* selected library no longer exists).
*/
2020-12-17 23:56:47 +00:00
bool ReCreateLibList();
/**
2021-03-25 21:13:01 +00:00
* Create or recreate the list of symbols in the currently selected library.
*
2021-03-25 21:13:01 +00:00
* @return whether the selection was changed (i.e. because the selected symbol no longer
* exists).
*/
2020-12-17 23:56:47 +00:00
bool ReCreateSymbolList();
void DisplayLibInfos();
void doCloseWindow() override;
void CloseLibraryViewer( wxCommandEvent& event );
2016-09-24 18:53:15 +00:00
void ReCreateHToolbar() override;
void ReCreateVToolbar() override;
void ReCreateOptToolbar() override {}
void ClickOnLibList( wxCommandEvent& event );
void ClickOnSymbolList( wxCommandEvent& event );
void OnSelectSymbol( wxCommandEvent& aEvent );
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
/**
2021-03-25 21:13:01 +00:00
* Set a filter to display only libraries and/or symbols which match the filter.
*
* @param aFilter is a filter to pass the allowed library name list and/or some other filter
* see SCH_BASE_FRAME::SelectSymbolFromLibrary() for details.
2021-03-25 21:13:01 +00:00
* if aFilter == NULL, remove all filtering.
*/
void SetFilter( const SYMBOL_LIBRARY_FILTER* aFilter );
/**
* Set the selected library in the library window.
*/
void SetSelectedLibrary( const wxString& aLibName,
const wxString& aSubLibName = wxEmptyString );
/**
2021-03-25 21:13:01 +00:00
* Set the selected symbol.
*/
2021-03-19 20:27:30 +00:00
void SetSelectedSymbol( const wxString& aSymbolName );
// Accessors:
/**
2021-03-25 21:13:01 +00:00
* Set unit and convert, and set flag preventing them from automatically resetting to 1.
*
2021-03-25 21:13:01 +00:00
* @param aUnit is the unit, if invalid will be set to 1.
* @param aConvert is the alternate body style, if invalid will be set to 1.
*/
void SetUnitAndConvert( int aUnit, int aConvert );
int GetUnit() const { return m_unit; }
int GetConvert() const { return m_convert; }
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* GetSelectedSymbol() const;
2019-06-01 18:36:49 +00:00
const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
SELECTION& GetCurrentSelection() override;
protected:
void setupUIConditions() override;
2019-06-01 18:36:49 +00:00
void doReCreateMenuBar() override;
private:
2021-03-25 21:13:01 +00:00
// Set up the tool framework.
void setupTools();
/**
2021-03-25 21:13:01 +00:00
* Called when the frame is activated to reload the libraries and symbol lists
* that can be changed by the schematic editor or the library editor.
*/
2019-05-30 15:11:17 +00:00
void OnActivate( wxActivateEvent& event );
void DClickOnSymbolList( wxCommandEvent& event );
void onUpdateUnitChoice( wxUpdateUIEvent& aEvent );
void OnLibFilter( wxCommandEvent& aEvent );
void OnSymFilter( wxCommandEvent& aEvent );
void OnCharHook( wxKeyEvent& aEvent ) override;
void onSelectNextSymbol( wxCommandEvent& aEvent );
void onSelectPreviousSymbol( wxCommandEvent& aEvent );
void onSelectSymbolUnit( wxCommandEvent& aEvent );
void updatePreviewSymbol();
void loadAllLibraries();
2020-12-17 23:56:47 +00:00
private:
wxChoice* m_unitChoice;
wxSearchCtrl* m_libFilter;
WX_LISTBOX* m_libList; // The list of libraries.
2021-03-25 21:13:01 +00:00
int m_libListWidth; // Last width of the window.
wxSearchCtrl* m_symbolFilter;
WX_LISTBOX* m_symbolList; // The list of symbols.
2021-03-25 21:13:01 +00:00
int m_symbolListWidth; // Last width of the window.
2021-03-25 21:13:01 +00:00
// Filters to build list of libs/list of symbols.
bool m_listPowerOnly;
wxArrayString m_allowedLibs;
static LIB_ID m_currentSymbol;
2019-06-17 19:02:48 +00:00
static int m_unit;
static int m_convert;
static bool m_show_progress;
/**
2021-03-25 21:13:01 +00:00
* Updated to `true` if a list rewrite on GUI activation resulted in the symbol
* selection changing, or if the user has changed the selection manually.
*/
bool m_selection_changed;
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* m_previewItem;
DECLARE_EVENT_TABLE()
};
#endif // LIB_VIEW_FRAME_H__