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;
41
46{
47public:
48 PCB_BASE_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
49 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
50 long aStyle, const wxString& aFrameName );
51
52 virtual ~PCB_BASE_EDIT_FRAME();
53
54 bool TryBefore( wxEvent& aEvent ) override;
55
56 void doCloseWindow() override;
57
70 wxString CreateNewLibrary( const wxString& aDialogTitle, const wxString& aInitialPath = wxEmptyString );
71
72 wxString CreateNewProjectLibrary( const wxString& aDialogTitle, const wxString& aLibName );
73
84 wxString SelectLibrary( const wxString& aDialogTitle, const wxString& aListLabel,
85 const std::vector<std::pair<wxString, bool*>>& aExtraCheckboxes = {} );
86
93 bool AddLibrary( const wxString& aDialogTitle, const wxString& aLibName = wxEmptyString,
94 FP_LIB_TABLE* aTable = nullptr );
95
102 virtual void OnEditItemRequest( BOARD_ITEM* aItem ) {};
103
112 void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand ) override;
113
122 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aCommandType ) override;
123
127 void AppendCopyToUndoList( const PICKED_ITEMS_LIST& aItemsList,
128 UNDO_REDO aCommandType ) override;
129
135 void RestoreCopyFromRedoList( wxCommandEvent& aEvent );
136
142 void RestoreCopyFromUndoList( wxCommandEvent& aEvent );
143
148 void RollbackFromUndo();
149
158
162 bool UndoRedoBlocked() const
163 {
164 return m_undoRedoBlocked;
165 }
166
170 void UndoRedoBlock( bool aBlock = true )
171 {
172 m_undoRedoBlocked = aBlock;
173 }
174
180 void SetGridVisibility( bool aVisible ) override;
181
182 void SetObjectVisible( GAL_LAYER_ID aLayer, bool aVisible = true );
183
187 virtual EDA_ANGLE GetRotationAngle() const;
188
192 //void SetRotationAngle( EDA_ANGLE aRotationAngle );
193
195 void ShowTextPropertiesDialog( PCB_TEXT* aText );
198
200 void ActivateGalCanvas() override;
201
203 virtual void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr ) override;
204
205 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
206
207 /* full undo redo management : */
208
209 // use EDA_BASE_FRAME::ClearUndoRedoList()
210 // use EDA_BASE_FRAME::PushCommandToUndoList( PICKED_ITEMS_LIST* aItem )
211 // use EDA_BASE_FRAME::PushCommandToRedoList( PICKED_ITEMS_LIST* aItem )
212
224 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
225
227
234 wxString GetDesignRulesPath();
235
237
242
243 void ToggleProperties() override;
244
245 void GetContextualTextVars( BOARD_ITEM* aSourceItem, const wxString& aCrossRef,
246 wxArrayString* aTokens );
247
248protected:
249 void configureToolbars() override;
250
254 wxString createNewLibrary( const wxString& aDialogTitle, const wxString& aLibName,
255 const wxString& aInitialPath, FP_LIB_TABLE* aTable );
256
257 void handleActivateEvent( wxActivateEvent& aEvent ) override;
258
259 void saveCopyInUndoList( PICKED_ITEMS_LIST* commandToUndo, const PICKED_ITEMS_LIST& aItemsList,
260 UNDO_REDO aCommandType );
261
262 void unitsChangeRefresh() override;
263
264 virtual void onDarkModeToggle();
265
266protected:
268
271 std::unique_ptr<LAYER_PAIR_SETTINGS> m_layerPairSettings;
272
273 PCB_LAYER_BOX_SELECTOR* m_SelLayerBox; // a combo box to display and select active layer
274
275 wxAuiNotebook* m_tabbedPanel;
276
278};
279
280#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
Common, abstract interface for edit frames.
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.
Definition: undo_redo.cpp:630
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:
Definition: undo_redo.cpp:199
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)
Definition: undo_redo.cpp:103
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.
Definition: undo_redo.cpp:184
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.
Definition: undo_redo.cpp:164
void ClearListAndDeleteItems(PICKED_ITEMS_LIST *aList)
Definition: undo_redo.cpp:657
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.
Definition: undo_redo.cpp:670
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.
Definition: undo_redo.cpp:263
void RestoreCopyFromRedoList(wxCommandEvent &aEvent)
Redo the last edit:
Definition: undo_redo.cpp:231
wxString CreateNewProjectLibrary(const wxString &aDialogTitle, const wxString &aLibName)
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.
virtual void onDarkModeToggle()
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.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
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
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...