KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_edit_table_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 The KiCad Developers, see AUTHORS.txt for contributors.
5
*
6
* This program is free software; you can redistribute it and/or
7
* modify it under the terms of the GNU General Public License
8
* as published by the Free Software Foundation; either version 2
9
* of the License, or (at your option) any later version.
10
*
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
15
*
16
* You should have received a copy of the GNU General Public License
17
* along with this program. If not, see <https://www.gnu.org/licenses/>.
18
*/
19
20
#ifndef SCH_EDIT_TABLE_TOOL_H
21
#define SCH_EDIT_TABLE_TOOL_H
22
23
#include <
tools/sch_tool_base.h
>
24
#include <
tool/edit_table_tool_base.h
>
25
#include <
sch_table.h
>
26
#include <
sch_tablecell.h
>
27
#include <
sch_commit.h
>
28
29
30
class
SCH_EDIT_FRAME
;
31
32
33
class
SCH_EDIT_TABLE_TOOL
:
public
SCH_TOOL_BASE
<SCH_EDIT_FRAME>,
34
public
EDIT_TABLE_TOOL_BASE
<SCH_TABLE, SCH_TABLECELL, SCH_COMMIT>
35
{
36
public
:
37
SCH_EDIT_TABLE_TOOL
();
38
~SCH_EDIT_TABLE_TOOL
()
override
{ }
39
41
bool
Init
()
override
;
42
43
int
AddRowAbove
(
const
TOOL_EVENT
& aEvent ) {
return
doAddRowAbove
( aEvent ); }
44
int
AddRowBelow
(
const
TOOL_EVENT
& aEvent ) {
return
doAddRowBelow
( aEvent ); }
45
int
AddColumnBefore
(
const
TOOL_EVENT
& aEvent ) {
return
doAddColumnBefore
( aEvent ); }
46
int
AddColumnAfter
(
const
TOOL_EVENT
& aEvent ) {
return
doAddColumnAfter
( aEvent ); }
47
int
DeleteRows
(
const
TOOL_EVENT
& aEvent ) {
return
doDeleteRows
( aEvent ); }
48
int
DeleteColumns
(
const
TOOL_EVENT
& aEvent ) {
return
doDeleteColumns
( aEvent ); }
49
50
int
MergeCells
(
const
TOOL_EVENT
& aEvent ) {
return
doMergeCells
( aEvent ); }
51
int
UnmergeCells
(
const
TOOL_EVENT
& aEvent ) {
return
doUnmergeCells
( aEvent ); }
52
53
int
EditTable
(
const
TOOL_EVENT
& aEvent );
54
int
ExportTableToCSV
(
const
TOOL_EVENT
& aEvent );
55
56
private
:
58
void
setTransitions
()
override
;
59
60
private
:
61
TOOL_MANAGER
*
getToolMgr
()
override
{
return
m_toolMgr
; }
62
BASE_SCREEN
*
getScreen
()
override
{
return
m_frame
->GetScreen(); }
63
64
const
SELECTION
&
getTableCellSelection
()
override
;
65
void
clearSelection
()
override
{
m_toolMgr
->RunAction(
ACTIONS::selectionClear
); };
66
67
SCH_TABLECELL
*
copyCell
(
SCH_TABLECELL
* aSource )
override
;
68
};
69
70
#endif
//SCH_EDIT_TABLE_TOOL_H
ACTIONS::selectionClear
static TOOL_ACTION selectionClear
Clear the current selection.
Definition
actions.h:220
BASE_SCREEN
Handles how to draw a screen (a board, a schematic ...)
Definition
base_screen.h:37
EDIT_TABLE_TOOL_BASE
SCH_TABLE_EDIT_TOOL and PCB_TABLE_EDIT_TOOL share most of their algorithms, which are implemented her...
Definition
edit_table_tool_base.h:39
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doDeleteColumns
int doDeleteColumns(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:400
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doAddColumnAfter
int doAddColumnAfter(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:265
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doAddRowBelow
int doAddRowBelow(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:162
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doAddColumnBefore
int doAddColumnBefore(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:214
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doAddRowAbove
int doAddRowAbove(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:113
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doMergeCells
int doMergeCells(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:478
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doDeleteRows
int doDeleteRows(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:316
EDIT_TABLE_TOOL_BASE< SCH_TABLE, SCH_TABLECELL, SCH_COMMIT >::doUnmergeCells
int doUnmergeCells(const TOOL_EVENT &aEvent)
Definition
edit_table_tool_base.h:547
SCH_EDIT_FRAME
Schematic editor (Eeschema) main window.
Definition
sch_edit_frame.h:131
SCH_EDIT_TABLE_TOOL::setTransitions
void setTransitions() override
< Set up handlers for various events.
Definition
sch_edit_table_tool.cpp:220
SCH_EDIT_TABLE_TOOL::SCH_EDIT_TABLE_TOOL
SCH_EDIT_TABLE_TOOL()
Definition
sch_edit_table_tool.cpp:29
SCH_EDIT_TABLE_TOOL::getScreen
BASE_SCREEN * getScreen() override
Definition
sch_edit_table_tool.h:62
SCH_EDIT_TABLE_TOOL::DeleteRows
int DeleteRows(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:47
SCH_EDIT_TABLE_TOOL::ExportTableToCSV
int ExportTableToCSV(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.cpp:84
SCH_EDIT_TABLE_TOOL::MergeCells
int MergeCells(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:50
SCH_EDIT_TABLE_TOOL::clearSelection
void clearSelection() override
Definition
sch_edit_table_tool.h:65
SCH_EDIT_TABLE_TOOL::UnmergeCells
int UnmergeCells(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:51
SCH_EDIT_TABLE_TOOL::getToolMgr
TOOL_MANAGER * getToolMgr() override
Definition
sch_edit_table_tool.h:61
SCH_EDIT_TABLE_TOOL::AddRowBelow
int AddRowBelow(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:44
SCH_EDIT_TABLE_TOOL::AddColumnBefore
int AddColumnBefore(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:45
SCH_EDIT_TABLE_TOOL::EditTable
int EditTable(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.cpp:45
SCH_EDIT_TABLE_TOOL::getTableCellSelection
const SELECTION & getTableCellSelection() override
Definition
sch_edit_table_tool.cpp:214
SCH_EDIT_TABLE_TOOL::~SCH_EDIT_TABLE_TOOL
~SCH_EDIT_TABLE_TOOL() override
Definition
sch_edit_table_tool.h:38
SCH_EDIT_TABLE_TOOL::DeleteColumns
int DeleteColumns(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:48
SCH_EDIT_TABLE_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition
sch_edit_table_tool.cpp:35
SCH_EDIT_TABLE_TOOL::AddColumnAfter
int AddColumnAfter(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:46
SCH_EDIT_TABLE_TOOL::AddRowAbove
int AddRowAbove(const TOOL_EVENT &aEvent)
Definition
sch_edit_table_tool.h:43
SCH_EDIT_TABLE_TOOL::copyCell
SCH_TABLECELL * copyCell(SCH_TABLECELL *aSource) override
Definition
sch_edit_table_tool.cpp:195
SCH_TABLECELL
Definition
sch_tablecell.h:28
SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame
SCH_EDIT_FRAME * m_frame
Definition
sch_tool_base.h:369
SCH_TOOL_BASE< SCH_EDIT_FRAME >::SCH_TOOL_BASE
SCH_TOOL_BASE(const std::string &aName)
Definition
sch_tool_base.h:54
SELECTION
Definition
selection.h:35
SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_toolMgr
TOOL_MANAGER * m_toolMgr
Definition
tool_base.h:220
TOOL_EVENT
Generic, UI-independent tool event.
Definition
tool_event.h:167
TOOL_INTERACTIVE::TOOL_MANAGER
friend class TOOL_MANAGER
Definition
tool_interactive.h:138
edit_table_tool_base.h
sch_commit.h
sch_table.h
sch_tablecell.h
sch_tool_base.h
src
eeschema
tools
sch_edit_table_tool.h
Generated on Fri Jun 26 2026 00:05:36 for KiCad PCB EDA Suite by
1.13.2