Widget displaying a tree of symbols with optional search text control and description panel.Custom event sent when a new symbol is preselected. More...

#include <lib_tree.h>

Inheritance diagram for LIB_TREE:

Classes
struct	STATE
	Structure storing state of the symbol tree widget. More...

Public Types
enum	FLAGS { NONE = 0x00 , SEARCH = 0x01 , DETAILS = 0x02 , ALL_WIDGETS = 0x0F , MULTISELECT = 0x10 }
	< Flags to select extra widgets and options More...

Public Member Functions
	LIB_TREE (wxWindow aParent, const wxString &aRecentSearchesKey, LIB_TABLE aLibTable, wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &aAdapter, int aFlags=ALL_WIDGETS, HTML_WINDOW *aDetails=nullptr)
	Construct a symbol tree. More...

	~LIB_TREE () override

LIB_ID	GetSelectedLibId (int *aUnit=nullptr) const
	For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit, 0 will be returned in aUnit. More...

int	GetSelectionCount () const

int	GetSelectedLibIds (std::vector< LIB_ID > &aSelection, std::vector< int > *aUnit=nullptr) const
	Retrieves a list of selections for trees that allow multi-selection. More...

LIB_TREE_NODE *	GetCurrentTreeNode () const

void	SelectLibId (const LIB_ID &aLibId)
	Select an item in the tree widget. More...

void	CenterLibId (const LIB_ID &aLibId)
	Ensure that an item is visible (preferably centered). More...

void	Unselect ()
	Unselect currently selected item in wxDataViewCtrl. More...

void	ExpandLibId (const LIB_ID &aLibId)
	Expand and item i the tree widget. More...

void	SetSearchString (const wxString &aSearchString)
	Save/restore search string. More...

wxString	GetSearchString () const

void	Regenerate (bool aKeepState)
	Regenerate the tree. More...

void	RefreshLibTree ()
	Refreshes the tree (mainly to update highlighting and asterisking) More...

wxWindow *	GetFocusTarget ()

void	FocusSearchFieldIfExists ()
	Focus the search widget if it exists. More...

Protected Member Functions
void	toggleExpand (const wxDataViewItem &aTreeId)
	Expand or collapse a node, switching it to the opposite state. More...

void	selectIfValid (const wxDataViewItem &aTreeId)
	If a wxDataViewitem is valid, select it and post a selection event. More...

void	centerIfValid (const wxDataViewItem &aTreeId)

void	expandIfValid (const wxDataViewItem &aTreeId)

void	postPreselectEvent ()
	Post a wxEVT_DATAVIEW_SELECTION_CHANGED to notify the selection handler that a new part has been preselected. More...

void	postSelectEvent ()
	Post SYMBOL_SELECTED event to notify the selection handler that a part has been selected. More...

STATE	getState () const
	Return the symbol tree widget state. More...

void	setState (const STATE &aState)
	Restore the symbol tree widget state from an object. More...

void	updateRecentSearchMenu ()

void	onQueryText (wxCommandEvent &aEvent)

void	onQueryCharHook (wxKeyEvent &aEvent)

void	onQueryMouseMoved (wxMouseEvent &aEvent)

void	onTreeSelect (wxDataViewEvent &aEvent)

void	onTreeActivate (wxDataViewEvent &aEvent)

void	onTreeCharHook (wxKeyEvent &aEvent)

void	onSize (wxSizeEvent &aEvent)

void	onDetailsLink (wxHtmlLinkEvent &aEvent)

void	onPreselect (wxCommandEvent &aEvent)

void	onItemContextMenu (wxDataViewEvent &aEvent)

void	onHeaderContextMenu (wxDataViewEvent &aEvent)

void	onDebounceTimer (wxTimerEvent &aEvent)

Protected Attributes
LIB_TABLE *	m_lib_table

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	m_adapter

wxSearchCtrl *	m_query_ctrl

wxDataViewCtrl *	m_tree_ctrl

HTML_WINDOW *	m_details_ctrl

wxTimer *	m_debounceTimer

bool	m_inTimerEvent

LIB_ID	m_last_libid

wxString	m_recentSearchesKey

bool	m_skipNextRightClick

Detailed Description

Widget displaying a tree of symbols with optional search text control and description panel.Custom event sent when a new symbol is preselected.

Definition at line 45 of file lib_tree.h.

Member Enumeration Documentation

◆ FLAGS

enum LIB_TREE::FLAGS

< Flags to select extra widgets and options

Enumerator
NONE
SEARCH
DETAILS
ALL_WIDGETS
MULTISELECT

Definition at line 49 of file lib_tree.h.

 {
 NONE = 0x00,
 SEARCH = 0x01,
 DETAILS = 0x02,
 ALL_WIDGETS = 0x0F,
 MULTISELECT = 0x10
 };

Constructor & Destructor Documentation

◆ LIB_TREE()

LIB_TREE::LIB_TREE	(	wxWindow *	aParent,
		const wxString &	aRecentSearchesKey,
		LIB_TABLE *	aLibTable,
		wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &	aAdapter,
		int	aFlags = `ALL_WIDGETS`,
		HTML_WINDOW *	aDetails = `nullptr`
	)

Construct a symbol tree.

Parameters

aParent	parent window containing this tree widget
aRecentSearchesKey	a key into a global map storing recent searches (usually "power", "symbols", or "footprints", but could be further differentiated)
aLibTable	table containing libraries and items to display
aAdapter	a LIB_TREE_MODEL_ADAPTER instance to use
aFlags	selection of sub-widgets to include and other options
aDetails	if not null, a custom HTML_WINDOW to hold symbol details. If null this will be created inside the LIB_TREE.

Definition at line 44 of file lib_tree.cpp.

 :
 wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 wxWANTS_CHARS | wxTAB_TRAVERSAL | wxNO_BORDER ),
 m_lib_table( aLibTable ), m_adapter( aAdapter ), m_query_ctrl( nullptr ),
 m_details_ctrl( nullptr ),
 m_inTimerEvent( false ),
 m_recentSearchesKey( aRecentSearchesKey ),
 m_skipNextRightClick( false )
{
 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
 
 // Search text control
 if( aFlags & SEARCH )
 {
 wxBoxSizer* search_sizer = new wxBoxSizer( wxHORIZONTAL );
 
 m_query_ctrl = new wxSearchCtrl( this, wxID_ANY );
 
 m_query_ctrl->ShowCancelButton( true );
 
#ifdef __WXGTK__
 // wxSearchCtrl vertical height is not calculated correctly on some GTK setups
 // See https://gitlab.com/kicad/code/kicad/-/issues/9019
 m_query_ctrl->SetMinSize( wxSize( -1, GetTextExtent( wxT( "qb" ) ).y + 10 ) );
#endif
 
 m_debounceTimer = new wxTimer( this );
 
 search_sizer->Add( m_query_ctrl, 1, wxEXPAND, 5 );
 
 sizer->Add( search_sizer, 0, wxEXPAND, 5 );
 
 m_query_ctrl->Bind( wxEVT_TEXT, &LIB_TREE::onQueryText, this );
 
#if wxCHECK_VERSION( 3, 1, 1 )
 m_query_ctrl->Bind( wxEVT_SEARCH_CANCEL, &LIB_TREE::onQueryText, this );
#else
 m_query_ctrl->Bind( wxEVT_SEARCHCTRL_CANCEL_BTN, &LIB_TREE::onQueryText, this );
#endif
 m_query_ctrl->Bind( wxEVT_CHAR_HOOK, &LIB_TREE::onQueryCharHook, this );
 m_query_ctrl->Bind( wxEVT_MOTION, &LIB_TREE::onQueryMouseMoved, this );
 m_query_ctrl->Bind( wxEVT_LEAVE_WINDOW,
 [this] ( wxMouseEvent& aEvt )
 {
 SetCursor( wxCURSOR_ARROW );
 } );
 
 m_query_ctrl->Bind( wxEVT_MENU,
 [this]( wxCommandEvent& aEvent )
 {
 wxString search;
 size_t idx = aEvent.GetId() - 1;
 
 if( idx < g_recentSearches[ m_recentSearchesKey ].size() )
 m_query_ctrl->SetValue( g_recentSearches[ m_recentSearchesKey ][idx] );
 },
 1, RECENT_SEARCHES_MAX );
 
 Bind( wxEVT_TIMER, &LIB_TREE::onDebounceTimer, this, m_debounceTimer->GetId() );
 }
 
 // Tree control
 int dvFlags = ( aFlags & MULTISELECT ) ? wxDV_MULTIPLE : wxDV_SINGLE;
 m_tree_ctrl = new wxDataViewCtrl( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, dvFlags );
 m_adapter->AttachTo( m_tree_ctrl );
 
 if( aFlags & DETAILS )
 sizer->AddSpacer( 5 );
 
 sizer->Add( m_tree_ctrl, 5, wxRIGHT | wxBOTTOM | wxEXPAND, 1 );
 
 // Description panel
 if( aFlags & DETAILS )
 {
 if( !aDetails )
 {
 wxPoint html_size = ConvertDialogToPixels( wxPoint( 80, 80 ) );
 
 m_details_ctrl = new HTML_WINDOW( this, wxID_ANY, wxDefaultPosition,
 wxSize( html_size.x, html_size.y ),
 wxHW_SCROLLBAR_AUTO );
 
 sizer->Add( m_details_ctrl, 2, wxTOP | wxEXPAND, 5 );
 }
 else
 {
 m_details_ctrl = aDetails;
 }
 
 m_details_ctrl->Bind( wxEVT_HTML_LINK_CLICKED, &LIB_TREE::onDetailsLink, this );
 }
 
 SetSizer( sizer );
 
 m_tree_ctrl->Bind( wxEVT_SIZE, &LIB_TREE::onSize, this );
 m_tree_ctrl->Bind( wxEVT_DATAVIEW_ITEM_ACTIVATED, &LIB_TREE::onTreeActivate, this );
 m_tree_ctrl->Bind( wxEVT_DATAVIEW_SELECTION_CHANGED, &LIB_TREE::onTreeSelect, this );
 m_tree_ctrl->Bind( wxEVT_DATAVIEW_ITEM_CONTEXT_MENU, &LIB_TREE::onItemContextMenu, this );
 m_tree_ctrl->Bind( wxEVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, &LIB_TREE::onHeaderContextMenu,
 this );
 
 // Process hotkeys when the tree control has focus:
 m_tree_ctrl->Bind( wxEVT_CHAR_HOOK, &LIB_TREE::onTreeCharHook, this );
 
 Bind( SYMBOL_PRESELECTED, &LIB_TREE::onPreselect, this );
 
 if( m_query_ctrl )
 {
 m_query_ctrl->SetDescriptiveText( _( "Filter" ) );
 m_query_ctrl->SetFocus();
 m_query_ctrl->SetValue( wxEmptyString );
 updateRecentSearchMenu();
 
 // Force an update of the adapter with the empty text to ensure preselect is done
 Regenerate( false );
 }
 else
 {
 // There may be a part preselected in the model. Make sure it is displayed.
 // Regenerate does this in the other branch
 postPreselectEvent();
 }
 
 Layout();
 sizer->Fit( this );
 
#ifdef __WXGTK__
 // Scrollbars must be always enabled to prevent an infinite event loop
 // more details: http://trac.wxwidgets.org/ticket/18141
 if( m_details_ctrl )
 m_details_ctrl->ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
#endif /* __WXGTK__ */
}

References _, DETAILS, g_recentSearches, m_adapter, m_debounceTimer, m_details_ctrl, m_query_ctrl, m_recentSearchesKey, m_tree_ctrl, MULTISELECT, onDebounceTimer(), onDetailsLink(), onHeaderContextMenu(), onItemContextMenu(), onPreselect(), onQueryCharHook(), onQueryMouseMoved(), onQueryText(), onSize(), onTreeActivate(), onTreeCharHook(), onTreeSelect(), postPreselectEvent(), RECENT_SEARCHES_MAX, Regenerate(), SEARCH, and updateRecentSearchMenu().

◆ ~LIB_TREE()

LIB_TREE::~LIB_TREE ( )

override

Definition at line 181 of file lib_tree.cpp.

{
 // Stop the timer during destruction early to avoid potential race conditions (that do happen)
 m_debounceTimer->Stop();
}

References m_debounceTimer.

Member Function Documentation

◆ centerIfValid()

void LIB_TREE::centerIfValid ( const wxDataViewItem & aTreeId )

protected

Definition at line 361 of file lib_tree.cpp.

{
 /*
 * This doesn't actually center because the wxWidgets API is poorly suited to that (and
 * it might be too noisy as well).
 *
 * It does try to keep the given item a bit off the top or bottom of the window.
 */
 
 if( aTreeId.IsOk() )
 {
 LIB_TREE_NODE* node = m_adapter->GetTreeNodeFor( aTreeId );
 LIB_TREE_NODE* parent = node->m_Parent;
 LIB_TREE_NODE* grandParent = parent ? parent->m_Parent : nullptr;
 
 if( parent )
 {
 wxDataViewItemArray siblings;
 m_adapter->GetChildren( wxDataViewItem( parent ), siblings );
 
 int idx = siblings.Index( aTreeId );
 
 if( idx + 5 < (int) siblings.GetCount() )
 {
 m_tree_ctrl->EnsureVisible( siblings.Item( idx + 5 ) );
 }
 else if( grandParent )
 {
 wxDataViewItemArray parentsSiblings;
 m_adapter->GetChildren( wxDataViewItem( grandParent ), parentsSiblings );
 
 int p_idx = parentsSiblings.Index( wxDataViewItem( parent ) );
 
 if( p_idx + 1 < (int) parentsSiblings.GetCount() )
 m_tree_ctrl->EnsureVisible( parentsSiblings.Item( p_idx + 1 ) );
 }
 
 if( idx - 5 >= 0 )
 m_tree_ctrl->EnsureVisible( siblings.Item( idx - 5 ) );
 else
 m_tree_ctrl->EnsureVisible( wxDataViewItem( parent ) );
 }
 
 m_tree_ctrl->EnsureVisible( aTreeId );
 }
}

References m_adapter, LIB_TREE_NODE::m_Parent, and m_tree_ctrl.

Referenced by CenterLibId().

◆ CenterLibId()

void LIB_TREE::CenterLibId ( const LIB_ID & aLibId )

Ensure that an item is visible (preferably centered).

Definition at line 236 of file lib_tree.cpp.

{
 centerIfValid( m_adapter->FindItem( aLibId ) );
}

References centerIfValid(), and m_adapter.

Referenced by SYMBOL_EDIT_FRAME::centerItemIdleHandler(), FOOTPRINT_EDIT_FRAME::centerItemIdleHandler(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::RegenerateLibraryTree(), FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree(), SYMBOL_EDIT_FRAME::SyncLibraries(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

◆ expandIfValid()

void LIB_TREE::expandIfValid ( const wxDataViewItem & aTreeId )

protected

Definition at line 409 of file lib_tree.cpp.

{
 if( aTreeId.IsOk() && !m_tree_ctrl->IsExpanded( aTreeId ) )
 m_tree_ctrl->Expand( aTreeId );
}

References m_tree_ctrl.

Referenced by ExpandLibId().

◆ ExpandLibId()

void LIB_TREE::ExpandLibId ( const LIB_ID & aLibId )

Expand and item i the tree widget.

Definition at line 248 of file lib_tree.cpp.

{
 expandIfValid( m_adapter->FindItem( aLibId ) );
}

References expandIfValid(), and m_adapter.

Referenced by SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), and SYMBOL_EDIT_FRAME::LoadSymbol().

◆ FocusSearchFieldIfExists()

void LIB_TREE::FocusSearchFieldIfExists ( )

Focus the search widget if it exists.

Definition at line 328 of file lib_tree.cpp.

{
 if( m_query_ctrl )
 {
 m_query_ctrl->SetFocus();
 }
}

References m_query_ctrl.

Referenced by FOOTPRINT_TREE_PANE::FocusSearchFieldIfExists().

◆ GetCurrentTreeNode()

LIB_TREE_NODE * LIB_TREE::GetCurrentTreeNode ( ) const

Definition at line 219 of file lib_tree.cpp.

{
 wxDataViewItem sel = m_tree_ctrl->GetSelection();
 
 if( !sel )
 return nullptr;
 
 return m_adapter->GetTreeNodeFor( sel );
}

References m_adapter, and m_tree_ctrl.

Referenced by SYMBOL_EDIT_FRAME::GetCurrentTreeNode(), FOOTPRINT_EDIT_FRAME::GetCurrentTreeNode(), DIALOG_CHOOSE_SYMBOL::OnComponentPreselected(), and onItemContextMenu().

◆ GetFocusTarget()

wxWindow * LIB_TREE::GetFocusTarget ( )

Definition at line 319 of file lib_tree.cpp.

{
 if( m_query_ctrl )
 return m_query_ctrl;
 else
 return m_tree_ctrl;
}

References m_query_ctrl, and m_tree_ctrl.

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), and DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ GetSearchString()

wxString LIB_TREE::GetSearchString ( ) const

Definition at line 260 of file lib_tree.cpp.

{
 return m_query_ctrl->GetValue();
}

References m_query_ctrl.

Referenced by updateRecentSearchMenu(), and DIALOG_CHOOSE_SYMBOL::~DIALOG_CHOOSE_SYMBOL().

◆ GetSelectedLibId()

LIB_ID LIB_TREE::GetSelectedLibId ( int * aUnit = nullptr ) const

For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit, 0 will be returned in aUnit.

Beware that this is an invalid unit number - this should be replaced with whatever default is desired (usually 1).

Parameters

aUnit if not NULL, the selected unit is filled in here.

Returns: the library id of the symbol that has been selected.

Definition at line 188 of file lib_tree.cpp.

{
 wxDataViewItem sel = m_tree_ctrl->GetSelection();
 
 if( !sel )
 return LIB_ID();
 
 if( aUnit )
 *aUnit = m_adapter->GetUnitFor( sel );
 
 return m_adapter->GetAliasFor( sel );
}

References m_adapter, and m_tree_ctrl.

Referenced by DIALOG_CHOOSE_FOOTPRINT::GetSelectedLibId(), DIALOG_CHOOSE_SYMBOL::GetSelectedLibId(), getState(), FOOTPRINT_EDIT_FRAME::GetTreeFPID(), SYMBOL_EDIT_FRAME::GetTreeLIBID(), DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), DIALOG_CHOOSE_SYMBOL::OnComponentSelected(), DIALOG_CHOOSE_FOOTPRINT::OnComponentSelected(), onPreselect(), onQueryCharHook(), onTreeActivate(), SYMBOL_EDIT_FRAME::SyncLibraries(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

◆ GetSelectedLibIds()

int LIB_TREE::GetSelectedLibIds	(	std::vector< LIB_ID > &	aSelection,
		std::vector< int > *	aUnit = `nullptr`
	)		const

Retrieves a list of selections for trees that allow multi-selection.

See also: GetSelectedLibId for details on how aUnit will be filled.

Parameters

aSelection	will be filled with a list of selected LIB_IDs
aUnit	is an optional pointer to a list to fill with unit numbers

Returns: the number of selected items

Definition at line 202 of file lib_tree.cpp.

{
 wxDataViewItemArray selection;
 int count = m_tree_ctrl->GetSelections( selection );
 
 for( const wxDataViewItem& item : selection )
 {
 aSelection.emplace_back( m_adapter->GetAliasFor( item ) );
 
 if( aUnit )
 aUnit->emplace_back( m_adapter->GetUnitFor( item ) );
 }
 
 return count;
}

References m_adapter, and m_tree_ctrl.

Referenced by SYMBOL_EDIT_FRAME::GetTreeLIBIDs().

◆ GetSelectionCount()

int LIB_TREE::GetSelectionCount ( ) const

inline

Definition at line 87 of file lib_tree.h.

 {
 return m_tree_ctrl->GetSelectedItemsCount();
 }

References m_tree_ctrl.

Referenced by SYMBOL_EDIT_FRAME::GetTreeSelectionCount().

◆ getState()

LIB_TREE::STATE LIB_TREE::getState ( ) const

protected

Return the symbol tree widget state.

Definition at line 430 of file lib_tree.cpp.

{
 STATE state;
 wxDataViewItemArray items;
 m_adapter->GetChildren( wxDataViewItem( nullptr ), items );
 
 for( const wxDataViewItem& item : items )
 {
 if( m_tree_ctrl->IsExpanded( item ) )
 state.expanded.push_back( item );
 }
 
 state.selection = GetSelectedLibId();
 
 return state;
}

References LIB_TREE::STATE::expanded, GetSelectedLibId(), m_adapter, m_tree_ctrl, and LIB_TREE::STATE::selection.

Referenced by Regenerate().

◆ onDebounceTimer()

void LIB_TREE::onDebounceTimer ( wxTimerEvent & aEvent )

protected

Definition at line 474 of file lib_tree.cpp.

{
 m_inTimerEvent = true;
 Regenerate( false );
 m_inTimerEvent = false;
}

References m_inTimerEvent, and Regenerate().

Referenced by LIB_TREE().

◆ onDetailsLink()

void LIB_TREE::onDetailsLink ( wxHtmlLinkEvent & aEvent )

protected

Definition at line 598 of file lib_tree.cpp.

{
 const wxHtmlLinkInfo& info = aEvent.GetLinkInfo();
 ::wxLaunchDefaultBrowser( info.GetHref() );
}

References info.

Referenced by LIB_TREE().

◆ onHeaderContextMenu()

void LIB_TREE::onHeaderContextMenu ( wxDataViewEvent & aEvent )

protected

Definition at line 692 of file lib_tree.cpp.

{
 ACTION_MENU menu( true, nullptr );
 
 menu.Add( ACTIONS::selectColumns );
 
 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
 {
 EDA_REORDERABLE_LIST_DIALOG dlg( m_parent, _( "Select Columns" ),
 m_adapter->GetAvailableColumns(),
 m_adapter->GetShownColumns() );
 
 if( dlg.ShowModal() == wxID_OK )
 m_adapter->SetShownColumns( dlg.EnabledList() );
 }
 
#if !wxCHECK_VERSION( 3, 1, 0 )
 // wxGTK 3.0 sends item right click events for header right clicks
 m_skipNextRightClick = true;
#endif
}

References _, ACTION_MENU::Add(), EDA_REORDERABLE_LIST_DIALOG::EnabledList(), m_adapter, m_skipNextRightClick, and ACTIONS::selectColumns.

Referenced by LIB_TREE().

◆ onItemContextMenu()

void LIB_TREE::onItemContextMenu ( wxDataViewEvent & aEvent )

protected

Definition at line 622 of file lib_tree.cpp.

{
 if( m_skipNextRightClick )
 {
 m_skipNextRightClick = false;
 return;
 }
 
 if( TOOL_INTERACTIVE* tool = m_adapter->GetContextMenuTool() )
 {
 if( !GetCurrentTreeNode() )
 {
 wxPoint pos = m_tree_ctrl->ScreenToClient( wxGetMousePosition() );
 
 // What we actually want is the height of the column header, but wxWidgets gives us
 // no way to get that, so we use the height of the search ctrl as a proxy. And it's
 // not even a very good proxy on Mac....
 int headerHeight = m_tree_ctrl->GetPosition().y;
#ifdef __WXMAC__
 headerHeight += 5;
#endif
 
 pos.y -= headerHeight;
 
 wxDataViewItem item;
 wxDataViewColumn* col;
 m_tree_ctrl->HitTest( pos, item, col );
 
 if( item.IsOk() )
 {
 m_tree_ctrl->SetFocus();
 m_tree_ctrl->Select( item );
 wxSafeYield();
 }
 }
 
 tool->Activate();
 tool->GetManager()->VetoContextMenuMouseWarp();
 tool->GetToolMenu().ShowContextMenu();
 
 TOOL_EVENT evt( TC_MOUSE, TA_MOUSE_CLICK, BUT_RIGHT );
 tool->GetManager()->DispatchContextMenu( evt );
 }
 else
 {
 LIB_TREE_NODE* current = GetCurrentTreeNode();
 
 if( current && current->m_Type == LIB_TREE_NODE::LIB )
 {
 ACTION_MENU menu( true, nullptr );
 
 if( current->m_Pinned )
 {
 menu.Add( ACTIONS::unpinLibrary );
 
 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
 m_adapter->UnpinLibrary( current );
 }
 else
 {
 menu.Add( ACTIONS::pinLibrary );
 
 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
 m_adapter->PinLibrary( current );
 }
 }
 }
}

References ACTION_MENU::Add(), BUT_RIGHT, GetCurrentTreeNode(), LIB_TREE_NODE::LIB, m_adapter, LIB_TREE_NODE::m_Pinned, m_skipNextRightClick, m_tree_ctrl, LIB_TREE_NODE::m_Type, ACTIONS::pinLibrary, TA_MOUSE_CLICK, TC_MOUSE, and ACTIONS::unpinLibrary.

Referenced by LIB_TREE().

◆ onPreselect()

void LIB_TREE::onPreselect ( wxCommandEvent & aEvent )

protected

Definition at line 605 of file lib_tree.cpp.

{
 if( m_details_ctrl )
 {
 int unit = 0;
 LIB_ID id = GetSelectedLibId( &unit );
 
 if( id.IsValid() )
 m_details_ctrl->SetPage( m_adapter->GenerateInfo( id, unit ) );
 else
 m_details_ctrl->SetPage( wxEmptyString );
 }
 
 aEvent.Skip();
}

References GetSelectedLibId(), SIM_VALUE_GRAMMAR::IsValid(), m_adapter, m_details_ctrl, and HTML_WINDOW::SetPage().

Referenced by LIB_TREE().

◆ onQueryCharHook()

void LIB_TREE::onQueryCharHook ( wxKeyEvent & aEvent )

protected

Definition at line 482 of file lib_tree.cpp.

{
 const wxDataViewItem sel = m_tree_ctrl->GetSelection();
 LIB_TREE_NODE::TYPE type = sel.IsOk() ? m_adapter->GetTypeFor( sel ) : LIB_TREE_NODE::INVALID;
 
 switch( aKeyStroke.GetKeyCode() )
 {
 case WXK_UP:
 updateRecentSearchMenu();
 selectIfValid( GetPrevItem( *m_tree_ctrl, sel ) );
 break;
 
 case WXK_DOWN:
 updateRecentSearchMenu();
 selectIfValid( GetNextItem( *m_tree_ctrl, sel ) );
 break;
 
 case WXK_ADD:
 updateRecentSearchMenu();
 
 if( type == LIB_TREE_NODE::LIB )
 m_tree_ctrl->Expand( sel );
 
 break;
 
 case WXK_SUBTRACT:
 updateRecentSearchMenu();
 
 if( type == LIB_TREE_NODE::LIB )
 m_tree_ctrl->Collapse( sel );
 
 break;
 
 case WXK_RETURN:
 updateRecentSearchMenu();
 
 if( GetSelectedLibId().IsValid() )
 postSelectEvent();
 else if( type == LIB_TREE_NODE::LIB )
 toggleExpand( sel );
 
 break;
 
 default:
 aKeyStroke.Skip(); // Any other key: pass on to search box directly.
 break;
 }
}

References GetNextItem(), GetPrevItem(), GetSelectedLibId(), LIB_TREE_NODE::INVALID, SIM_VALUE_GRAMMAR::IsValid(), LIB_TREE_NODE::LIB, m_adapter, m_tree_ctrl, postSelectEvent(), selectIfValid(), toggleExpand(), and updateRecentSearchMenu().

Referenced by LIB_TREE(), and onTreeCharHook().

◆ onQueryMouseMoved()

void LIB_TREE::onQueryMouseMoved ( wxMouseEvent & aEvent )

protected

Definition at line 532 of file lib_tree.cpp.

{
 wxPoint pos = aEvent.GetPosition();
 wxRect ctrlRect = m_query_ctrl->GetScreenRect();
 int buttonWidth = ctrlRect.GetHeight(); // Presume buttons are square
 
 if( m_query_ctrl->IsSearchButtonVisible() && pos.x < buttonWidth )
 SetCursor( wxCURSOR_ARROW );
 else if( m_query_ctrl->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
 SetCursor( wxCURSOR_ARROW );
 else
 SetCursor( wxCURSOR_IBEAM );
}

References m_query_ctrl.

Referenced by LIB_TREE().

◆ onQueryText()

void LIB_TREE::onQueryText ( wxCommandEvent & aEvent )

protected

Definition at line 464 of file lib_tree.cpp.

{
 m_debounceTimer->StartOnce( 200 );
 
 // Required to avoid interaction with SetHint()
 // See documentation for wxTextEntry::SetHint
 aEvent.Skip();
}

References m_debounceTimer.

Referenced by LIB_TREE().

◆ onSize()

void LIB_TREE::onSize ( wxSizeEvent & aEvent )

protected

Definition at line 592 of file lib_tree.cpp.

{
 m_adapter->OnSize( aEvent );
}

References m_adapter.

Referenced by LIB_TREE().

◆ onTreeActivate()

void LIB_TREE::onTreeActivate ( wxDataViewEvent & aEvent )

protected

Definition at line 583 of file lib_tree.cpp.

{
 if( !GetSelectedLibId().IsValid() )
 toggleExpand( m_tree_ctrl->GetSelection() ); // Expand library/part units subtree
 else
 postSelectEvent(); // Open symbol/footprint
}

References GetSelectedLibId(), SIM_VALUE_GRAMMAR::IsValid(), m_tree_ctrl, postSelectEvent(), and toggleExpand().

Referenced by LIB_TREE().

◆ onTreeCharHook()

void LIB_TREE::onTreeCharHook ( wxKeyEvent & aEvent )

protected

Definition at line 547 of file lib_tree.cpp.

{
 onQueryCharHook( aKeyStroke );
 
 if( aKeyStroke.GetSkipped() )
 {
 if( TOOL_INTERACTIVE* tool = m_adapter->GetContextMenuTool() )
 {
 int hotkey = aKeyStroke.GetKeyCode();
 
 if( aKeyStroke.ShiftDown() )
 hotkey |= MD_SHIFT;
 
 if( aKeyStroke.AltDown() )
 hotkey |= MD_ALT;
 
 if( aKeyStroke.ControlDown() )
 hotkey |= MD_CTRL;
 
 if( tool->GetManager()->GetActionManager()->RunHotKey( hotkey ) )
 aKeyStroke.Skip( false );
 }
 }
}

References m_adapter, MD_ALT, MD_CTRL, MD_SHIFT, and onQueryCharHook().

Referenced by LIB_TREE().

◆ onTreeSelect()

void LIB_TREE::onTreeSelect ( wxDataViewEvent & aEvent )

protected

Definition at line 573 of file lib_tree.cpp.

{
 if( !m_inTimerEvent )
 updateRecentSearchMenu();
 
 if( !m_tree_ctrl->IsFrozen() )
 postPreselectEvent();
}

References m_inTimerEvent, m_tree_ctrl, postPreselectEvent(), and updateRecentSearchMenu().

Referenced by LIB_TREE().

◆ postPreselectEvent()

void LIB_TREE::postPreselectEvent ( )

protected

Post a wxEVT_DATAVIEW_SELECTION_CHANGED to notify the selection handler that a new part has been preselected.

Definition at line 416 of file lib_tree.cpp.

{
 wxCommandEvent event( SYMBOL_PRESELECTED );
 wxPostEvent( this, event );
}

Referenced by LIB_TREE(), onTreeSelect(), Regenerate(), and selectIfValid().

◆ postSelectEvent()

void LIB_TREE::postSelectEvent ( )

protected

Post SYMBOL_SELECTED event to notify the selection handler that a part has been selected.

Definition at line 423 of file lib_tree.cpp.

{
 wxCommandEvent event( SYMBOL_SELECTED );
 wxPostEvent( this, event );
}

Referenced by onQueryCharHook(), and onTreeActivate().

◆ RefreshLibTree()

void LIB_TREE::RefreshLibTree ( )

Refreshes the tree (mainly to update highlighting and asterisking)

Definition at line 313 of file lib_tree.cpp.

{
 m_adapter->RefreshTree();
}

References m_adapter.

Referenced by SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::OnModify(), FOOTPRINT_EDIT_FRAME::OnModify(), SYMBOL_TREE_PANE::onSymbolSelected(), SYMBOL_EDIT_FRAME::RefreshLibraryTree(), FOOTPRINT_EDIT_FRAME::RefreshLibraryTree(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::SaveAll(), SYMBOL_EDIT_FRAME::SaveLibraryAs(), SYMBOL_EDIT_FRAME::SaveSymbolAs(), SYMBOL_EDIT_FRAME::UpdateLibraryTree(), and FOOTPRINT_EDIT_FRAME::UpdateLibraryTree().

◆ Regenerate()

void LIB_TREE::Regenerate ( bool aKeepState )

Regenerate the tree.

Definition at line 295 of file lib_tree.cpp.

{
 STATE current;
 
 // Store the state
 if( aKeepState )
 current = getState();
 
 wxString filter = m_query_ctrl->GetValue();
 m_adapter->UpdateSearchString( filter, aKeepState );
 postPreselectEvent();
 
 // Restore the state
 if( aKeepState )
 setState( current );
}

References filter, getState(), m_adapter, m_query_ctrl, postPreselectEvent(), and setState().

Referenced by LIB_TREE(), onDebounceTimer(), SYMBOL_EDIT_FRAME::RegenerateLibraryTree(), FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree(), SYMBOL_EDIT_FRAME::SyncLibraries(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

◆ selectIfValid()

void LIB_TREE::selectIfValid ( const wxDataViewItem & aTreeId )

protected

If a wxDataViewitem is valid, select it and post a selection event.

Definition at line 349 of file lib_tree.cpp.

{
 if( aTreeId.IsOk() )
 {
 m_tree_ctrl->EnsureVisible( aTreeId );
 m_tree_ctrl->UnselectAll();
 m_tree_ctrl->Select( aTreeId );
 postPreselectEvent();
 }
}

References m_tree_ctrl, and postPreselectEvent().

Referenced by onQueryCharHook(), and SelectLibId().

◆ SelectLibId()

void LIB_TREE::SelectLibId ( const LIB_ID & aLibId )

Select an item in the tree widget.

Definition at line 230 of file lib_tree.cpp.

{
 selectIfValid( m_adapter->FindItem( aLibId ) );
}

References m_adapter, and selectIfValid().

◆ SetSearchString()

void LIB_TREE::SetSearchString ( const wxString & aSearchString )

Save/restore search string.

Definition at line 254 of file lib_tree.cpp.

{
 m_query_ctrl->ChangeValue( aSearchString );
}

References m_query_ctrl.

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ setState()

void LIB_TREE::setState ( const STATE & aState )

protected

Restore the symbol tree widget state from an object.

Definition at line 448 of file lib_tree.cpp.

{
 m_tree_ctrl->Freeze();
 
 for( const wxDataViewItem& item : aState.expanded )
 m_tree_ctrl->Expand( item );
 
 // wxDataViewCtrl cannot be frozen when a selection
 // command is issued, otherwise it selects a random item (Windows)
 m_tree_ctrl->Thaw();
 
 if( !aState.selection.GetLibItemName().empty() || !aState.selection.GetLibNickname().empty() )
 SelectLibId( aState.selection );
}

References UTF8::empty(), LIB_TREE::STATE::expanded, LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_tree_ctrl, LIB_TREE::STATE::selection, and SelectLibId().

Referenced by Regenerate().

◆ toggleExpand()

void LIB_TREE::toggleExpand ( const wxDataViewItem & aTreeId )

protected

Expand or collapse a node, switching it to the opposite state.

Definition at line 337 of file lib_tree.cpp.

{
 if( !aTreeId.IsOk() )
 return;
 
 if( m_tree_ctrl->IsExpanded( aTreeId ) )
 m_tree_ctrl->Collapse( aTreeId );
 else
 m_tree_ctrl->Expand( aTreeId );
}

References m_tree_ctrl.

Referenced by onQueryCharHook(), and onTreeActivate().

◆ Unselect()

void LIB_TREE::Unselect ( )

Unselect currently selected item in wxDataViewCtrl.

Definition at line 242 of file lib_tree.cpp.

{
 m_tree_ctrl->UnselectAll();
}

References m_tree_ctrl.

Referenced by SYMBOL_EDIT_FRAME::emptyScreen(), FOOTPRINT_TREE_PANE::onComponentSelected(), SYMBOL_TREE_PANE::onSymbolSelected(), SYMBOL_TREE_PANE::onUpdateUI(), FOOTPRINT_TREE_PANE::onUpdateUI(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::SyncLibraries(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

◆ updateRecentSearchMenu()

void LIB_TREE::updateRecentSearchMenu ( )

protected

Definition at line 266 of file lib_tree.cpp.

{
 wxString newEntry = GetSearchString();
 
 std::vector<wxString>& recents = g_recentSearches[ m_recentSearchesKey ];
 
 if( !newEntry.IsEmpty() )
 {
 if( alg::contains( recents, newEntry ) )
 alg::delete_matching( recents, newEntry );
 
 if( recents.size() >= RECENT_SEARCHES_MAX )
 recents.pop_back();
 
 recents.insert( recents.begin(), newEntry );
 }
 
 wxMenu* menu = new wxMenu();
 
 for( const wxString& recent : recents )
 menu->Append( menu->GetMenuItemCount() + 1, recent );
 
 if( recents.empty() )
 menu->Append( wxID_ANY, _( "recent searches" ) );
 
 m_query_ctrl->SetMenu( menu );
}

References _, alg::contains(), alg::delete_matching(), g_recentSearches, GetSearchString(), m_query_ctrl, m_recentSearchesKey, recent, and RECENT_SEARCHES_MAX.

Referenced by LIB_TREE(), onQueryCharHook(), and onTreeSelect().

Member Data Documentation

◆ m_adapter

wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> LIB_TREE::m_adapter

protected

Definition at line 217 of file lib_tree.h.

Referenced by centerIfValid(), CenterLibId(), ExpandLibId(), GetCurrentTreeNode(), GetSelectedLibId(), GetSelectedLibIds(), getState(), LIB_TREE(), onHeaderContextMenu(), onItemContextMenu(), onPreselect(), onQueryCharHook(), onSize(), onTreeCharHook(), RefreshLibTree(), Regenerate(), and SelectLibId().

◆ m_debounceTimer

wxTimer* LIB_TREE::m_debounceTimer

protected

Definition at line 222 of file lib_tree.h.

Referenced by LIB_TREE(), onQueryText(), and ~LIB_TREE().

◆ m_details_ctrl

HTML_WINDOW* LIB_TREE::m_details_ctrl

protected

Definition at line 221 of file lib_tree.h.

Referenced by LIB_TREE(), and onPreselect().

◆ m_inTimerEvent

bool LIB_TREE::m_inTimerEvent

protected

Definition at line 223 of file lib_tree.h.

Referenced by onDebounceTimer(), and onTreeSelect().

◆ m_last_libid

LIB_ID LIB_TREE::m_last_libid

protected

Definition at line 225 of file lib_tree.h.

◆ m_lib_table

LIB_TABLE* LIB_TREE::m_lib_table

protected

Definition at line 215 of file lib_tree.h.

◆ m_query_ctrl

wxSearchCtrl* LIB_TREE::m_query_ctrl

protected

Definition at line 219 of file lib_tree.h.

Referenced by FocusSearchFieldIfExists(), GetFocusTarget(), GetSearchString(), LIB_TREE(), onQueryMouseMoved(), Regenerate(), SetSearchString(), and updateRecentSearchMenu().

◆ m_recentSearchesKey

wxString LIB_TREE::m_recentSearchesKey

protected

Definition at line 226 of file lib_tree.h.

Referenced by LIB_TREE(), and updateRecentSearchMenu().

◆ m_skipNextRightClick

bool LIB_TREE::m_skipNextRightClick

protected

Definition at line 228 of file lib_tree.h.

Referenced by onHeaderContextMenu(), and onItemContextMenu().

◆ m_tree_ctrl

wxDataViewCtrl* LIB_TREE::m_tree_ctrl

protected

Definition at line 220 of file lib_tree.h.

Referenced by centerIfValid(), expandIfValid(), GetCurrentTreeNode(), GetFocusTarget(), GetSelectedLibId(), GetSelectedLibIds(), GetSelectionCount(), getState(), LIB_TREE(), onItemContextMenu(), onQueryCharHook(), onTreeActivate(), onTreeSelect(), selectIfValid(), setState(), toggleExpand(), and Unselect().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ FLAGS

Constructor & Destructor Documentation

◆ LIB_TREE()

◆ ~LIB_TREE()

Member Function Documentation

◆ centerIfValid()

◆ CenterLibId()

◆ expandIfValid()

◆ ExpandLibId()

◆ FocusSearchFieldIfExists()

◆ GetCurrentTreeNode()

◆ GetFocusTarget()

◆ GetSearchString()

◆ GetSelectedLibId()

◆ GetSelectedLibIds()

◆ GetSelectionCount()

◆ getState()

◆ onDebounceTimer()

◆ onDetailsLink()

◆ onHeaderContextMenu()

◆ onItemContextMenu()

◆ onPreselect()

◆ onQueryCharHook()

◆ onQueryMouseMoved()

◆ onQueryText()

◆ onSize()

◆ onTreeActivate()

◆ onTreeCharHook()

◆ onTreeSelect()

◆ postPreselectEvent()

◆ postSelectEvent()

◆ RefreshLibTree()

◆ Regenerate()

◆ selectIfValid()

◆ SelectLibId()

◆ SetSearchString()

◆ setState()

◆ toggleExpand()

◆ Unselect()

◆ updateRecentSearchMenu()

Member Data Documentation

◆ m_adapter

◆ m_debounceTimer

◆ m_details_ctrl

◆ m_inTimerEvent

◆ m_last_libid

◆ m_lib_table

◆ m_query_ctrl

◆ m_recentSearchesKey

◆ m_skipNextRightClick

◆ m_tree_ctrl