KiCad PCB EDA Suite
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at
5  * Copyright (C) 2008 Wayne Stambaugh <>
6  * Copyright (C) 2004-2017 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  *
21  * or you may search the website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
30 #ifndef LIBVIEWFRM_H_
31 #define LIBVIEWFRM_H_
34 #include <wx/gdicmn.h>
36 #include <sch_base_frame.h>
37 #include <sch_screen.h>
39 class wxListBox;
41 class LIB_ALIAS;
42 class LIB_PART;
50 {
51 public:
61  LIB_VIEW_FRAME( KIWAY* aKiway, wxWindow* aParent,
62  FRAME_T aFrameType, const wxString& aLibraryName = wxEmptyString );
66  void OnSize( wxSizeEvent& event ) override;
74  bool ReCreateListLib();
82  bool ReCreateListCmp();
83  void DisplayLibInfos();
84  void RedrawActiveWindow( wxDC* DC, bool EraseBg ) override;
85  void OnCloseWindow( wxCloseEvent& Event );
86  void CloseLibraryViewer( wxCommandEvent& event );
87  void ReCreateHToolbar() override;
88  void ReCreateVToolbar() override;
89  void ReCreateMenuBar() override;
91  void OnLeftClick( wxDC* DC, const wxPoint& MousePos ) override;
92  double BestZoom() override;
93  void ClickOnLibList( wxCommandEvent& event );
94  void ClickOnCmpList( wxCommandEvent& event );
95  void OnSetRelativeOffset( wxCommandEvent& event );
96  void OnSelectSymbol( wxCommandEvent& aEvent );
97  void OnShowElectricalType( wxCommandEvent& event );
99  bool GeneralControl( wxDC* aDC, const wxPoint& aPosition, EDA_KEY aHotKey = 0 ) override;
102  EDA_HOTKEY* GetHotKeyDescription( int aCommand ) const override;
112  bool OnHotKey( wxDC* aDC, int aHotKey, const wxPoint& aPosition,
113  EDA_ITEM* aItem = NULL ) override;
115  void LoadSettings( wxConfigBase* aCfg ) override;
116  void SaveSettings( wxConfigBase* aCfg ) override;
125  void SetFilter( const SCHLIB_FILTER* aFilter );
132  void SetSelectedLibrary( const wxString& aLibName );
139  void SetSelectedComponent( const wxString& aComponentName );
141  // Accessors:
148  void SetUnitAndConvert( int aUnit, int aConvert );
149  int GetUnit( void ) { return m_unit; }
150  int GetConvert( void ) { return m_convert; }
153  void SetShowElectricalType( bool aShow ) { m_showPinElectricalTypeName = aShow; }
155 private:
160  virtual void OnActivate( wxActivateEvent& event ) override;
166  void ExportToSchematicLibraryPart( wxCommandEvent& event );
167  bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu ) override;
168  void DClickOnCmpList( wxCommandEvent& event );
170  void onUpdateAlternateBodyStyleButton( wxUpdateUIEvent& aEvent );
171  void onUpdateNormalBodyStyleButton( wxUpdateUIEvent& aEvent );
172  void onUpdateViewDoc( wxUpdateUIEvent& aEvent );
173  void OnUpdateElectricalType( wxUpdateUIEvent& aEvent );
174  void onSelectNextSymbol( wxCommandEvent& aEvent );
175  void onSelectPreviousSymbol( wxCommandEvent& aEvent );
176  void onViewSymbolDocument( wxCommandEvent& aEvent );
177  void onSelectSymbolBodyStyle( wxCommandEvent& aEvent );
178  void onSelectSymbolUnit( wxCommandEvent& aEvent );
183 // Private members:
184  wxComboBox* m_selpartBox;
186  // List of libraries (for selection )
187  wxListBox* m_libList; // The list of libs
188  int m_libListWidth; // Last width of the window
190  // List of components in the selected library
191  wxListBox* m_cmpList; // The list of components
192  int m_cmpListWidth; // Last width of the window
194  // Filters to build list of libs/list of parts
196  wxArrayString m_allowedLibs;
198  // TODO(hzeller): looks like these members were chosen to be static to survive different
199  // instances of this browser and communicate it to the next instance. This looks like an
200  // ugly hack, and should be solved differently.
201  static wxString m_libraryName;
203  static wxString m_entryName;
205  static int m_unit;
206  static int m_convert;
220 };
222 #endif // LIBVIEWFRM_H_
static int m_unit
static int m_convert
void SetFilter(const SCHLIB_FILTER *aFilter)
Set a filter to display only libraries and/or components which match the filter.
static wxString m_entryName
Part library alias object definition.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
void SetUnitAndConvert(int aUnit, int aConvert)
Set unit and convert, and set flag preventing them from automatically resetting to 1...
bool m_selection_changed
Updated to true if a list rewrite on GUI activation resulted in the component selection changing...
void onUpdateViewDoc(wxUpdateUIEvent &aEvent)
virtual void OnActivate(wxActivateEvent &event) override
Called when the frame is activated to reload the libraries and component lists that can be changed by...
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
bool OnRightClick(const wxPoint &MousePos, wxMenu *PopMenu) override
Definition: viewlibs.cpp:170
EDA_HOTKEY * GetHotKeyDescription(int aCommand) const override
void onSelectPreviousSymbol(wxCommandEvent &aEvent)
Definition: viewlibs.cpp:105
void OnCloseWindow(wxCloseEvent &Event)
void SetShowElectricalType(bool aShow)
void OnLeftClick(wxDC *DC, const wxPoint &MousePos) override
Definition: viewlibs.cpp:165
wxListBox * m_cmpList
wxArrayString m_allowedLibs
static wxString m_libraryName
LIB_ALIAS * getSelectedAlias()
void SetSelectedComponent(const wxString &aComponentName)
Set the selected component.
Symbol library viewer main window.
Definition: viewlib_frame.h:49
void OnSelectSymbol(wxCommandEvent &aEvent)
Definition: viewlibs.cpp:44
void onViewSymbolDocument(wxCommandEvent &aEvent)
Definition: viewlibs.cpp:119
bool m_showPinElectricalTypeName
the option to show the pin electrical name in the component editor
bool OnHotKey(wxDC *aDC, int aHotKey, const wxPoint &aPosition, EDA_ITEM *aItem=NULL) override
Handle hot key events.
LIB_VIEW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aLibraryName=wxEmptyString)
void ReCreateMenuBar() override
Function ReCreateMenuBar Creates recreates the menu bar.
int GetUnit(void)
void CloseLibraryViewer(wxCommandEvent &event)
void RedrawActiveWindow(wxDC *DC, bool EraseBg) override
Definition: viewlibs.cpp:189
void onSelectSymbolBodyStyle(wxCommandEvent &aEvent)
Definition: viewlibs.cpp:133
LIB_PART * getSelectedSymbol()
Define a library symbol object.
void ReCreateHToolbar() override
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:258
uint32_t EDA_KEY
Definition: common.h:52
void OnSetRelativeOffset(wxCommandEvent &event)
bool ReCreateListCmp()
Create or recreate the list of components in the currently selected library.
void ExportToSchematicLibraryPart(wxCommandEvent &event)
Function ExportToSchematicLibraryPart exports the current component to schematic and close the librar...
void DisplayLibInfos()
Definition: viewlibs.cpp:176
int GetConvert(void)
void ClickOnLibList(wxCommandEvent &event)
Definitions for the Eeschema program SCH_SCREEN class.
void onSelectNextSymbol(wxCommandEvent &aEvent)
Definition: viewlibs.cpp:91
void SaveSettings(wxConfigBase *aCfg) override
Function SaveSettings saves common frame parameters to a configuration data file. ...
class EDA_HOTKEY is a class to handle hot key commands.
Definition: hotkeys_basic.h:57
void onUpdateNormalBodyStyleButton(wxUpdateUIEvent &aEvent)
void OnUpdateElectricalType(wxUpdateUIEvent &aEvent)
wxListBox * m_libList
void LoadSettings(wxConfigBase *aCfg) override
Function LoadSettings loads common frame parameters from a configuration file.
void onUpdateAlternateBodyStyleButton(wxUpdateUIEvent &aEvent)
void ClickOnCmpList(wxCommandEvent &event)
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:162
double BestZoom() override
Return the zoom level which displays the full page on screen.
void ReCreateVToolbar() override
bool GetShowElectricalType()
void onSelectSymbolUnit(wxCommandEvent &aEvent)
Definition: viewlibs.cpp:153
bool GeneralControl(wxDC *aDC, const wxPoint &aPosition, EDA_KEY aHotKey=0) override
Function GeneralControl performs application specific control using aDC at aPosition in logical units...
void OnShowElectricalType(wxCommandEvent &event)
void DClickOnCmpList(wxCommandEvent &event)
bool ReCreateListLib()
Creates or recreates a sorted list of currently loaded libraries.
A shim class between EDA_DRAW_FRAME and several derived classes: LIB_EDIT_FRAME, LIB_VIEW_FRAME, and SCH_EDIT_FRAME, and it brings in a common way of handling the provided virtual functions for the derived classes.
wxComboBox * m_selpartBox
void SetSelectedLibrary(const wxString &aLibName)
Set the selected library in the library window.
void OnSize(wxSizeEvent &event) override
Function OnSize recalculates the size of toolbars and display panel when the frame size changes...