KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_diff_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) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 3
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * https://www.gnu.org/licenses/gpl-3.0.html
19 * or you may write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
21 */
22
23#ifndef __SYMBOL_DIFF_FRAME_H_
24#define __SYMBOL_DIFF_FRAME_H_
25
26#include <sch_base_frame.h>
27
32{
33public:
34
41 SYMBOL_DIFF_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
42 const wxString& aLibraryName = wxEmptyString );
43
45
52 bool ShowModal( wxString* aSymbol, wxWindow* aParent ) override;
53
58
59 void OnSize( wxSizeEvent& event ) override;
60
61 void doCloseWindow() override;
62 void ReCreateHToolbar() override;
63 void ReCreateVToolbar() override;
64 void ReCreateOptToolbar() override {}
65
66 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
67 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
68
70
71 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
72
73 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
74
76
77 void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
78
79protected:
80 void setupUIConditions() override;
81
82 void doReCreateMenuBar() override;
83
84private:
85 // Set up the tool framework.
86 void setupTools();
87
92 void OnActivate( wxActivateEvent& event );
93
94
95 DECLARE_EVENT_TABLE()
96};
97#endif
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition: kiway_express.h:40
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:284
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Symbol library viewer main window.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg) override
Return a pointer to the window settings for this frame.
void ReCreateOptToolbar() override
void FinishModal()
Send the selected symbol back to the caller.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void doCloseWindow() override
void doReCreateMenuBar() override
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Returns bbox of document with option to not include some items.
void ReCreateVToolbar() override
bool ShowModal(wxString *aSymbol, wxWindow *aParent) override
Runs the symbol viewer as a modal dialog.
void OnActivate(wxActivateEvent &event)
Called when the frame is activated to reload the libraries and symbol lists that can be changed by th...
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
void ReCreateHToolbar() override
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void KiwayMailIn(KIWAY_EXPRESS &mail) override
Receive KIWAY_EXPRESS messages from other players.
void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
Stores the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:74