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, see <https://www.gnu.org/licenses/>.
19
*/
20
21
#pragma once
22
23
#include <
tools/sch_tool_base.h
>
24
25
26
class
SCH_PIN
;
27
class
SCH_SHAPE
;
28
class
SYMBOL_EDIT_FRAME
;
29
30
31
class
SYMBOL_EDITOR_EDIT_TOOL
:
public
SCH_TOOL_BASE
<SYMBOL_EDIT_FRAME>
32
{
33
public
:
34
SYMBOL_EDITOR_EDIT_TOOL
();
35
~SYMBOL_EDITOR_EDIT_TOOL
() =
default
;
36
37
static
const
std::vector<KICAD_T>
SwappableItems
;
38
40
bool
Init
()
override
;
41
42
int
Rotate
(
const
TOOL_EVENT
& aEvent );
43
int
Mirror
(
const
TOOL_EVENT
& aEvent );
44
int
Swap
(
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
ConvertStackedPins
(
const
TOOL_EVENT
& aEvent );
51
int
ExplodeStackedPin
(
const
TOOL_EVENT
& aEvent );
52
int
UpdateSymbolFields
(
const
TOOL_EVENT
& aEvent );
53
54
int
Undo
(
const
TOOL_EVENT
& aEvent );
55
int
Redo
(
const
TOOL_EVENT
& aEvent );
56
int
Cut
(
const
TOOL_EVENT
& aEvent );
57
int
Copy
(
const
TOOL_EVENT
& aEvent );
58
int
CopyAsText
(
const
TOOL_EVENT
& aEvent );
59
int
Paste
(
const
TOOL_EVENT
& aEvent );
60
64
int
DoDelete
(
const
TOOL_EVENT
& aEvent );
65
66
private
:
67
void
editShapeProperties
(
SCH_SHAPE
* aShape );
68
void
editTextProperties
(
SCH_ITEM
* aItem );
69
void
editTextBoxProperties
(
SCH_ITEM
* aItem );
70
void
editFieldProperties
(
SCH_FIELD
* aField );
71
void
editSymbolProperties
();
72
void
editSymbolPropertiesFromLibrary
(
const
LIB_ID
& aLibId );
73
75
void
setTransitions
()
override
;
76
};
LIB_ID
A logical library item identifier and consists of various portions much like a URI.
Definition
lib_id.h:45
SCH_FIELD
Definition
sch_field.h:45
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition
sch_item.h:162
SCH_PIN
Definition
sch_pin.h:41
SCH_SHAPE
Definition
sch_shape.h:30
SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >::SCH_TOOL_BASE
SCH_TOOL_BASE(const std::string &aName)
Definition
sch_tool_base.h:54
SYMBOL_EDITOR_EDIT_TOOL::Undo
int Undo(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1512
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:1838
SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties
void editTextBoxProperties(SCH_ITEM *aItem)
Definition
symbol_editor_edit_tool.cpp:982
SYMBOL_EDITOR_EDIT_TOOL::PinTable
int PinTable(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1114
SYMBOL_EDITOR_EDIT_TOOL::SYMBOL_EDITOR_EDIT_TOOL
SYMBOL_EDITOR_EDIT_TOOL()
Definition
symbol_editor_edit_tool.cpp:363
SYMBOL_EDITOR_EDIT_TOOL::Copy
int Copy(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1555
SYMBOL_EDITOR_EDIT_TOOL::CopyAsText
int CopyAsText(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1662
SYMBOL_EDITOR_EDIT_TOOL::Paste
int Paste(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1679
SYMBOL_EDITOR_EDIT_TOOL::Cut
int Cut(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1544
SYMBOL_EDITOR_EDIT_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition
symbol_editor_edit_tool.cpp:379
SYMBOL_EDITOR_EDIT_TOOL::Redo
int Redo(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1528
SYMBOL_EDITOR_EDIT_TOOL::editTextProperties
void editTextProperties(SCH_ITEM *aItem)
Definition
symbol_editor_edit_tool.cpp:966
SYMBOL_EDITOR_EDIT_TOOL::Swap
int Swap(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:681
SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties
void editFieldProperties(SCH_FIELD *aField)
Definition
symbol_editor_edit_tool.cpp:998
SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties
void editShapeProperties(SCH_SHAPE *aShape)
Definition
symbol_editor_edit_tool.cpp:945
SYMBOL_EDITOR_EDIT_TOOL::Duplicate
int Duplicate(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1758
SYMBOL_EDITOR_EDIT_TOOL::Mirror
int Mirror(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:606
SYMBOL_EDITOR_EDIT_TOOL::Rotate
int Rotate(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:558
SYMBOL_EDITOR_EDIT_TOOL::Properties
int Properties(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:863
SYMBOL_EDITOR_EDIT_TOOL::ExplodeStackedPin
int ExplodeStackedPin(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1402
SYMBOL_EDITOR_EDIT_TOOL::editSymbolPropertiesFromLibrary
void editSymbolPropertiesFromLibrary(const LIB_ID &aLibId)
Set up handlers for various events.
Definition
symbol_editor_edit_tool.cpp:1029
SYMBOL_EDITOR_EDIT_TOOL::~SYMBOL_EDITOR_EDIT_TOOL
~SYMBOL_EDITOR_EDIT_TOOL()=default
SYMBOL_EDITOR_EDIT_TOOL::ConvertStackedPins
int ConvertStackedPins(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1156
SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties
void editSymbolProperties()
Definition
symbol_editor_edit_tool.cpp:1077
SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields
int UpdateSymbolFields(const TOOL_EVENT &aEvent)
Definition
symbol_editor_edit_tool.cpp:1489
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:763
SYMBOL_EDITOR_EDIT_TOOL::SwappableItems
static const std::vector< KICAD_T > SwappableItems
Definition
symbol_editor_edit_tool.h:369
SYMBOL_EDIT_FRAME
The symbol library editor main window.
Definition
symbol_edit_frame.h:57
TOOL_EVENT
Generic, UI-independent tool event.
Definition
tool_event.h:167
sch_tool_base.h
src
eeschema
tools
symbol_editor_edit_tool.h
Generated on Fri Jun 26 2026 00:05:36 for KiCad PCB EDA Suite by
1.13.2