lib_tree.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 Henner Zeller <[email protected]>
 * Copyright (C) 2014-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef LIB_TREE_H
#define LIB_TREE_H
 
#include <wx/panel.h>
#include <lib_tree_model_adapter.h>
#include <html_window.h>
#include <widgets/wx_dataviewctrl.h>
 
class wxTextCtrl;
class wxHtmlLinkEvent;
class wxSearchCtrl;
class wxTimer;
class wxTimerEvent;
class STD_BITMAP_BUTTON;
class ACTION_MENU;
class LIB_ID;
class LIB_TABLE;
 
class LIB_TREE : public wxPanel
{
public:
 enum FLAGS
 {
 NONE = 0x00,
 SEARCH = 0x01,
 DETAILS = 0x02,
 ALL_WIDGETS = 0x0F,
 MULTISELECT = 0x10
 };
 
 LIB_TREE( wxWindow* aParent, const wxString& aRecentSearchesKey, LIB_TABLE* aLibTable,
 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& aAdapter, int aFlags = ALL_WIDGETS,
 HTML_WINDOW* aDetails = nullptr );
 
 ~LIB_TREE() override;
 
 LIB_ID GetSelectedLibId( int* aUnit = nullptr ) const;
 
 int GetSelectionCount() const
 {
 return m_tree_ctrl->GetSelectedItemsCount();
 }
 
 int GetSelectedLibIds( std::vector<LIB_ID>& aSelection,
 std::vector<int>* aUnit = nullptr ) const;
 
 LIB_TREE_NODE* GetCurrentTreeNode() const;
 
 void SelectLibId( const LIB_ID& aLibId );
 
 void CenterLibId( const LIB_ID& aLibId );
 
 void Unselect();
 
 void ExpandLibId( const LIB_ID& aLibId );
 
 void SetSearchString( const wxString& aSearchString );
 wxString GetSearchString() const;
 
 void SetSortMode( LIB_TREE_MODEL_ADAPTER::SORT_MODE aMode ) { m_adapter->SetSortMode( aMode ); }
 LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const { return m_adapter->GetSortMode(); }
 
 void Regenerate( bool aKeepState );
 
 void RefreshLibTree();
 
 wxWindow* GetFocusTarget();
 
 void FocusSearchFieldIfExists();
 
 void ShowChangedLanguage();
 
protected:
 void toggleExpand( const wxDataViewItem& aTreeId );
 
 void selectIfValid( const wxDataViewItem& aTreeId );
 
 void centerIfValid( const wxDataViewItem& aTreeId );
 
 void expandIfValid( const wxDataViewItem& aTreeId );
 
 void postPreselectEvent();
 
 void postSelectEvent();
 
 struct STATE
 {
 std::vector<wxDataViewItem> expanded;
 std::vector<wxString> pinned;
 
 LIB_ID selection;
 };
 
 STATE getState() const;
 
 void setState( const STATE& aState );
 
 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:
 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
 
 wxSearchCtrl* m_query_ctrl;
 STD_BITMAP_BUTTON* m_sort_ctrl;
 WX_DATAVIEWCTRL* 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;
};
 
wxDECLARE_EVENT( SYMBOL_PRESELECTED, wxCommandEvent );
 
wxDECLARE_EVENT( SYMBOL_SELECTED, wxCommandEvent );
 
#endif /* LIB_TREE_H */