KiCad PCB EDA Suite
ee_inspection_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 EE_INSPECTION_TOOL_H
26
#define EE_INSPECTION_TOOL_H
27
28
#include <
tools/ee_tool_base.h
>
29
#include <
sch_base_frame.h
>
30
31
32
class
EE_SELECTION_TOOL
;
33
class
SCH_BASE_FRAME
;
34
class
DIALOG_ERC
;
35
36
37
class
EE_INSPECTION_TOOL
:
public
EE_TOOL_BASE
<SCH_BASE_FRAME>
38
{
39
public
:
40
EE_INSPECTION_TOOL
();
41
~EE_INSPECTION_TOOL
() {}
42
44
bool
Init
()
override
;
45
46
void
Reset
(
RESET_REASON
aReason )
override
;
47
48
int
RunERC
(
const
TOOL_EVENT
& aEvent );
49
void
ShowERCDialog
();
50
void
DestroyERCDialog
();
51
52
int
PrevMarker
(
const
TOOL_EVENT
& aEvent );
53
int
NextMarker
(
const
TOOL_EVENT
& aEvent );
54
int
ExcludeMarker
(
const
TOOL_EVENT
& aEvent );
55
56
int
CheckSymbol
(
const
TOOL_EVENT
& aEvent );
57
58
int
RunSimulation
(
const
TOOL_EVENT
& aEvent );
59
60
int
ShowDatasheet
(
const
TOOL_EVENT
& aEvent );
61
62
int
UpdateMessagePanel
(
const
TOOL_EVENT
& aEvent );
63
64
private
:
66
void
setTransitions
()
override
;
67
68
private
:
69
DIALOG_ERC
*
m_ercDialog
;
70
};
71
72
#endif
/* EE_INSPECTION_TOOL_H */
EE_INSPECTION_TOOL::m_ercDialog
DIALOG_ERC * m_ercDialog
Definition:
ee_inspection_tool.h:69
EE_INSPECTION_TOOL::RunSimulation
int RunSimulation(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:469
EE_INSPECTION_TOOL::setTransitions
void setTransitions() override
<
Definition:
ee_inspection_tool.cpp:562
EE_INSPECTION_TOOL::~EE_INSPECTION_TOOL
~EE_INSPECTION_TOOL()
Definition:
ee_inspection_tool.h:41
EE_INSPECTION_TOOL::EE_INSPECTION_TOOL
EE_INSPECTION_TOOL()
Definition:
ee_inspection_tool.cpp:62
EE_INSPECTION_TOOL::UpdateMessagePanel
int UpdateMessagePanel(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:537
EE_INSPECTION_TOOL
Definition:
ee_inspection_tool.h:37
sch_base_frame.h
TOOL_EVENT
Generic, UI-independent tool event.
Definition:
tool_event.h:152
EE_INSPECTION_TOOL::DestroyERCDialog
void DestroyERCDialog()
Definition:
ee_inspection_tool.cpp:126
EE_INSPECTION_TOOL::ExcludeMarker
int ExcludeMarker(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:169
EE_INSPECTION_TOOL::ShowERCDialog
void ShowERCDialog()
Definition:
ee_inspection_tool.cpp:104
EE_INSPECTION_TOOL::Reset
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
Definition:
ee_inspection_tool.cpp:86
EE_SELECTION_TOOL
Definition:
ee_selection_tool.h:56
EE_INSPECTION_TOOL::RunERC
int RunERC(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:97
ee_tool_base.h
DIALOG_ERC
Definition:
dialog_erc.h:43
TOOL_BASE::RESET_REASON
RESET_REASON
Determine the reason of reset for a tool.
Definition:
tool_base.h:77
EE_TOOL_BASE
A foundation class for a tool operating on a schematic or symbol.
Definition:
ee_tool_base.h:49
EE_INSPECTION_TOOL::NextMarker
int NextMarker(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:152
EE_INSPECTION_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition:
ee_inspection_tool.cpp:69
EE_INSPECTION_TOOL::ShowDatasheet
int ShowDatasheet(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:489
EE_INSPECTION_TOOL::PrevMarker
int PrevMarker(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:135
SCH_BASE_FRAME
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Definition:
sch_base_frame.h:88
EE_INSPECTION_TOOL::CheckSymbol
int CheckSymbol(const TOOL_EVENT &aEvent)
Definition:
ee_inspection_tool.cpp:215
eeschema
tools
ee_inspection_tool.h
Generated on Thu May 26 2022 04:07:31 for KiCad PCB EDA Suite by
1.8.15