KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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
#pragma once
26
27
#include <
tools/ee_tool_base.h
>
28
29
30
class
SCH_PIN
;
31
class
SCH_SHAPE
;
32
class
SYMBOL_EDIT_FRAME
;
33
34
35
class
SYMBOL_EDITOR_EDIT_TOOL
:
public
EE_TOOL_BASE
<SYMBOL_EDIT_FRAME>
36
{
37
public
:
38
SYMBOL_EDITOR_EDIT_TOOL
();
39
~SYMBOL_EDITOR_EDIT_TOOL
()
override
{ }
40
42
bool
Init
()
override
;
43
44
int
Rotate
(
const
TOOL_EVENT
& aEvent );
45
int
Mirror
(
const
TOOL_EVENT
& aEvent );
46
int
Swap
(
const
TOOL_EVENT
& aEvent );
47
48
int
Duplicate
(
const
TOOL_EVENT
& aEvent );
49
50
int
Properties
(
const
TOOL_EVENT
& aEvent );
51
int
PinTable
(
const
TOOL_EVENT
& aEvent );
52
int
SetUnitDisplayName
(
const
TOOL_EVENT
& aEvent );
53
int
UpdateSymbolFields
(
const
TOOL_EVENT
& aEvent );
54
55
int
Undo
(
const
TOOL_EVENT
& aEvent );
56
int
Redo
(
const
TOOL_EVENT
& aEvent );
57
int
Cut
(
const
TOOL_EVENT
& aEvent );
58
int
Copy
(
const
TOOL_EVENT
& aEvent );
59
int
CopyAsText
(
const
TOOL_EVENT
& aEvent );
60
int
Paste
(
const
TOOL_EVENT
& aEvent );
61
62
int
Increment
(
const
TOOL_EVENT
& aEvent );
63
67
int
DoDelete
(
const
TOOL_EVENT
& aEvent );
68
70
int
InteractiveDelete
(
const
TOOL_EVENT
& aEvent );
71
72
private
:
73
void
editShapeProperties
(
SCH_SHAPE
* aShape );
74
void
editTextProperties
(
SCH_ITEM
* aItem );
75
void
editTextBoxProperties
(
SCH_ITEM
* aItem );
76
void
editFieldProperties
(
SCH_FIELD
* aField );
77
void
editSymbolProperties
();
78
void
handlePinDuplication
(
SCH_PIN
* aOldPin,
SCH_PIN
* aNewPin,
int
&aSymbolLastPinNumber );
79
81
void
setTransitions
()
override
;
82
83
EDA_ITEM
*
m_pickerItem
;
84
};
EDA_ITEM
A base class for most all the KiCad significant classes used in schematics and boards.
Definition:
eda_item.h:89
EE_TOOL_BASE
A foundation class for a tool operating on a schematic or symbol.
Definition:
ee_tool_base.h:48
SCH_FIELD
Definition:
sch_field.h:42
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition:
sch_item.h:167
SCH_PIN
Definition:
sch_pin.h:40
SCH_SHAPE
Definition:
sch_shape.h:33
SYMBOL_EDITOR_EDIT_TOOL
Definition:
symbol_editor_edit_tool.h:36
SYMBOL_EDITOR_EDIT_TOOL::Undo
int Undo(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:851
SYMBOL_EDITOR_EDIT_TOOL::setTransitions
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
Definition:
symbol_editor_edit_tool.cpp:1220
SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties
void editTextBoxProperties(SCH_ITEM *aItem)
Definition:
symbol_editor_edit_tool.cpp:666
SYMBOL_EDITOR_EDIT_TOOL::PinTable
int PinTable(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:763
SYMBOL_EDITOR_EDIT_TOOL::SYMBOL_EDITOR_EDIT_TOOL
SYMBOL_EDITOR_EDIT_TOOL()
Definition:
symbol_editor_edit_tool.cpp:54
SYMBOL_EDITOR_EDIT_TOOL::Increment
int Increment(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:1109
SYMBOL_EDITOR_EDIT_TOOL::Copy
int Copy(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:894
SYMBOL_EDITOR_EDIT_TOOL::CopyAsText
int CopyAsText(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:933
SYMBOL_EDITOR_EDIT_TOOL::Paste
int Paste(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:950
SYMBOL_EDITOR_EDIT_TOOL::~SYMBOL_EDITOR_EDIT_TOOL
~SYMBOL_EDITOR_EDIT_TOOL() override
Definition:
symbol_editor_edit_tool.h:39
SYMBOL_EDITOR_EDIT_TOOL::Cut
int Cut(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:883
SYMBOL_EDITOR_EDIT_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition:
symbol_editor_edit_tool.cpp:61
SYMBOL_EDITOR_EDIT_TOOL::m_pickerItem
EDA_ITEM * m_pickerItem
Definition:
symbol_editor_edit_tool.h:83
SYMBOL_EDITOR_EDIT_TOOL::Redo
int Redo(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:867
SYMBOL_EDITOR_EDIT_TOOL::editTextProperties
void editTextProperties(SCH_ITEM *aItem)
Definition:
symbol_editor_edit_tool.cpp:650
SYMBOL_EDITOR_EDIT_TOOL::Swap
int Swap(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:302
SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties
void editFieldProperties(SCH_FIELD *aField)
Definition:
symbol_editor_edit_tool.cpp:682
SYMBOL_EDITOR_EDIT_TOOL::handlePinDuplication
void handlePinDuplication(SCH_PIN *aOldPin, SCH_PIN *aNewPin, int &aSymbolLastPinNumber)
Set up handlers for various events.
Definition:
symbol_editor_edit_tool.cpp:751
SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties
void editShapeProperties(SCH_SHAPE *aShape)
Definition:
symbol_editor_edit_tool.cpp:629
SYMBOL_EDITOR_EDIT_TOOL::Duplicate
int Duplicate(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:1029
SYMBOL_EDITOR_EDIT_TOOL::Mirror
int Mirror(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:215
SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete
int InteractiveDelete(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:487
SYMBOL_EDITOR_EDIT_TOOL::Rotate
int Rotate(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:167
SYMBOL_EDITOR_EDIT_TOOL::Properties
int Properties(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:562
SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName
int SetUnitDisplayName(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:810
SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties
void editSymbolProperties()
Definition:
symbol_editor_edit_tool.cpp:716
SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields
int UpdateSymbolFields(const TOOL_EVENT &aEvent)
Definition:
symbol_editor_edit_tool.cpp:787
SYMBOL_EDITOR_EDIT_TOOL::DoDelete
int DoDelete(const TOOL_EVENT &aEvent)
Delete the selected items, or the item under the cursor.
Definition:
symbol_editor_edit_tool.cpp:384
SYMBOL_EDIT_FRAME
The symbol library editor main window.
Definition:
symbol_edit_frame.h:51
TOOL_EVENT
Generic, UI-independent tool event.
Definition:
tool_event.h:168
ee_tool_base.h
src
eeschema
tools
symbol_editor_edit_tool.h
Generated on Thu Mar 13 2025 00:05:09 for KiCad PCB EDA Suite by
1.9.6