37#include <wx/settings.h>
39#include <wx/srchctrl.h>
40#include <wx/popupwin.h>
52 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& aAdapter,
int aFlags,
54 wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
55 wxWANTS_CHARS | wxTAB_TRAVERSAL | wxNO_BORDER ),
56 m_adapter( aAdapter ),
57 m_query_ctrl( nullptr ),
58 m_sort_ctrl( nullptr ),
59 m_details_ctrl( nullptr ),
60 m_inTimerEvent( false ),
61 m_recentSearchesKey( aRecentSearchesKey ),
62 m_filtersSizer( nullptr ),
63 m_skipNextRightClick( false ),
64 m_previewWindow( nullptr ),
65 m_previewDisabled( false )
67 wxBoxSizer* sizer =
new wxBoxSizer( wxVERTICAL );
75 wxBoxSizer* search_sizer =
new wxBoxSizer( wxHORIZONTAL );
84 m_query_ctrl->SetMinSize( wxSize( -1, GetTextExtent( wxT(
"qb" ) ).y + 10 ) );
89 search_sizer->Add(
m_query_ctrl, 1, wxEXPAND | wxRIGHT, 5 );
92 wxDefaultSize, wxBU_AUTODRAW|0 );
95 [&]( wxMouseEvent& aEvent )
100 menu.Append( 4201,
_(
"Sort by Best Match" ), wxEmptyString, wxITEM_CHECK );
101 menu.Append( 4202,
_(
"Sort Alphabetically" ), wxEmptyString, wxITEM_CHECK );
102 menu.AppendSeparator();
107 menu.Check( 4201,
true );
109 menu.Check( 4202,
true );
112 int menu_id =
m_sort_ctrl->GetPopupMenuSelectionFromUser( menu );
114 if( menu_id == 0 || menu_id == 4201 )
116 m_adapter->SetSortMode( LIB_TREE_MODEL_ADAPTER::BEST_MATCH );
119 else if( menu_id == 1 || menu_id == 4202 )
121 m_adapter->SetSortMode( LIB_TREE_MODEL_ADAPTER::ALPHABETIC );
124 else if( menu_id == 3 || menu_id == 4203 )
128 else if( menu_id == 4 || menu_id == 4204 )
138 sizer->Add( search_sizer, 0, wxEXPAND | wxBOTTOM, 5 );
146#if defined( __WXOSX__ ) || wxCHECK_VERSION( 3, 3, 0 )
148 [
this]( wxMouseEvent& aEvt )
150 SetCursor( wxCURSOR_ARROW );
155 [
this]( wxCommandEvent& aEvent )
158 size_t idx = aEvent.GetId() - 1;
175 int dvFlags = ( aFlags &
MULTISELECT ) ? wxDV_MULTIPLE : wxDV_SINGLE;
181 int rowHeight = FromDIP( 8 ) + GetTextExtent( wxS(
"pdI" ) ).y;
192 wxPoint html_size = ConvertDialogToPixels( wxPoint( 80, 80 ) );
195 wxSize( html_size.x, html_size.y ) );
248 m_details_ctrl->ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
317 wxDataViewItemArray selection;
318 int count =
m_tree_ctrl->GetSelections( selection );
320 for(
const wxDataViewItem& item : selection )
322 aSelection.emplace_back(
m_adapter->GetAliasFor( item ) );
325 aUnit->emplace_back(
m_adapter->GetUnitFor( item ) );
399 if( !newEntry.IsEmpty() )
407 recents.insert( recents.begin(), newEntry );
410 wxMenu* menu =
new wxMenu();
412 for(
const wxString&
recent : recents )
413 menu->Append( menu->GetMenuItemCount() + 1,
recent );
415 if( recents.empty() )
416 menu->Append( wxID_ANY,
_(
"recent searches" ) );
464 if( !aTreeId.IsOk() )
503 wxDataViewItemArray siblings;
504 m_adapter->GetChildren( wxDataViewItem( parent ), siblings );
506 int idx = siblings.Index( aTreeId );
508 if( idx + 5 < (
int) siblings.GetCount() )
510 m_tree_ctrl->EnsureVisible( siblings.Item( idx + 5 ) );
512 else if( grandParent )
514 wxDataViewItemArray parentsSiblings;
515 m_adapter->GetChildren( wxDataViewItem( grandParent ), parentsSiblings );
517 int p_idx = parentsSiblings.Index( wxDataViewItem( parent ) );
519 if( p_idx + 1 < (
int) parentsSiblings.GetCount() )
520 m_tree_ctrl->EnsureVisible( parentsSiblings.Item( p_idx + 1 ) );
524 m_tree_ctrl->EnsureVisible( siblings.Item( idx - 5 ) );
526 m_tree_ctrl->EnsureVisible( wxDataViewItem( parent ) );
536 if( aTreeId.IsOk() && !
m_tree_ctrl->IsExpanded( aTreeId ) )
543 wxCommandEvent event( EVT_LIBITEM_SELECTED );
544 wxPostEvent(
this, event );
550 wxCommandEvent event( EVT_LIBITEM_CHOSEN );
551 wxPostEvent(
this, event );
558 wxDataViewItemArray items;
559 m_adapter->GetChildren( wxDataViewItem(
nullptr ), items );
561 for(
const wxDataViewItem& item : items )
577 for(
const wxDataViewItem& item : aState.
expanded )
609 int hotkey = aKeyStroke.GetKeyCode();
611 if( aKeyStroke.GetModifiers() & wxMOD_CONTROL )
614 if( aKeyStroke.GetModifiers() & wxMOD_ALT )
617 if( aKeyStroke.GetModifiers() & wxMOD_SHIFT )
636 sel =
m_adapter->GetCurrentDataViewItem();
640 switch( aKeyStroke.GetKeyCode() )
655 if( type == LIB_TREE_NODE::TYPE::LIBRARY )
663 if( type == LIB_TREE_NODE::TYPE::LIBRARY )
669 case WXK_NUMPAD_ENTER:
674 else if( type == LIB_TREE_NODE::TYPE::LIBRARY )
688#if defined( __WXOSX__ ) || wxCHECK_VERSION( 3, 3, 0 )
689 wxPoint pos = aEvent.GetPosition();
691 int buttonWidth = ctrlRect.GetHeight();
693 if(
m_query_ctrl->IsSearchButtonVisible() && pos.x < buttonWidth )
694 SetCursor( wxCURSOR_ARROW );
695 else if(
m_query_ctrl->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
696 SetCursor( wxCURSOR_ARROW );
698 SetCursor( wxCURSOR_IBEAM );
703#define PREVIEW_SIZE wxSize( 240, 200 )
704#define HOVER_TIMER_MILLIS 400
709 if( aItem.IsOk() &&
m_adapter->HasPreview( aItem ) )
714 wxWindow* topLevelParent = wxGetTopLevelParent( m_parent );
760 wxWindow* topLevelParent = wxGetTopLevelParent( m_parent );
761 wxWindow* topLevelFocus = wxGetTopLevelParent( wxWindow::FindFocus() );
763 bool mouseOverWindow =
false;
764 wxPoint screenPos = wxGetMousePosition();
767 mouseOverWindow |=
m_tree_ctrl->GetScreenRect().Contains( screenPos );
776 wxPoint clientPos =
m_tree_ctrl->ScreenToClient( screenPos );
778 wxDataViewColumn* col =
nullptr;
788 if( wxGetDisplayInfo().type == wxDisplayType::wxDisplayWayland )
818 wxDataViewColumn* col =
nullptr;
839 if( aKeyStroke.GetSkipped() )
843 int hotkey = aKeyStroke.GetKeyCode();
845 if( aKeyStroke.ShiftDown() )
848 if( aKeyStroke.AltDown() )
851 if( aKeyStroke.ControlDown() )
854 if( tool->GetManager()->GetActionManager()->RunHotKey( hotkey ) )
855 aKeyStroke.Skip(
false );
889 const wxHtmlLinkInfo&
info = aEvent.GetLinkInfo();
890 wxString docname =
info.GetHref();
932 wxPoint pos =
m_tree_ctrl->ScreenToClient( wxGetMousePosition() );
935 wxDataViewColumn* col;
947 tool->GetManager()->VetoContextMenuMouseWarp();
948 tool->GetToolMenu().ShowContextMenu();
951 tool->GetManager()->DispatchContextMenu( evt );
957 if( current && current->
m_Type == LIB_TREE_NODE::TYPE::LIBRARY )
965 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
972 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
991 if( GetPopupMenuSelectionFromUser( menu ) != wxID_NONE )
997 if( dlg.ShowModal() == wxID_OK )
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap)
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()
Refreshes the tree (mainly to update highlighting and asterisking)
wxTimer * m_debounceTimer
void onHoverTimer(wxTimerEvent &aEvent)
LIB_TREE_NODE * GetCurrentTreeNode() const
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.
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
Retrieves 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.
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)
STD_BITMAP_BUTTON * m_sort_ctrl
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, EMBEDDED_FILES *aFiles)
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.
void delete_matching(_Container &__c, _Value __value)
Covers for the horrifically named std::remove and std::remove_if (neither of which remove anything).
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.
std::vector< wxDataViewItem > expanded
< List of expanded nodes