KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_base_edit_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) 2014 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef BASE_EDIT_FRAME_H
28#define BASE_EDIT_FRAME_H
29
30#include <pcb_base_frame.h>
31
36class PCB_TEXTBOX;
37class PCB_TABLE;
38class PCB_TEXT;
39class PCB_SHAPE;
42
47{
48public:
49 PCB_BASE_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
50 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
51 long aStyle, const wxString& aFrameName );
52
53 virtual ~PCB_BASE_EDIT_FRAME();
54
55 bool TryBefore( wxEvent& aEvent ) override;
56
57 void doCloseWindow() override;
58
71 wxString CreateNewLibrary( const wxString& aDialogTitle, const wxString& aInitialPath = wxEmptyString );
72
73 wxString CreateNewProjectLibrary( const wxString& aDialogTitle, const wxString& aLibName );
74
85 wxString SelectLibrary( const wxString& aDialogTitle, const wxString& aListLabel,
86 const std::vector<std::pair<wxString, bool*>>& aExtraCheckboxes = {} );
87
94 bool AddLibrary( const wxString& aDialogTitle, const wxString& aLibName = wxEmptyString,
95 FP_LIB_TABLE* aTable = nullptr );
96
103 virtual void OnEditItemRequest( BOARD_ITEM* aItem ) {};
104
113 void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand ) override;
114
123 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aCommandType ) override;
124
128 void AppendCopyToUndoList( const PICKED_ITEMS_LIST& aItemsList,
129 UNDO_REDO aCommandType ) override;
130
136 void RestoreCopyFromRedoList( wxCommandEvent& aEvent );
137
143 void RestoreCopyFromUndoList( wxCommandEvent& aEvent );
144
149 void RollbackFromUndo();
150
159
163 bool UndoRedoBlocked() const
164 {
165 return m_undoRedoBlocked;
166 }
167
171 void UndoRedoBlock( bool aBlock = true )
172 {
173 m_undoRedoBlocked = aBlock;
174 }
175
181 void SetGridVisibility( bool aVisible ) override;
182
183 void SetObjectVisible( GAL_LAYER_ID aLayer, bool aVisible = true );
184
188 virtual EDA_ANGLE GetRotationAngle() const;
189
193 //void SetRotationAngle( EDA_ANGLE aRotationAngle );
194
196 void ShowTextPropertiesDialog( PCB_TEXT* aText );
199
201 void ActivateGalCanvas() override;
202
204 virtual void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr ) override;
205
206 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
207
208 /* full undo redo management : */
209
210 // use EDA_BASE_FRAME::ClearUndoRedoList()
211 // use EDA_BASE_FRAME::PushCommandToUndoList( PICKED_ITEMS_LIST* aItem )
212 // use EDA_BASE_FRAME::PushCommandToRedoList( PICKED_ITEMS_LIST* aItem )
213
225 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
226
228
235 wxString GetDesignRulesPath();
236
238
243
244 void ToggleProperties() override;
245
246 void GetContextualTextVars( BOARD_ITEM* aSourceItem, const wxString& aCrossRef,
247 wxArrayString* aTokens );
248
250
251protected:
252 void configureToolbars() override;
253
257 wxString createNewLibrary( const wxString& aDialogTitle, const wxString& aLibName,
258 const wxString& aInitialPath, FP_LIB_TABLE* aTable );
259
260 void handleActivateEvent( wxActivateEvent& aEvent ) override;
261
262 void saveCopyInUndoList( PICKED_ITEMS_LIST* commandToUndo, const PICKED_ITEMS_LIST& aItemsList,
263 UNDO_REDO aCommandType );
264
265 void unitsChangeRefresh() override;
266
267 virtual void onDarkModeToggle();
268
269protected:
271
274 std::unique_ptr<LAYER_PAIR_SETTINGS> m_layerPairSettings;
275
276 PCB_LAYER_BOX_SELECTOR* m_SelLayerBox; // a combo box to display and select active layer
277
278 wxAuiNotebook* m_tabbedPanel;
279
281};
282
283#endif
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
Color settings are a bit different than most of the settings objects in that there can be more than o...
UNDO_REDO_LIST
Specify whether we are interacting with the undo or redo stacks.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
Management class for layer pairs in a PCB.
Definition layer_pairs.h:47
LAYER_PAIR_SETTINGS * GetLayerPairSettings()
Acess to the layer pair settings controller of the board, if available.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Free the undo or redo list from List element.
wxString CreateNewLibrary(const wxString &aDialogTitle, const wxString &aInitialPath=wxEmptyString)
If a library name is given, creates a new footprint library in the project folder with the given name...
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
void RestoreCopyFromUndoList(wxCommandEvent &aEvent)
Undo the last edit:
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
void saveCopyInUndoList(PICKED_ITEMS_LIST *commandToUndo, const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType)
void AppendCopyToUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.
bool m_darkMode
Panel with Layers and Object Inspector tabs.
virtual void OnEditItemRequest(BOARD_ITEM *aItem)
Install the corresponding dialog editor for the given item.
void doCloseWindow() override
void SaveCopyInUndoList(EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand) override
Create a new entry in undo list of commands.
void ClearListAndDeleteItems(PICKED_ITEMS_LIST *aList)
void SetGridVisibility(bool aVisible) override
Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget.
virtual EDA_ANGLE GetRotationAngle() const
Return the angle used for rotate operations.
int ShowTextBoxPropertiesDialog(PCB_TEXTBOX *aTextBox)
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void RollbackFromUndo()
Perform an undo of the last edit without logging a corresponding redo.
bool TryBefore(wxEvent &aEvent) override
wxString SelectLibrary(const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
Put up a dialog and allows the user to pick a library, for unspecified use.
bool UndoRedoBlocked() const
Check if the undo and redo operations are currently blocked.
bool AddLibrary(const wxString &aDialogTitle, const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
Add an existing library to either the global or project library table.
PCB_LAYER_BOX_SELECTOR * m_SelLayerBox
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
std::unique_ptr< LAYER_PAIR_SETTINGS > m_layerPairSettings
void ToggleProperties() override
APPEARANCE_CONTROLS * GetAppearancePanel()
void configureToolbars() override
void PutDataInPreviousState(PICKED_ITEMS_LIST *aList)
Used in undo or redo command.
void RestoreCopyFromRedoList(wxCommandEvent &aEvent)
Redo the last edit:
PCB_BASE_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
wxString CreateNewProjectLibrary(const wxString &aDialogTitle, const wxString &aLibName)
void HighlightSelectionFilter(const PCB_SELECTION_FILTER_OPTIONS &aOptions)
APPEARANCE_CONTROLS * m_appearancePanel
wxAuiNotebook * m_tabbedPanel
void SetObjectVisible(GAL_LAYER_ID aLayer, bool aVisible=true)
void ShowReferenceImagePropertiesDialog(BOARD_ITEM *aBitmap)
Set the angle used for rotate operations.
PANEL_SELECTION_FILTER * m_selectionFilterPanel
void GetContextualTextVars(BOARD_ITEM *aSourceItem, const wxString &aCrossRef, wxArrayString *aTokens)
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
void UndoRedoBlock(bool aBlock=true)
Enable/disable undo and redo operations.
void ShowGraphicItemPropertiesDialog(PCB_SHAPE *aShape)
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
wxString createNewLibrary(const wxString &aDialogTitle, const wxString &aLibName, const wxString &aInitialPath, FP_LIB_TABLE *aTable)
Create a new library in the given table.
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
Class to display a pcb layer list in a wxBitmapComboBox.
A holder to handle information on schematic or board items.
A progress reporter interface for use in multi-threaded environments.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:33
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition layer_ids.h:228
This file contains data structures that are saved in the project file or project local settings file ...
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...