KiCad PCB EDA Suite
symbol_editor_pin_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_PIN_TOOL_H
26 #define SYMBOL_EDITOR_PIN_TOOL_H
27 
28 #include <tools/ee_tool_base.h>
29 #include <sch_base_frame.h>
30 
31 
32 class SYMBOL_EDIT_FRAME;
33 
34 
35 class SYMBOL_EDITOR_PIN_TOOL : public EE_TOOL_BASE<SYMBOL_EDIT_FRAME>
36 {
37 public:
39  ~SYMBOL_EDITOR_PIN_TOOL() override { }
40 
42  bool Init() override;
43 
44  LIB_PIN* CreatePin( const VECTOR2I& aPosition, LIB_SYMBOL* aSymbol );
45  LIB_PIN* RepeatPin( const LIB_PIN* aSourcePin );
46 
47  bool PlacePin( LIB_PIN* aPin );
48  void CreateImagePins( LIB_PIN* aPin );
49 
50  bool EditPinProperties( LIB_PIN* aPin );
51  int PushPinProperties( const TOOL_EVENT& aEvent );
52 
53 private:
55  void setTransitions() override;
56 };
57 
58 #endif // SYMBOL_EDITOR_PIN_TOOL_H
LIB_PIN * RepeatPin(const LIB_PIN *aSourcePin)
int PushPinProperties(const TOOL_EVENT &aEvent)
Define a library symbol object.
Definition: lib_symbol.h:96
LIB_PIN * CreatePin(const VECTOR2I &aPosition, LIB_SYMBOL *aSymbol)
Generic, UI-independent tool event.
Definition: tool_event.h:152
void setTransitions() override
< Set up handlers for various events.
void CreateImagePins(LIB_PIN *aPin)
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:49
bool Init() override
Init() is called once upon a registration of the tool.
bool EditPinProperties(LIB_PIN *aPin)
The symbol library editor main window.