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-2022 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
33class SCH_BASE_FRAME;
34class DIALOG_ERC;
35
36
37class EE_INSPECTION_TOOL : public EE_TOOL_BASE<SCH_BASE_FRAME>
38{
39public:
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
56 int CrossProbe( const TOOL_EVENT& aEvent );
57
58 int ExcludeMarker( const TOOL_EVENT& aEvent );
59
60 int CheckSymbol( const TOOL_EVENT& aEvent );
61
62 int RunSimulation( const TOOL_EVENT& aEvent );
63
64 int ShowDatasheet( const TOOL_EVENT& aEvent );
65
67 int UpdateMessagePanel( const TOOL_EVENT& aEvent );
68
69private:
71 void setTransitions() override;
72
73private:
75};
76
77#endif /* EE_INSPECTION_TOOL_H */
int RunSimulation(const TOOL_EVENT &aEvent)
DIALOG_ERC * m_ercDialog
int NextMarker(const TOOL_EVENT &aEvent)
int PrevMarker(const TOOL_EVENT &aEvent)
int ShowDatasheet(const TOOL_EVENT &aEvent)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void setTransitions() override
<
int ExcludeMarker(const TOOL_EVENT &aEvent)
int UpdateMessagePanel(const TOOL_EVENT &aEvent)
Display the selected item info (when clicking on a item)
bool Init() override
Init() is called once upon a registration of the tool.
int RunERC(const TOOL_EVENT &aEvent)
int CheckSymbol(const TOOL_EVENT &aEvent)
int CrossProbe(const TOOL_EVENT &aEvent)
Called when clicking on a item:
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:50
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:156