KiCad PCB EDA Suite
sch_navigate_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 
26 #ifndef SCH_NAVIGATE_TOOL_H
27 #define SCH_NAVIGATE_TOOL_H
28 
29 #include <sch_base_frame.h>
30 #include <tools/ee_tool_base.h>
31 #include <status_popup.h>
32 
33 class SCH_EDIT_FRAME;
34 
38 class SCH_NAVIGATE_TOOL : public wxEvtHandler, public EE_TOOL_BASE<SCH_EDIT_FRAME>
39 {
40 public:
42  EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.NavigateTool" )
43  { }
44 
46 
47  int EnterSheet( const TOOL_EVENT& aEvent );
48  int LeaveSheet( const TOOL_EVENT& aEvent );
49  int NavigateHierarchy( const TOOL_EVENT& aEvent );
50  int HypertextCommand( const TOOL_EVENT& aEvent );
51 
52 private:
54  void setTransitions() override;
55 
56 private:
57  std::stack<wxString> m_hypertextStack;
58 };
59 
60 
61 #endif // SCH_NAVIGATE_TOOL_H
int LeaveSheet(const TOOL_EVENT &aEvent)
Handle actions specific to the schematic editor.
Schematic editor (Eeschema) main window.
int EnterSheet(const TOOL_EVENT &aEvent)
std::stack< wxString > m_hypertextStack
Generic, UI-independent tool event.
Definition: tool_event.h:152
void setTransitions() override
< Set up handlers for various events.
int HypertextCommand(const TOOL_EVENT &aEvent)
int NavigateHierarchy(const TOOL_EVENT &aEvent)
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:49