kicad/eeschema/tools/sch_navigate_tool.h

90 lines
3.0 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 CERN
* Copyright (C) 2019-2022 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef SCH_NAVIGATE_TOOL_H
#define SCH_NAVIGATE_TOOL_H
#include <sch_base_frame.h>
#include <tools/ee_tool_base.h>
#include <status_popup.h>
class SCH_EDIT_FRAME;
/**
* Handle actions specific to the schematic editor.
*/
class SCH_NAVIGATE_TOOL : public wxEvtHandler, public EE_TOOL_BASE<SCH_EDIT_FRAME>
{
public:
SCH_NAVIGATE_TOOL() : EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.NavigateTool" ) {}
~SCH_NAVIGATE_TOOL() { }
///< Reset navigation history. Must be done when schematic changes
void ResetHistory();
///< Remove deleted pages from history. Must be done when schematic
// hierarchy changes.
void CleanHistory();
///< Enter sheet provided in aEvent
int ChangeSheet( const TOOL_EVENT& aEvent );
///< Enter selected sheet
int EnterSheet( const TOOL_EVENT& aEvent );
///< Return to parent sheet. Synonymous with Up
int LeaveSheet( const TOOL_EVENT& aEvent );
///< Navigate up in sheet hierarchy
int Up( const TOOL_EVENT& aEvent );
///< Navigate forward in sheet history
int Forward( const TOOL_EVENT& aEvent );
///< Navigate back in sheet history
int Back( const TOOL_EVENT& aEvent );
///< Navigate to previous sheet by numeric sheet number
int Previous( const TOOL_EVENT& aEvent );
///< Navigate to next sheet by numeric sheet number
int Next( const TOOL_EVENT& aEvent );
int HypertextCommand( const TOOL_EVENT& aEvent );
bool CanGoBack();
bool CanGoForward();
bool CanGoUp();
bool CanGoPrevious();
bool CanGoNext();
private:
///< Set up handlers for various events.
void setTransitions() override;
///< Clear history after this nav index and pushes aPath to history
void pushToHistory( SCH_SHEET_PATH aPath );
///< Change current sheet to aPath and handle history, zooming, etc.
void changeSheet( SCH_SHEET_PATH aPath );
private:
std::list<SCH_SHEET_PATH> m_navHistory;
std::list<SCH_SHEET_PATH>::iterator m_navIndex;
};
#endif // SCH_NAVIGATE_TOOL_H