#include <hierarchy_pane.h>

Inheritance diagram for HIERARCHY_PANE:

Public Types
enum	ContextMenuAction { EDIT_PAGE_NUMBER , EXPAND_ALL , COLLAPSE_ALL , RENAME , NEW_TOP_LEVEL_SHEET , DELETE_TOP_LEVEL_SHEET }

Public Member Functions
	HIERARCHY_PANE (SCH_EDIT_FRAME *aParent)

	~HIERARCHY_PANE ()

void	UpdateHierarchyTree (bool aClear=false)
	Update the hierarchical tree of the schematic.

void	UpdateHierarchySelection ()
	Updates the tree's selection to match current page.

void	UpdateLabelsHierarchyTree ()
	Update the labels of the hierarchical tree of the schematic.

std::vector< wxString >	GetCollapsedPaths () const
	Returns a list of sheet paths for nodes that are currently collapsed.

void	SetBorders (bool aLeft, bool aRight, bool aTop, bool aBottom)

void	SetBorderColor (const KIGFX::COLOR4D &aColor)

Private Member Functions
void	buildHierarchyTree (SCH_SHEET_PATH *aList, const wxTreeItemId &aParent)
	Create the hierarchical tree of the schematic.

void	onSelectSheetPath (wxTreeEvent &aEvent)
	Open the selected sheet and display the corresponding screen when a tree item is selected.

void	onTreeItemRightClick (wxTreeEvent &aEvent)

void	onRightClick (wxTreeItemId aItem)

void	onContextMenu (wxContextMenuEvent &aEvent)

void	onCharHook (wxKeyEvent &aKeyStroke)

void	onTreeRightClick (wxTreeEvent &event)

void	onTreeEditFinished (wxTreeEvent &event)

wxString	getRootString ()

wxString	formatPageString (const wxString &aName, const wxString &aPage)

void	setIdenticalSheetsHighlighted (const SCH_SHEET_PATH &path, bool highLighted=true)
	When renaming the sheets in tree it is helpful to highlight the identical sheets which got renamed by renaming the current sheet.

void	renameIdenticalSheets (const SCH_SHEET_PATH &renamedSheet, const wxString newName, SCH_COMMIT *commit)
	Rename all sheets in a hierarchial desing which has the same source renamed sheet.

void	OnPaint (wxPaintEvent &event)

Private Attributes
SCH_SHEET_PATH	m_list

SCH_EDIT_FRAME *	m_frame

HIERARCHY_TREE *	m_tree

bool	m_events_bound

std::set< wxString >	m_collapsedPaths

bool	m_leftBorder

bool	m_rightBorder

bool	m_topBorder

bool	m_bottomBorder

KIGFX::COLOR4D	m_borderColor

Detailed Description

Definition at line 71 of file hierarchy_pane.h.

Member Enumeration Documentation

◆ ContextMenuAction

enum HIERARCHY_PANE::ContextMenuAction

Enumerator
EDIT_PAGE_NUMBER
EXPAND_ALL
COLLAPSE_ALL
RENAME
NEW_TOP_LEVEL_SHEET
DELETE_TOP_LEVEL_SHEET

Definition at line 74 of file hierarchy_pane.h.

Constructor & Destructor Documentation

◆ HIERARCHY_PANE()

HIERARCHY_PANE::HIERARCHY_PANE ( SCH_EDIT_FRAME * aParent )

Definition at line 66 of file hierarchy_pane.cpp.

References KiBitmap(), KiBitmapBundle(), m_collapsedPaths, m_events_bound, m_frame, PROJECT_LOCAL_SETTINGS::m_SchHierarchyCollapsed, m_tree, onCharHook(), onContextMenu(), onSelectSheetPath(), onTreeEditFinished(), onTreeItemRightClick(), path, tree_nosel, tree_sel, UpdateHierarchyTree(), and WX_PANEL::WX_PANEL().

◆ ~HIERARCHY_PANE()

HIERARCHY_PANE::~HIERARCHY_PANE ( )

Definition at line 118 of file hierarchy_pane.cpp.

References m_tree, onCharHook(), onContextMenu(), onSelectSheetPath(), onTreeEditFinished(), and onTreeItemRightClick().

Member Function Documentation

◆ buildHierarchyTree()

void HIERARCHY_PANE::buildHierarchyTree	(	SCH_SHEET_PATH *	aList,
		const wxTreeItemId &	aParent )

private

Create the hierarchical tree of the schematic.

Warning: This routine is reentrant!

Parameters

[in]	aList	is the SCH_SHEET_PATH list to explore.
	aPreviousmenu	is the wxTreeItemId used as parent to add sub items.

Definition at line 129 of file hierarchy_pane.cpp.

References buildHierarchyTree(), formatPageString(), SCH_SHEET::GetField(), SCH_SHEET::GetFileName(), SCH_SHEET_PATH::GetPageNumber(), SCH_SCREEN::GetSheets(), SCH_FIELD::GetShownText(), SCH_SHEET_PATH::LastScreen(), m_tree, SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), and SHEET_NAME.

Referenced by buildHierarchyTree(), and UpdateHierarchyTree().

◆ formatPageString()

wxString HIERARCHY_PANE::formatPageString	(	const wxString &	aName,
		const wxString &	aPage )

private

Returns: String with page number in parenthesis

Definition at line 804 of file hierarchy_pane.cpp.

References _.

Referenced by buildHierarchyTree(), onTreeEditFinished(), renameIdenticalSheets(), UpdateHierarchyTree(), and UpdateLabelsHierarchyTree().

◆ GetCollapsedPaths()

std::vector< wxString > HIERARCHY_PANE::GetCollapsedPaths ( ) const

Returns a list of sheet paths for nodes that are currently collapsed.

Definition at line 443 of file hierarchy_pane.cpp.

References TREE_ITEM_DATA::m_SheetPath, m_tree, and SCH_SHEET_PATH::PathAsString().

◆ getRootString()

wxString HIERARCHY_PANE::getRootString ( )

private

Returns: String with page number in parenthesis

Definition at line 788 of file hierarchy_pane.cpp.

References _, and m_frame.

Referenced by UpdateHierarchyTree().

◆ onCharHook()

void HIERARCHY_PANE::onCharHook ( wxKeyEvent & aKeyStroke )

private

Definition at line 735 of file hierarchy_pane.cpp.

References ACTIONS::collapseAll, ACTIONS::expandAll, m_tree, MD_ALT, MD_ALTGR, MD_CTRL, MD_META, MD_SHIFT, and MD_SUPER.

Referenced by HIERARCHY_PANE(), and ~HIERARCHY_PANE().

◆ onContextMenu()

void HIERARCHY_PANE::onContextMenu ( wxContextMenuEvent & aEvent )

private

Definition at line 485 of file hierarchy_pane.cpp.

References onRightClick().

Referenced by HIERARCHY_PANE(), UpdateHierarchySelection(), UpdateHierarchyTree(), and ~HIERARCHY_PANE().

◆ OnPaint()

void WX_PANEL::OnPaint ( wxPaintEvent & event )

privateinherited

Definition at line 47 of file wx_panel.cpp.

References m_borderColor, m_bottomBorder, m_leftBorder, m_rightBorder, m_topBorder, KIGFX::COLOR4D::Mix(), KIGFX::COLOR4D::ToColour(), and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by WX_PANEL(), and ~WX_PANEL().

◆ onRightClick()

void HIERARCHY_PANE::onRightClick ( wxTreeItemId aItem )

private

◆ onSelectSheetPath()

void HIERARCHY_PANE::onSelectSheetPath ( wxTreeEvent & aEvent )

private

Open the selected sheet and display the corresponding screen when a tree item is selected.

Definition at line 380 of file hierarchy_pane.cpp.

References SCH_ACTIONS::changeSheet, m_frame, TREE_ITEM_DATA::m_SheetPath, and m_tree.

Referenced by HIERARCHY_PANE(), UpdateHierarchySelection(), UpdateHierarchyTree(), and ~HIERARCHY_PANE().

◆ onTreeEditFinished()

void HIERARCHY_PANE::onTreeEditFinished ( wxTreeEvent & event )

private

Definition at line 676 of file hierarchy_pane.cpp.

References _, COMMIT::Empty(), formatPageString(), SCH_SHEET::GetField(), SCH_SHEET::GetName(), SCH_SHEET_PATH::GetPageNumber(), SCH_SHEET::GetScreen(), SCH_SHEET_PATH::GetSheet(), SCH_SHEET_PATH::Last(), m_frame, TREE_ITEM_DATA::m_SheetPath, m_tree, COMMIT::Modify(), SCH_COMMIT::Push(), renameIdenticalSheets(), setIdenticalSheetsHighlighted(), SCH_SHEET::SetName(), SHEET_NAME, and SCH_SHEET_PATH::size().

Referenced by HIERARCHY_PANE(), and ~HIERARCHY_PANE().

◆ onTreeItemRightClick()

void HIERARCHY_PANE::onTreeItemRightClick ( wxTreeEvent & aEvent )

private

Definition at line 479 of file hierarchy_pane.cpp.

References onRightClick().

Referenced by HIERARCHY_PANE(), UpdateHierarchySelection(), UpdateHierarchyTree(), and ~HIERARCHY_PANE().

◆ onTreeRightClick()

void HIERARCHY_PANE::onTreeRightClick ( wxTreeEvent & event )

private

References path.

◆ renameIdenticalSheets()

void HIERARCHY_PANE::renameIdenticalSheets	(	const SCH_SHEET_PATH &	renamedSheet,
		const wxString	newName,
		SCH_COMMIT *	commit )

private

Rename all sheets in a hierarchial desing which has the same source renamed sheet.

Definition at line 838 of file hierarchy_pane.cpp.

References SCH_SHEET_PATH::Cmp(), formatPageString(), SCH_SHEET::GetField(), SCH_SHEET::GetName(), SCH_SHEET_PATH::GetPageNumber(), SCH_SHEET::GetScreen(), SCH_SHEET_PATH::GetSheet(), SCH_SHEET_PATH::Last(), m_frame, TREE_ITEM_DATA::m_SheetPath, m_tree, COMMIT::Modify(), recursiveDescent(), SCH_SHEET::SetName(), SHEET_NAME, and SCH_SHEET_PATH::size().

Referenced by onTreeEditFinished().

◆ SetBorderColor()

void WX_PANEL::SetBorderColor ( const KIGFX::COLOR4D & aColor )

inlineinherited

Definition at line 47 of file wx_panel.h.

References m_borderColor.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview().

◆ SetBorders()

void WX_PANEL::SetBorders	(	bool	aLeft,
		bool	aRight,
		bool	aTop,
		bool	aBottom )

inlineinherited

Definition at line 39 of file wx_panel.h.

References m_bottomBorder, m_leftBorder, m_rightBorder, and m_topBorder.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), APPEARANCE_CONTROLS_3D::APPEARANCE_CONTROLS_3D(), PAGED_DIALOG::PAGED_DIALOG(), PANEL_SCH_SELECTION_FILTER::PANEL_SCH_SELECTION_FILTER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview().

◆ setIdenticalSheetsHighlighted()

void HIERARCHY_PANE::setIdenticalSheetsHighlighted	(	const SCH_SHEET_PATH &	path,
		bool	highLighted = true )

private

When renaming the sheets in tree it is helpful to highlight the identical sheets which got renamed by renaming the current sheet.

Definition at line 809 of file hierarchy_pane.cpp.

References SCH_SHEET_PATH::Cmp(), SCH_SHEET_PATH::Last(), TREE_ITEM_DATA::m_SheetPath, m_tree, path, and recursiveDescent().

Referenced by onRightClick(), and onTreeEditFinished().

◆ UpdateHierarchySelection()

void HIERARCHY_PANE::UpdateHierarchySelection ( )

Updates the tree's selection to match current page.

Definition at line 160 of file hierarchy_pane.cpp.

References m_events_bound, m_frame, TREE_ITEM_DATA::m_SheetPath, m_tree, onContextMenu(), onSelectSheetPath(), onTreeItemRightClick(), and recursiveDescent().

Referenced by UpdateHierarchyTree().

◆ UpdateHierarchyTree()

void HIERARCHY_PANE::UpdateHierarchyTree ( bool aClear = false )

Update the hierarchical tree of the schematic.

Definition at line 246 of file hierarchy_pane.cpp.

References buildHierarchyTree(), formatPageString(), getRootString(), SCH_SHEET_LIST::HasPath(), m_collapsedPaths, m_events_bound, m_frame, m_list, TREE_ITEM_DATA::m_SheetPath, m_tree, onContextMenu(), onSelectSheetPath(), onTreeItemRightClick(), SCH_SHEET_PATH::Path(), SCH_SHEET_PATH::PathAsString(), and UpdateHierarchySelection().

Referenced by HIERARCHY_PANE(), and onRightClick().

◆ UpdateLabelsHierarchyTree()

void HIERARCHY_PANE::UpdateLabelsHierarchyTree ( )

Update the labels of the hierarchical tree of the schematic.

Must be called only for an up to date tree, to update displayed labels after a sheet name or a sheet number change.

Definition at line 398 of file hierarchy_pane.cpp.

References formatPageString(), SCH_SHEET::GetField(), SCH_SHEET_PATH::GetPageNumber(), SCH_FIELD::GetShownText(), SCH_SHEET_PATH::Last(), TREE_ITEM_DATA::m_SheetPath, m_tree, recursiveDescent(), and SHEET_NAME.

Referenced by onRightClick().

Member Data Documentation

◆ m_borderColor

KIGFX::COLOR4D WX_PANEL::m_borderColor

privateinherited

Definition at line 61 of file wx_panel.h.

Referenced by OnPaint(), SetBorderColor(), and WX_PANEL().

◆ m_bottomBorder

bool WX_PANEL::m_bottomBorder

privateinherited

Definition at line 59 of file wx_panel.h.

Referenced by OnPaint(), SetBorders(), and WX_PANEL().

◆ m_collapsedPaths

std::set<wxString> HIERARCHY_PANE::m_collapsedPaths

private

Definition at line 162 of file hierarchy_pane.h.

Referenced by HIERARCHY_PANE(), and UpdateHierarchyTree().

◆ m_events_bound

bool HIERARCHY_PANE::m_events_bound

private

Definition at line 161 of file hierarchy_pane.h.

Referenced by HIERARCHY_PANE(), UpdateHierarchySelection(), and UpdateHierarchyTree().

◆ m_frame

SCH_EDIT_FRAME* HIERARCHY_PANE::m_frame

private

Definition at line 158 of file hierarchy_pane.h.

Referenced by getRootString(), HIERARCHY_PANE(), onRightClick(), onSelectSheetPath(), onTreeEditFinished(), renameIdenticalSheets(), UpdateHierarchySelection(), and UpdateHierarchyTree().

◆ m_leftBorder

bool WX_PANEL::m_leftBorder

privateinherited

Definition at line 56 of file wx_panel.h.

Referenced by OnPaint(), SetBorders(), and WX_PANEL().

◆ m_list

SCH_SHEET_PATH HIERARCHY_PANE::m_list

private

Definition at line 157 of file hierarchy_pane.h.

Referenced by UpdateHierarchyTree().

◆ m_rightBorder

bool WX_PANEL::m_rightBorder

privateinherited

Definition at line 57 of file wx_panel.h.

Referenced by OnPaint(), SetBorders(), and WX_PANEL().

◆ m_topBorder

bool WX_PANEL::m_topBorder

privateinherited

Definition at line 58 of file wx_panel.h.

Referenced by OnPaint(), SetBorders(), and WX_PANEL().

◆ m_tree

HIERARCHY_TREE* HIERARCHY_PANE::m_tree

private

Definition at line 159 of file hierarchy_pane.h.

Referenced by buildHierarchyTree(), GetCollapsedPaths(), HIERARCHY_PANE(), onCharHook(), onRightClick(), onSelectSheetPath(), onTreeEditFinished(), renameIdenticalSheets(), setIdenticalSheetsHighlighted(), UpdateHierarchySelection(), UpdateHierarchyTree(), UpdateLabelsHierarchyTree(), and ~HIERARCHY_PANE().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ContextMenuAction

Constructor & Destructor Documentation

◆ HIERARCHY_PANE()

◆ ~HIERARCHY_PANE()

Member Function Documentation

◆ buildHierarchyTree()

◆ formatPageString()

◆ GetCollapsedPaths()

◆ getRootString()

◆ onCharHook()

◆ onContextMenu()

◆ OnPaint()

◆ onRightClick()

◆ onSelectSheetPath()

◆ onTreeEditFinished()

◆ onTreeItemRightClick()

◆ onTreeRightClick()

◆ renameIdenticalSheets()

◆ SetBorderColor()

◆ SetBorders()

◆ setIdenticalSheetsHighlighted()

◆ UpdateHierarchySelection()

◆ UpdateHierarchyTree()

◆ UpdateLabelsHierarchyTree()

Member Data Documentation

◆ m_borderColor

◆ m_bottomBorder

◆ m_collapsedPaths

◆ m_events_bound

◆ m_frame

◆ m_leftBorder

◆ m_list

◆ m_rightBorder

◆ m_topBorder

◆ m_tree