KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_viewer_frame.h
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 wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright The 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
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org 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 */
25
26
27#ifndef LIB_VIEW_FRAME_H__
28#define LIB_VIEW_FRAME_H__
29
30#include <sch_base_frame.h>
31#include <sch_screen.h>
32#include <tool/selection.h>
33
34class WX_LISTBOX;
35class wxSearchCtrl;
37class LIB_SYMBOL;
39
40
45{
46public:
47
54 SYMBOL_VIEWER_FRAME( KIWAY* aKiway, wxWindow* aParent );
55
57
58 void OnSize( wxSizeEvent& event ) override;
59
66 bool ReCreateLibList();
67
74 bool ReCreateSymbolList();
75
76 void DisplayLibInfos();
77 void doCloseWindow() override;
78 void CloseLibraryViewer( wxCommandEvent& event );
79
80 void ClickOnLibList( wxCommandEvent& event );
81 void ClickOnSymbolList( wxCommandEvent& event );
82
83 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
84 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
85
87
88 void CommonSettingsChanged( int aFlags ) override;
89
93 void SetSelectedLibrary( const wxString& aLibName,
94 const wxString& aSubLibName = wxEmptyString );
95
99 void SetSelectedSymbol( const wxString& aSymbolName );
100
101 // Accessors:
108 void SetUnitAndBodyStyle( int aUnit, int aBodyStyle );
109 int GetUnit() const { return m_unit; }
110 int GetBodyStyle() const { return m_bodyStyle; }
111
113
114 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
115
116 SELECTION& GetCurrentSelection() override;
117
118 void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
119
120protected:
121 void configureToolbars() override;
122
123 void setupUIConditions() override;
124
125 void doReCreateMenuBar() override;
126
127private:
128 // Set up the tool framework.
129 void setupTools();
130
135 void OnActivate( wxActivateEvent& event );
136
137 void DClickOnSymbolList( wxCommandEvent& event );
138
139 void onUpdateUnitChoice( wxUpdateUIEvent& aEvent );
140 void onUpdateBodyStyleChoice( wxUpdateUIEvent& aEvent );
141
142 void OnLibFilter( wxCommandEvent& aEvent );
143 void OnSymFilter( wxCommandEvent& aEvent );
144 void OnCharHook( wxKeyEvent& aEvent ) override;
145
146 void onSelectNextSymbol( wxCommandEvent& aEvent );
147 void onSelectPreviousSymbol( wxCommandEvent& aEvent );
148 void onSelectSymbolUnit( wxCommandEvent& aEvent );
149 void onSelectSymbolBodyStyle( wxCommandEvent& aEvent );
150
151 void updatePreviewSymbol();
152
153 void loadAllLibraries();
154
155private:
156 wxChoice* m_unitChoice;
158
159 wxSearchCtrl* m_libFilter;
160 WX_LISTBOX* m_libList; // The list of libraries.
161 int m_libListWidth; // Last width of the window.
162
163 wxSearchCtrl* m_symbolFilter;
164 WX_LISTBOX* m_symbolList; // The list of symbols.
165 int m_symbolListWidth; // Last width of the window.
166
167 // Filters to build list of libs/list of symbols.
169 wxArrayString m_allowedLibs;
170
172
173 static int m_unit;
174 static int m_bodyStyle;
175 static bool m_show_progress;
176
182
183 std::unique_ptr<LIB_SYMBOL> m_previewItem;
184
185 DECLARE_EVENT_TABLE()
186};
187
188#endif // LIB_VIEW_FRAME_H__
189
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
A logical library item identifier and consists of various portions much like a URI.
Definition lib_id.h:49
Define a library symbol object.
Definition lib_symbol.h:85
SCH_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aWindowType, const wxString &aTitle, const wxPoint &aPosition, const wxSize &aSize, long aStyle, const wxString &aFrameName)
Helper object to filter a list of libraries.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
void OnLibFilter(wxCommandEvent &aEvent)
std::unique_ptr< LIB_SYMBOL > m_previewItem
void CloseLibraryViewer(wxCommandEvent &event)
void onSelectNextSymbol(wxCommandEvent &aEvent)
void SetSelectedLibrary(const wxString &aLibName, const wxString &aSubLibName=wxEmptyString)
Set the selected library in the library window.
void ClickOnLibList(wxCommandEvent &event)
void onUpdateUnitChoice(wxUpdateUIEvent &aEvent)
SYMBOL_VIEWER_FRAME(KIWAY *aKiway, wxWindow *aParent)
void DClickOnSymbolList(wxCommandEvent &event)
void OnActivate(wxActivateEvent &event)
Called when the frame is activated to reload the libraries and symbol lists that can be changed by th...
void OnSymFilter(wxCommandEvent &aEvent)
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void SetSelectedSymbol(const wxString &aSymbolName)
Set the selected symbol.
void KiwayMailIn(KIWAY_EXPRESS &mail) override
Receive KIWAY_EXPRESS messages from other players.
bool ReCreateLibList()
Create o recreates a sorted list of currently loaded libraries.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void ClickOnSymbolList(wxCommandEvent &event)
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box of document with option to not include some items.
void SetUnitAndBodyStyle(int aUnit, int aBodyStyle)
Set unit and convert, and set flag preventing them from automatically resetting to 1.
wxSearchCtrl * m_symbolFilter
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg) override
Return a pointer to the window settings for this frame.
void OnCharHook(wxKeyEvent &aEvent) override
Capture the key event before it is sent to the GUI.
LIB_SYMBOL * GetSelectedSymbol() const
void onSelectSymbolUnit(wxCommandEvent &aEvent)
void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
void onSelectPreviousSymbol(wxCommandEvent &aEvent)
void onUpdateBodyStyleChoice(wxUpdateUIEvent &aEvent)
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void onSelectSymbolBodyStyle(wxCommandEvent &aEvent)
bool m_selection_changed
Updated to true if a list rewrite on GUI activation resulted in the symbol selection changing,...
bool ReCreateSymbolList()
Create or recreate the list of symbols in the currently selected library.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
Store the common settings that are saved and loaded for each window / frame.