KiCad PCB EDA Suite
symbol_editor_edit_tool.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) 2019 CERN
5  * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef SYMBOL_EDITOR_EDIT_TOOL_H
26 #define SYMBOL_EDITOR_EDIT_TOOL_H
27 
28 #include <tools/ee_tool_base.h>
29 
30 
31 class SYMBOL_EDIT_FRAME;
32 
33 
34 class SYMBOL_EDITOR_EDIT_TOOL : public EE_TOOL_BASE<SYMBOL_EDIT_FRAME>
35 {
36 public:
38  ~SYMBOL_EDITOR_EDIT_TOOL() override { }
39 
41  bool Init() override;
42 
43  int Rotate( const TOOL_EVENT& aEvent );
44  int Mirror( const TOOL_EVENT& aEvent );
45 
46  int Duplicate( const TOOL_EVENT& aEvent );
47 
48  int Properties( const TOOL_EVENT& aEvent );
49  int PinTable( const TOOL_EVENT& aEvent );
50  int UpdateSymbolFields( const TOOL_EVENT& aEvent );
51 
52  int Undo( const TOOL_EVENT& aEvent );
53  int Redo( const TOOL_EVENT& aEvent );
54  int Cut( const TOOL_EVENT& aEvent );
55  int Copy( const TOOL_EVENT& aEvent );
56  int Paste( const TOOL_EVENT& aEvent );
57 
61  int DoDelete( const TOOL_EVENT& aEvent );
62 
64  int DeleteItemCursor( const TOOL_EVENT& aEvent );
65 
66 private:
67  void editGraphicProperties( LIB_ITEM* aItem );
68  void editTextProperties( LIB_ITEM* aItem );
69  void editFieldProperties( LIB_FIELD* aField );
70  void editSymbolProperties();
71 
73  void setTransitions() override;
74 
76 };
77 
78 #endif // SYMBOL_EDITOR_EDIT_TOOL_H
void editGraphicProperties(LIB_ITEM *aItem)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int UpdateSymbolFields(const TOOL_EVENT &aEvent)
void editSymbolProperties()
Set up handlers for various events.
int Copy(const TOOL_EVENT &aEvent)
void editFieldProperties(LIB_FIELD *aField)
Field object used in symbol libraries.
Definition: lib_field.h:59
The base class for drawable items used by schematic library components.
Definition: lib_item.h:62
int Redo(const TOOL_EVENT &aEvent)
int Properties(const TOOL_EVENT &aEvent)
Generic, UI-independent tool event.
Definition: tool_event.h:173
int DeleteItemCursor(const TOOL_EVENT &aEvent)
int Mirror(const TOOL_EVENT &aEvent)
int Duplicate(const TOOL_EVENT &aEvent)
int PinTable(const TOOL_EVENT &aEvent)
bool Init() override
Init() is called once upon a registration of the tool.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
int Rotate(const TOOL_EVENT &aEvent)
void editTextProperties(LIB_ITEM *aItem)
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
int Paste(const TOOL_EVENT &aEvent)
int Undo(const TOOL_EVENT &aEvent)
int Cut(const TOOL_EVENT &aEvent)
int DoDelete(const TOOL_EVENT &aEvent)
Delete the selected items, or the item under the cursor.
The symbol library editor main window.