38#include <wx/settings.h>
40#include <wx/srchctrl.h>
41#include <wx/statline.h>
42#include <wx/popupwin.h>
54 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& aAdapter,
int aFlags,
56 wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
57 wxWANTS_CHARS | wxTAB_TRAVERSAL | wxNO_BORDER ),
58 m_adapter( aAdapter ),
59 m_query_ctrl( nullptr ),
60 m_sort_ctrl( nullptr ),
61 m_details_ctrl( nullptr ),
62 m_inTimerEvent( false ),
63 m_recentSearchesKey( aRecentSearchesKey ),
64 m_filtersSizer( nullptr ),
65 m_skipNextRightClick( false ),
66 m_previewWindow( nullptr ),
67 m_previewDisabled( false )
69 wxBoxSizer* sizer =
new wxBoxSizer( wxVERTICAL );
77 wxBoxSizer* search_sizer =
new wxBoxSizer( wxHORIZONTAL );
85 search_sizer->Add(
m_query_ctrl, 1, wxALIGN_CENTER_VERTICAL|wxRIGHT, 4 );
87 wxStaticLine* separator =
new wxStaticLine(
this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_VERTICAL );
88 search_sizer->Add( separator, 0, wxEXPAND|wxTOP|wxBOTTOM, 3 );
91 wxDefaultSize, wxBU_AUTODRAW|0 );
94 [&]( wxMouseEvent& aEvent )
99 menu.Append( 4201,
_(
"Sort by Best Match" ), wxEmptyString, wxITEM_CHECK );
100 menu.Append( 4202,
_(
"Sort Alphabetically" ), wxEmptyString, wxITEM_CHECK );
101 menu.AppendSeparator();
106 menu.Check( 4201,
true );
108 menu.Check( 4202,
true );
111 int menu_id =
m_sort_ctrl->GetPopupMenuSelectionFromUser( menu );
113 if( menu_id == 0 || menu_id == 4201 )
115 m_adapter->SetSortMode( LIB_TREE_MODEL_ADAPTER::BEST_MATCH );
118 else if( menu_id == 1 || menu_id == 4202 )
120 m_adapter->SetSortMode( LIB_TREE_MODEL_ADAPTER::ALPHABETIC );
123 else if( menu_id == 3 || menu_id == 4203 )
127 else if( menu_id == 4 || menu_id == 4204 )
134 search_sizer->Add(
m_sort_ctrl, 0, wxALIGN_CENTER_VERTICAL, 5 );
136 sizer->Add( search_sizer, 0, wxEXPAND, 5 );
144#if defined( __WXOSX__ ) || wxCHECK_VERSION( 3, 3, 0 )
146 [
this]( wxMouseEvent& aEvt )
148 SetCursor( wxCURSOR_ARROW );
153 [
this]( wxCommandEvent& aEvent )
155 size_t idx = aEvent.GetId() - 1;
172 int dvFlags = ( aFlags &
MULTISELECT ) ? wxDV_MULTIPLE : wxDV_SINGLE;
178 int rowHeight = FromDIP( 6 ) + GetTextExtent( wxS(
"pdI" ) ).y;
189 wxPoint html_size = ConvertDialogToPixels( wxPoint( 80, 80 ) );
192 wxSize( html_size.x, html_size.y ) );
245 m_details_ctrl->ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
321 if(
m_adapter->GetTreeNodeFor( sel )->m_IsAlreadyPlacedGroup
322 ||
m_adapter->GetTreeNodeFor( sel )->m_IsRecentlyUsedGroup )
336 wxDataViewItemArray selection;
337 int count =
m_tree_ctrl->GetSelections( selection );
339 for(
const wxDataViewItem& item : selection )
341 aSelection.emplace_back(
m_adapter->GetAliasFor( item ) );
344 aUnit->emplace_back(
m_adapter->GetUnitFor( item ) );
363 wxDataViewItemArray selection;
364 int count =
m_tree_ctrl->GetSelections( selection );
366 for(
const wxDataViewItem& item : selection )
368 aSelection.push_back(
m_adapter->GetTreeNodeFor( item ) );
431 if( !newEntry.IsEmpty() )
434 std::erase( recents, newEntry );
439 recents.insert( recents.begin(), newEntry );
442 wxMenu* menu =
new wxMenu();
444 for(
const wxString&
recent : recents )
445 menu->Append( menu->GetMenuItemCount() + 1,
recent );
447 if( recents.empty() )
448 menu->Append( wxID_ANY,
_(
"recent searches" ) );
496 if( !aTreeId.IsOk() )
535 wxDataViewItemArray siblings;
536 m_adapter->GetChildren( wxDataViewItem( parent ), siblings );
538 int idx = siblings.Index( aTreeId );
540 if( idx + 5 < (
int) siblings.GetCount() )
542 m_tree_ctrl->EnsureVisible( siblings.Item( idx + 5 ) );
544 else if( grandParent )
546 wxDataViewItemArray parentsSiblings;
547 m_adapter->GetChildren( wxDataViewItem( grandParent ), parentsSiblings );
549 int p_idx = parentsSiblings.Index( wxDataViewItem( parent ) );
551 if( p_idx + 1 < (
int) parentsSiblings.GetCount() )
552 m_tree_ctrl->EnsureVisible( parentsSiblings.Item( p_idx + 1 ) );
556 m_tree_ctrl->EnsureVisible( siblings.Item( idx - 5 ) );
558 m_tree_ctrl->EnsureVisible( wxDataViewItem( parent ) );
568 if( aTreeId.IsOk() && !
m_tree_ctrl->IsExpanded( aTreeId ) )
575 wxCommandEvent event( EVT_LIBITEM_SELECTED );
576 wxPostEvent(
this, event );
582 wxCommandEvent event( EVT_LIBITEM_CHOSEN );
583 wxPostEvent(
this, event );
590 wxDataViewItemArray items;
591 m_adapter->GetChildren( wxDataViewItem(
nullptr ), items );
593 for(
const wxDataViewItem& item : items )
609 for(
const wxDataViewItem& item : aState.
expanded )
641 int hotkey = aKeyStroke.GetKeyCode();
643 if( aKeyStroke.GetModifiers() & wxMOD_CONTROL )
646 if( aKeyStroke.GetModifiers() & wxMOD_ALT )
649 if( aKeyStroke.GetModifiers() & wxMOD_SHIFT )
668 sel =
m_adapter->GetCurrentDataViewItem();
671 : LIB_TREE_NODE::TYPE::INVALID;
673 switch( aKeyStroke.GetKeyCode() )
688 if( type == LIB_TREE_NODE::TYPE::LIBRARY )
696 if( type == LIB_TREE_NODE::TYPE::LIBRARY )
702 case WXK_NUMPAD_ENTER:
707 else if( type == LIB_TREE_NODE::TYPE::LIBRARY )
721#if defined( __WXOSX__ ) || wxCHECK_VERSION( 3, 3, 0 )
722 wxPoint pos = aEvent.GetPosition();
724 int buttonWidth = ctrlRect.GetHeight();
726 if(
m_query_ctrl->IsSearchButtonVisible() && pos.x < buttonWidth )
727 SetCursor( wxCURSOR_ARROW );
728 else if(
m_query_ctrl->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
729 SetCursor( wxCURSOR_ARROW );
731 SetCursor( wxCURSOR_IBEAM );
736#define PREVIEW_SIZE wxSize( 240, 200 )
737#define HOVER_TIMER_MILLIS 400
742 if( aItem.IsOk() &&
m_adapter->HasPreview( aItem ) )
747 wxWindow* topLevelParent = wxGetTopLevelParent( m_parent );
781 wxWindow* topLevelParent = wxGetTopLevelParent( m_parent );
782 wxWindow* topLevelFocus = wxGetTopLevelParent( wxWindow::FindFocus() );
784 bool mouseOverWindow =
false;
785 wxPoint screenPos = wxGetMousePosition();
788 mouseOverWindow |=
m_tree_ctrl->GetScreenRect().Contains( screenPos );
797 wxPoint clientPos =
m_tree_ctrl->ScreenToClient( screenPos );
799 wxDataViewColumn* col =
nullptr;
809 if( wxGetDisplayInfo().type == wxDisplayType::wxDisplayWayland )
836 wxDataViewColumn* col =
nullptr;
857 if( aKeyStroke.GetSkipped() )
861 int hotkey = aKeyStroke.GetKeyCode();
863 if( aKeyStroke.ShiftDown() )
866 if( aKeyStroke.AltDown() )
869 if( aKeyStroke.ControlDown() )
872 if( tool->GetManager()->GetActionManager()->RunHotKey( hotkey ) )
873 aKeyStroke.Skip(
false );
907 const wxHtmlLinkInfo&
info = aEvent.GetLinkInfo();
908 wxString docname =
info.GetHref();
950 wxPoint pos =
m_tree_ctrl->ScreenToClient( wxGetMousePosition() );
953 wxDataViewColumn* col;
965 tool->GetManager()->VetoContextMenuMouseWarp();
966 tool->GetToolMenu().ShowContextMenu();
969 tool->GetManager()->DispatchContextMenu( evt );
975 if( current && current->
m_Type == LIB_TREE_NODE::TYPE::LIBRARY )
983 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
990 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
1009 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
static TOOL_ACTION pinLibrary
static TOOL_ACTION selectLibTreeColumns
static TOOL_ACTION unpinLibrary
static TOOL_ACTION expandAll
static TOOL_ACTION collapseAll
A dialog which allows selecting a list of items from a list of available items, and reordering those ...
const std::vector< wxString > & EnabledList()
Add dark theme support to wxHtmlWindow.
bool SetPage(const wxString &aSource) override
A logical library item identifier and consists of various portions much like a URI.
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
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.
void RefreshLibTree()
Refresh the tree (mainly to update highlighting and asterisking)
wxTimer * m_debounceTimer
void onHoverTimer(wxTimerEvent &aEvent)
LIB_TREE_NODE * GetCurrentTreeNode() const
Retrieve the tree node for the first selected item.
void onQueryMouseMoved(wxMouseEvent &aEvent)
wxDataViewItem m_previewItem
HTML_WINDOW * m_details_ctrl
void onTreeActivate(wxDataViewEvent &aEvent)
wxString m_recentSearchesKey
void onQueryCharHook(wxKeyEvent &aEvent)
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
void postSelectEvent()
Post #SYMBOL_SELECTED event to notify the selection handler that a part has been selected.
wxWindow * GetFocusTarget()
void onItemContextMenu(wxDataViewEvent &aEvent)
void ShowChangedLanguage()
WX_DATAVIEWCTRL * m_tree_ctrl
void onQueryText(wxCommandEvent &aEvent)
void toggleExpand(const wxDataViewItem &aTreeId)
Expand or collapse a node, switching it to the opposite state.
int GetSelectedTreeNodes(std::vector< LIB_TREE_NODE * > &aSelection) const
Retrieve a list of pointers to selected tree nodes for trees that allow multi-selection.
bool m_skipNextRightClick
void selectIfValid(const wxDataViewItem &aTreeId)
If a wxDataViewitem is valid, select it and post a selection event.
void onIdle(wxIdleEvent &aEvent)
void FocusSearchFieldIfExists()
Focus the search widget if it exists.
void expandIfValid(const wxDataViewItem &aTreeId)
void onPreselect(wxCommandEvent &aEvent)
wxPopupWindow * m_previewWindow
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
void updateRecentSearchMenu()
void showPreview(wxDataViewItem aItem)
wxString GetSearchString() const
void onTreeSelect(wxDataViewEvent &aEvent)
int GetSelectedLibIds(std::vector< LIB_ID > &aSelection, std::vector< int > *aUnit=nullptr) const
Retrieve a list of selections for trees that allow multi-selection.
void postPreselectEvent()
Post a wxEVT_DATAVIEW_SELECTION_CHANGED to notify the selection handler that a new part has been pres...
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
BITMAP_BUTTON * m_sort_ctrl
void onTreeCharHook(wxKeyEvent &aEvent)
void onDetailsLink(wxHtmlLinkEvent &aEvent)
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit,...
wxBoxSizer * m_filtersSizer
wxDataViewItem m_hoverItem
void SetSearchString(const wxString &aSearchString)
Save/restore search string.
void setState(const STATE &aState)
Restore the symbol tree widget state from an object.
STATE getState() const
Return the symbol tree widget state.
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
wxSearchCtrl * m_query_ctrl
void centerIfValid(const wxDataViewItem &aTreeId)
void onDebounceTimer(wxTimerEvent &aEvent)
void onHeaderContextMenu(wxDataViewEvent &aEvent)
void Regenerate(bool aKeepState)
Regenerate the tree.
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
virtual SETTINGS_MANAGER & GetSettingsManager() const
Container for project specific data.
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
Extension of the wxDataViewCtrl to include some helper functions for working with items.
wxDataViewItem GetNextItem(wxDataViewItem const &aItem)
Get the next item in list order.
wxDataViewItem GetPrevItem(wxDataViewItem const &aItem)
Get the previous item in list order.
bool GetAssociatedDocument(wxWindow *aParent, const wxString &aDocName, PROJECT *aProject, SEARCH_STACK *aPaths, std::vector< EMBEDDED_FILES * > aFilesStack)
Open a document (file) with the suitable browser.
This file is part of the common library.
#define HOVER_TIMER_MILLIS
constexpr int RECENT_SEARCHES_MAX
std::map< wxString, std::vector< wxString > > g_recentSearches
wxDEFINE_EVENT(EVT_LIBITEM_SELECTED, wxCommandEvent)
This file contains miscellaneous commonly used macros and functions.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
PGM_BASE & Pgm()
The global program "get" accessor.
Structure storing state of the symbol tree widget.
LIB_ID selection
Current selection, might be not valid if nothing was selected.
std::vector< wxDataViewItem > expanded
List of expanded nodes.