LIB_TREE Class Reference

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	WIDGETS { NONE = 0x00, SEARCH = 0x01, DETAILS = 0x02, ALL = 0xFF }
	< Flags to select extra widgets More...

Public Member Functions
	LIB_TREE (wxWindow *aParent, LIB_TABLE *aLibTable, wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &aAdapter, WIDGETS aWidgets=ALL, 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...
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	Regenerate (bool aKeepState)
	Regenerate the tree. More...
void	RefreshLibTree ()
	Refreshes the tree (mainly to update highlighting and asterisking) More...
wxWindow *	GetFocusTarget ()

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	onQueryText (wxCommandEvent &aEvent)
void	onQueryEnter (wxCommandEvent &aEvent)
void	onQueryCharHook (wxKeyEvent &aEvent)
void	onQueryMouseMoved (wxMouseEvent &aEvent)
void	onTreeSelect (wxDataViewEvent &aEvent)
void	onTreeActivate (wxDataViewEvent &aEvent)
void	onDetailsLink (wxHtmlLinkEvent &aEvent)
void	onPreselect (wxCommandEvent &aEvent)
void	onContextMenu (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
LIB_ID	m_last_libid

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

WIDGETS

enum LIB_TREE::WIDGETS

< Flags to select extra widgets

Enumerator
NONE
SEARCH
DETAILS
ALL

Definition at line 49 of file lib_tree.h.

{ NONE = 0x00, SEARCH = 0x01, DETAILS = 0x02, ALL = 0xFF };

Constructor & Destructor Documentation

LIB_TREE()

LIB_TREE::LIB_TREE	(	wxWindow *	aParent,
		LIB_TABLE *	aLibTable,
		wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &	aAdapter,
		WIDGETS	aWidgets = ALL,
		HTML_WINDOW *	aDetails = nullptr
	)

Construct a symbol tree.

Parameters

aParent	parent window containing this tree widget
aLibTable	table containing libraries and items to display
aAdapter	a LIB_TREE_MODEL_ADAPTER instance to use
aWidgets	selection of sub-widgets to include
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 38 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 )
{
 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );

 // Search text control
 if( aWidgets & SEARCH )
 {
 wxBoxSizer* search_sizer = new wxBoxSizer( wxHORIZONTAL );

 m_query_ctrl = new wxSearchCtrl( this, wxID_ANY, wxEmptyString, wxDefaultPosition,
 wxDefaultSize );

 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, &LIB_TREE::onQueryEnter, this );
 m_query_ctrl->Bind( wxEVT_SEARCH_CANCEL, &LIB_TREE::onQueryText, this );
#else
 m_query_ctrl->Bind( wxEVT_TEXT_ENTER, &LIB_TREE::onQueryEnter, this );
 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 );


 Bind( wxEVT_TIMER, &LIB_TREE::onDebounceTimer, this, m_debounceTimer->GetId() );
 }

 // Tree control
 m_tree_ctrl = new wxDataViewCtrl( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 wxDV_SINGLE );
 m_adapter->AttachTo( m_tree_ctrl );

 if( aWidgets & DETAILS )
 sizer->AddSpacer( 5 );

 sizer->Add( m_tree_ctrl, 5, wxRIGHT | wxBOTTOM | wxEXPAND, 1 );

 // Description panel
 if( aWidgets & 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_DATAVIEW_ITEM_ACTIVATED, &LIB_TREE::onTreeActivate, this );
 m_tree_ctrl->Bind( wxEVT_DATAVIEW_SELECTION_CHANGED, &LIB_TREE::onTreeSelect, this );
 m_tree_ctrl->Bind( wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU, &LIB_TREE::onContextMenu, 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 );

 // 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, m_adapter, m_debounceTimer, m_details_ctrl, m_query_ctrl, m_tree_ctrl, onContextMenu(), onDebounceTimer(), onDetailsLink(), onPreselect(), onQueryCharHook(), onQueryEnter(), onQueryMouseMoved(), onQueryText(), onTreeActivate(), onTreeSelect(), postPreselectEvent(), Regenerate(), and SEARCH.

~LIB_TREE()

LIB_TREE::~LIB_TREE ( )

override

Definition at line 153 of file lib_tree.cpp.

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

 // Save the column widths to the config file
 m_adapter->SaveColWidths();

 m_adapter->SavePinnedItems();
}

References m_adapter, and m_debounceTimer.

Member Function Documentation

centerIfValid()

void LIB_TREE::centerIfValid ( const wxDataViewItem &  aTreeId )

protected

Definition at line 269 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 196 of file lib_tree.cpp.

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

References centerIfValid(), and m_adapter.

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

expandIfValid()

void LIB_TREE::expandIfValid ( const wxDataViewItem &  aTreeId )

protected

Definition at line 317 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 207 of file lib_tree.cpp.

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

References expandIfValid(), and m_adapter.

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

GetCurrentTreeNode()

LIB_TREE_NODE * LIB_TREE::GetCurrentTreeNode

(

)

const

Definition at line 179 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(), and FOOTPRINT_EDIT_FRAME::GetCurrentTreeNode().

GetFocusTarget()

wxWindow * LIB_TREE::GetFocusTarget

(

)

Definition at line 237 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().

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 165 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 SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), DIALOG_CHOOSE_FOOTPRINT::GetSelectedLibId(), DIALOG_CHOOSE_SYMBOL::GetSelectedLibId(), getState(), FOOTPRINT_EDIT_FRAME::GetTreeFPID(), SYMBOL_EDIT_FRAME::GetTreeLIBID(), DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), DIALOG_CHOOSE_SYMBOL::OnComponentPreselected(), DIALOG_CHOOSE_FOOTPRINT::OnComponentSelected(), DIALOG_CHOOSE_SYMBOL::OnComponentSelected(), onPreselect(), onQueryEnter(), onTreeActivate(), SYMBOL_EDIT_FRAME::SyncLibraries(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

getState()

LIB_TREE::STATE LIB_TREE::getState ( ) const

protected

Return the symbol tree widget state.

Definition at line 338 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().

onContextMenu()

void LIB_TREE::onContextMenu ( wxDataViewEvent &  aEvent )

protected

Definition at line 498 of file lib_tree.cpp.

{
 TOOL_INTERACTIVE* tool = m_adapter->GetContextMenuTool();

 if( tool )
 {
 tool->Activate();
 tool->GetManager()->VetoContextMenuMouseWarp();
 tool->GetToolMenu().ShowContextMenu();

 TOOL_EVENT evt( TC_MOUSE, TA_MOUSE_CLICK, BUT_RIGHT );
 tool->GetManager()->DispatchContextMenu( evt );
 }
}

References TOOL_INTERACTIVE::Activate(), BUT_RIGHT, TOOL_MANAGER::DispatchContextMenu(), TOOL_BASE::GetManager(), TOOL_INTERACTIVE::GetToolMenu(), m_adapter, TOOL_MENU::ShowContextMenu(), TA_MOUSE_CLICK, TC_MOUSE, and TOOL_MANAGER::VetoContextMenuMouseWarp().

Referenced by LIB_TREE().

onDebounceTimer()

void LIB_TREE::onDebounceTimer ( wxTimerEvent &  aEvent )

protected

Definition at line 389 of file lib_tree.cpp.

{
 Regenerate( false );
}

References Regenerate().

Referenced by LIB_TREE().

onDetailsLink()

void LIB_TREE::onDetailsLink ( wxHtmlLinkEvent &  aEvent )

protected

Definition at line 474 of file lib_tree.cpp.

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

References info.

Referenced by LIB_TREE().

onPreselect()

void LIB_TREE::onPreselect ( wxCommandEvent &  aEvent )

protected

Definition at line 481 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(), m_adapter, m_details_ctrl, and HTML_WINDOW::SetPage().

Referenced by LIB_TREE().

onQueryCharHook()

void LIB_TREE::onQueryCharHook ( wxKeyEvent &  aEvent )

protected

Definition at line 395 of file lib_tree.cpp.

{
 auto const sel = m_tree_ctrl->GetSelection();
 auto type = sel.IsOk() ? m_adapter->GetTypeFor( sel ) : LIB_TREE_NODE::INVALID;

 switch( aKeyStroke.GetKeyCode() )
 {
 case WXK_UP:
 selectIfValid( GetPrevItem( *m_tree_ctrl, sel ) );
 break;

 case WXK_DOWN:
 selectIfValid( GetNextItem( *m_tree_ctrl, sel ) );
 break;

 case WXK_ADD:
 if( type == LIB_TREE_NODE::LIB )
 m_tree_ctrl->Expand( sel );

 break;

 case WXK_SUBTRACT:
 if( type == LIB_TREE_NODE::LIB )
 m_tree_ctrl->Collapse( sel );

 break;

 case WXK_RETURN:
 if( type == LIB_TREE_NODE::LIB )
 {
 toggleExpand( sel );
 break;
 }
 // Intentionally fall through, so the selected symbol will be treated as the selected one
 KI_FALLTHROUGH;

 default:
 aKeyStroke.Skip(); // Any other key: pass on to search box directly.
 break;
 }
}

References GetNextItem(), GetPrevItem(), LIB_TREE_NODE::INVALID, KI_FALLTHROUGH, LIB_TREE_NODE::LIB, m_adapter, m_tree_ctrl, selectIfValid(), and toggleExpand().

Referenced by LIB_TREE().

onQueryEnter()

void LIB_TREE::onQueryEnter ( wxCommandEvent &  aEvent )

protected

Definition at line 382 of file lib_tree.cpp.

{
 if( GetSelectedLibId().IsValid() )
 postSelectEvent();
}

References GetSelectedLibId(), and postSelectEvent().

Referenced by LIB_TREE().

onQueryMouseMoved()

void LIB_TREE::onQueryMouseMoved ( wxMouseEvent &  aEvent )

protected

Definition at line 438 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 372 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().

onTreeActivate()

void LIB_TREE::onTreeActivate ( wxDataViewEvent &  aEvent )

protected

Definition at line 460 of file lib_tree.cpp.

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

References GetSelectedLibId(), m_tree_ctrl, postSelectEvent(), and toggleExpand().

Referenced by LIB_TREE().

onTreeSelect()

void LIB_TREE::onTreeSelect ( wxDataViewEvent &  aEvent )

protected

Definition at line 453 of file lib_tree.cpp.

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

References m_tree_ctrl, and postPreselectEvent().

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 324 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 331 of file lib_tree.cpp.

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

Referenced by onQueryEnter(), and onTreeActivate().

RefreshLibTree()

void LIB_TREE::RefreshLibTree

(

)

Refreshes the tree (mainly to update highlighting and asterisking)

Definition at line 231 of file lib_tree.cpp.

{
 m_adapter->RefreshTree();
}

References m_adapter.

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

Regenerate()

void LIB_TREE::Regenerate

(

bool

aKeepState

)

Regenerate the tree.

Definition at line 213 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(), FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree(), SYMBOL_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 258 of file lib_tree.cpp.

{
 if( aTreeId.IsOk() )
 {
 m_tree_ctrl->EnsureVisible( aTreeId );
 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 190 of file lib_tree.cpp.

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

References m_adapter, and selectIfValid().

Referenced by SYMBOL_EDIT_FRAME::DuplicateSymbol(), FOOTPRINT_EDIT_FRAME::FocusOnLibID(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::Revert(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), setState(), SYMBOL_EDIT_FRAME::SyncLibraries(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), and SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties().

setState()

void LIB_TREE::setState ( const STATE &  aState )

protected

Restore the symbol tree widget state from an object.

Definition at line 356 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 246 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 202 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(), FOOTPRINT_TREE_PANE::onUpdateUI(), SYMBOL_TREE_PANE::onUpdateUI(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::SyncLibraries(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

Member Data Documentation

m_adapter

wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> LIB_TREE::m_adapter

protected

Definition at line 178 of file lib_tree.h.

Referenced by centerIfValid(), CenterLibId(), ExpandLibId(), GetCurrentTreeNode(), GetSelectedLibId(), getState(), LIB_TREE(), onContextMenu(), onPreselect(), onQueryCharHook(), RefreshLibTree(), Regenerate(), SelectLibId(), and ~LIB_TREE().

m_debounceTimer

wxTimer* LIB_TREE::m_debounceTimer

protected

Definition at line 183 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 182 of file lib_tree.h.

Referenced by LIB_TREE(), and onPreselect().

m_last_libid

LIB_ID LIB_TREE::m_last_libid

protected

Definition at line 185 of file lib_tree.h.

m_lib_table

LIB_TABLE* LIB_TREE::m_lib_table

protected

Definition at line 176 of file lib_tree.h.

m_query_ctrl

wxSearchCtrl* LIB_TREE::m_query_ctrl

protected

Definition at line 180 of file lib_tree.h.

Referenced by GetFocusTarget(), LIB_TREE(), onQueryMouseMoved(), and Regenerate().

m_tree_ctrl

wxDataViewCtrl* LIB_TREE::m_tree_ctrl

protected

Definition at line 181 of file lib_tree.h.

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

---

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

• lib_tree.h
• lib_tree.cpp