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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LIB_TREE_H
#define LIB_TREE_H
 
#include <wx/panel.h>
#include <wx/sizer.h>
#include <lib_tree_model_adapter.h>
#include <widgets/html_window.h>
#include <widgets/wx_dataviewctrl.h>
#include <widgets/wx_debounced_action.h>
 
class wxTextCtrl;
class wxHtmlLinkEvent;
class wxSearchCtrl;
class wxPopupWindow;
class BITMAP_BUTTON;
class STD_BITMAP_BUTTON;
class ACTION_MENU;
class LIB_ID;

class LIB_TREE : public wxPanel
{
public:
    enum FLAGS
    {
        FLAGS_NONE  = 0x00,
        SEARCH      = 0x01,
        FILTERS     = 0x02,
        DETAILS     = 0x04,
        ALL_WIDGETS = 0x0F,
        MULTISELECT = 0x10
    };

    LIB_TREE( wxWindow* aParent, const wxString& aRecentSearchesKey,
              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;

    int GetSelectedTreeNodes( std::vector<LIB_TREE_NODE*>& aSelection ) const;

    void SelectLibId( const LIB_ID& aLibId );

    void CenterLibId( const LIB_ID& aLibId );

    void Unselect();

    void ExpandLibId( const LIB_ID& aLibId );
 
    std::vector<LIB_ID> GetExpandedLibraries() const;
 
    void ExpandAll();
    void CollapseAll();

    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();
 
    wxSizer* GetFiltersSizer() { return m_filtersSizer; }

    void FocusSearchFieldIfExists();
 
    void ShowChangedLanguage();
 
    void BlockPreview( bool aBlock )
    {
        m_previewDisabled = aBlock;
    }
 
    void ShutdownPreviews();
 
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;

        LIB_ID selection;
 
        VECTOR2I scrollpos;
    };

    STATE getState() const;

    void setState( const STATE& aState );
 
    void updateRecentSearchMenu();
 
    void showPreview( wxDataViewItem aItem );
    void hidePreview();
 
    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 onIdle( wxIdleEvent& aEvent );
 
    void onDetailsLink( wxHtmlLinkEvent& aEvent );
    void onPreselect( wxCommandEvent& aEvent );
    void onItemContextMenu( wxDataViewEvent& aEvent );
    void onHeaderContextMenu( wxDataViewEvent& aEvent );

    void onQueryDebounce();

    void onHoverPreview();
 
protected:
    wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
 
    wxSearchCtrl*      m_query_ctrl;
    BITMAP_BUTTON*     m_sort_ctrl;
    WX_DATAVIEWCTRL*   m_tree_ctrl;
    HTML_WINDOW*       m_details_ctrl;
    bool               m_inTimerEvent;
 
    wxString           m_recentSearchesKey;
 
    wxBoxSizer*        m_filtersSizer;
 
    bool               m_skipNextRightClick;
 
    wxPoint            m_hoverPos;
    wxDataViewItem     m_hoverItem;
    wxRect             m_hoverItemRect;

    WX_DEBOUNCED_ACTION m_queryDebounce;

    WX_DEBOUNCED_ACTION m_hoverDebounce;
 
    wxDataViewItem     m_previewItem;
    wxRect             m_previewItemRect;
    wxPopupWindow*     m_previewWindow;
    bool               m_previewDisabled;
};

wxDECLARE_EVENT( EVT_LIBITEM_SELECTED, wxCommandEvent );

wxDECLARE_EVENT( EVT_LIBITEM_CHOSEN, wxCommandEvent );
 
#endif /* LIB_TREE_H */