KiCad PCB EDA Suite
sch_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 KICAD_SCH_EDIT_TOOL_H
26#define KICAD_SCH_EDIT_TOOL_H
27
28#include <tools/ee_tool_base.h>
29#include <sch_base_frame.h>
30
31
32class SCH_EDIT_FRAME;
34
35
36class SCH_EDIT_TOOL : public EE_TOOL_BASE<SCH_EDIT_FRAME>
37{
38public:
40 ~SCH_EDIT_TOOL() override { }
41
43 bool Init() override;
44
45 int Rotate( const TOOL_EVENT& aEvent );
46 int Mirror( const TOOL_EVENT& aEvent );
47
48 int RepeatDrawItem( const TOOL_EVENT& aEvent );
49
50 int Properties( const TOOL_EVENT& aEvent );
51 int EditField( const TOOL_EVENT& aEvent );
52 int AutoplaceFields( const TOOL_EVENT& aEvent );
53 int ChangeSymbols( const TOOL_EVENT& aEvent );
54 int ConvertDeMorgan( const TOOL_EVENT& aEvent );
55 int EditPageNumber( const TOOL_EVENT& aEvent );
56
67 int ChangeTextType( const TOOL_EVENT& aEvent );
68
69 int BreakWire( const TOOL_EVENT& aEvent );
70
71 int CleanupSheetPins( const TOOL_EVENT& aEvent );
72 int GlobalEdit( const TOOL_EVENT& aEvent );
73
75 int DoDelete( const TOOL_EVENT& aEvent );
76
78 int DeleteItemCursor( const TOOL_EVENT& aEvent );
79
80private:
81 void editFieldText( SCH_FIELD* aField );
82
84 void setTransitions() override;
85
86private:
88};
89
90#endif //KICAD_SCH_EDIT_TOOL_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:50
Schematic editor (Eeschema) main window.
int DeleteItemCursor(const TOOL_EVENT &aEvent)
~SCH_EDIT_TOOL() override
Definition: sch_edit_tool.h:40
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
EDA_ITEM * m_pickerItem
Definition: sch_edit_tool.h:87
int EditField(const TOOL_EVENT &aEvent)
int EditPageNumber(const TOOL_EVENT &aEvent)
int DoDelete(const TOOL_EVENT &aEvent)
Run the deletion tool.
bool Init() override
Init() is called once upon a registration of the tool.
int CleanupSheetPins(const TOOL_EVENT &aEvent)
void editFieldText(SCH_FIELD *aField)
Set up handlers for various events.
int Mirror(const TOOL_EVENT &aEvent)
int GlobalEdit(const TOOL_EVENT &aEvent)
Delete the selected items, or the item under the cursor.
int Properties(const TOOL_EVENT &aEvent)
int Rotate(const TOOL_EVENT &aEvent)
int BreakWire(const TOOL_EVENT &aEvent)
int ConvertDeMorgan(const TOOL_EVENT &aEvent)
int AutoplaceFields(const TOOL_EVENT &aEvent)
int ChangeSymbols(const TOOL_EVENT &aEvent)
int ChangeTextType(const TOOL_EVENT &aEvent)
Change a text type to another one.
int RepeatDrawItem(const TOOL_EVENT &aEvent)
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
Generic, UI-independent tool event.
Definition: tool_event.h:155