kicad/eeschema/hierarch.h

119 lines
3.5 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2022 Mike Williams <mike at mikebwilliams.com>
* Copyright (C) 2004-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 HIERARCH_H
#define HIERARCH_H
#include <wx/imaglist.h>
#include <wx/object.h> // wxRTTI macros
#include <wx/treectrl.h>
#include <widgets/wx_panel.h>
class SCH_EDIT_FRAME;
class SCH_SHEET_PATH;
class HIERARCHY_NAVIG_PANEL;
/**
* Navigation hierarchy tree control.
*
* wxTreeCtrl must be subclassed to implement the OnCompareItems method
* to sort according to page numbers.
*/
class HIERARCHY_TREE : public wxTreeCtrl
{
public:
HIERARCHY_TREE( HIERARCHY_NAVIG_PANEL* parent ) :
wxTreeCtrl( (wxWindow*) parent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
wxTR_HAS_BUTTONS, wxDefaultValidator, wxT( "HierachyTreeCtrl" ) )
{
}
int OnCompareItems( const wxTreeItemId& item1, const wxTreeItemId& item2 ) override;
private:
// Need to use wxRTTI macros in order for OnCompareItems to work properly
// See: https://docs.wxwidgets.org/3.1/classwx_tree_ctrl.html#ab90a465793c291ca7aa827a576b7d146
wxDECLARE_ABSTRACT_CLASS( HIERARCHY_TREE );
};
class HIERARCHY_NAVIG_PANEL : public WX_PANEL
{
public:
HIERARCHY_NAVIG_PANEL( SCH_EDIT_FRAME* aParent );
~HIERARCHY_NAVIG_PANEL();
/**
* Update the hierarchical tree of the schematic.
*/
void UpdateHierarchyTree();
/**
* Updates the tree's selection to match current page
*/
void UpdateHierarchySelection();
private:
/**
* Create the hierarchical tree of the schematic.
*
* @warning This routine is reentrant!
*
* @param[in] aList is the #SCH_SHEET_PATH list to explore.
* @param aPreviousmenu is the wxTreeItemId used as parent to add sub items.
*/
void buildHierarchyTree( SCH_SHEET_PATH* aList, const wxTreeItemId& aParent );
/**
* Open the selected sheet and display the corresponding screen when a tree item is
* selected.
*/
void onSelectSheetPath( wxTreeEvent& event );
/**
* @return String with page number in parenthesis
*/
wxString getRootString();
/**
* @return String with page number in parenthesis
*/
wxString formatPageString( const wxString& aName, const wxString& aPage );
SCH_SHEET_PATH m_list;
SCH_EDIT_FRAME* m_frame;
HIERARCHY_TREE* m_tree;
bool m_events_bound;
};
#endif // HIERARCH_H