wx_dataviewctrl.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 3 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 WX_DATAVIEWCTRL_H_
#define WX_DATAVIEWCTRL_H_
 
#include <functional>
#include <utility>
 
#include <kicommon.h>
#include <wx/dataview.h>

class WX_ENSURE_VISIBLE_CANCELLER : public wxDataViewModelNotifier
{
public:
    explicit WX_ENSURE_VISIBLE_CANCELLER( std::function<void()> aOnItemsRemoved ) :
            m_onItemsRemoved( std::move( aOnItemsRemoved ) )
    {
    }
 
    bool ItemAdded( const wxDataViewItem&, const wxDataViewItem& ) override { return true; }
    bool ItemChanged( const wxDataViewItem& ) override { return true; }
    bool ValueChanged( const wxDataViewItem&, unsigned int ) override { return true; }
    void Resort() override {}
 
    bool ItemDeleted( const wxDataViewItem&, const wxDataViewItem& ) override
    {
        m_onItemsRemoved();
        return true;
    }
 
    bool ItemsDeleted( const wxDataViewItem&, const wxDataViewItemArray& ) override
    {
        m_onItemsRemoved();
        return true;
    }
 
    // BeforeReset fires while items are still live; Cleared covers AfterReset and direct clears.
    bool BeforeReset() override
    {
        m_onItemsRemoved();
        return true;
    }
 
    bool Cleared() override
    {
        m_onItemsRemoved();
        return true;
    }
 
private:
    std::function<void()> m_onItemsRemoved;
};
 

class KICOMMON_API WX_DATAVIEWCTRL : public wxDataViewCtrl
{
public:
    // Just take all constructors
    using wxDataViewCtrl::wxDataViewCtrl;
 
    ~WX_DATAVIEWCTRL() override;

    bool AssociateModel( wxDataViewModel* aModel ) override;

    wxDataViewItem GetPrevItem( wxDataViewItem const& aItem );

    wxDataViewItem GetNextItem( wxDataViewItem const& aItem );

    wxDataViewItem GetPrevSibling( wxDataViewItem const& aItem );

    wxDataViewItem GetNextSibling( wxDataViewItem const& aItem );
 
    void DoSetToolTipText( const wxString &tip ) override {}
 
    void ExpandAll();
    void CollapseAll();

    void CancelPendingEnsureVisible();
 
private:
    // Owned by the associated model; null when no model is associated.
    wxDataViewModelNotifier* m_ensureVisibleCanceller = nullptr;
};
 

inline void EnsureVisibleIfEnabled( wxDataViewCtrl* aWidget, const wxDataViewItem& aItem )
{
    if( aItem.IsOk() && aWidget->IsEnabled() )
        aWidget->EnsureVisible( aItem );
}
 
#endif // WX_DATAVIEWCTRL_H_