KiCad PCB EDA Suite
common_control.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-2020 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, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef COMMON_CONTROL_H
25 #define COMMON_CONTROL_H
26 
27 #include <tool/tool_interactive.h>
28 
29 class EDA_BASE_FRAME;
30 
36 {
37 public:
39  TOOL_INTERACTIVE( "common.SuiteControl" ),
40  m_frame( nullptr )
41  { }
42 
43  ~COMMON_CONTROL() override { }
44 
46  void Reset( RESET_REASON aReason ) override;
47 
48  int ConfigurePaths( const TOOL_EVENT& aEvent );
49  int ShowLibraryTable( const TOOL_EVENT& aEvent );
50 
51  int ShowPlayer( const TOOL_EVENT& aEvent );
52 
53  int ShowHelp( const TOOL_EVENT& aEvent );
54  int ListHotKeys( const TOOL_EVENT& aEvent );
55  int GetInvolved( const TOOL_EVENT& aEvent );
56  int ReportBug( const TOOL_EVENT& aEvent );
57 
59  void setTransitions() override;
60 
61 private:
64 
65  static wxString m_bugReportUrl;
66  static wxString m_bugReportTemplate;
67 };
68 
69 #endif
int ShowLibraryTable(const TOOL_EVENT &aEvent)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int ShowHelp(const TOOL_EVENT &aEvent)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int ReportBug(const TOOL_EVENT &aEvent)
Sets up handlers for various events.
EDA_BASE_FRAME * m_frame
< Pointer to the currently used edit frame.
~COMMON_CONTROL() override
static wxString m_bugReportTemplate
Issue template to use for reporting bugs (this should not be translated)
int ConfigurePaths(const TOOL_EVENT &aEvent)
int GetInvolved(const TOOL_EVENT &aEvent)
Generic, UI-independent tool event.
Definition: tool_event.h:173
int ListHotKeys(const TOOL_EVENT &aEvent)
Handle actions that are shared between different applications.
int ShowPlayer(const TOOL_EVENT &aEvent)
The base frame for deriving all KiCad main window classes.
static wxString m_bugReportUrl
URL to launch a new issue with pre-populated description.
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78