file_checklist_ctrl.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 FILE_CHECKLIST_CTRL_H
#define FILE_CHECKLIST_CTRL_H
 
#include <map>
#include <vector>
 
#include <wx/string.h>
 
#include <bitmaps/bitmaps_list.h>
#include <widgets/wx_dataviewctrl.h>
#include <wx/colour.h>
#include <wx/event.h>
#include <kicommon.h>
 

struct KICOMMON_API FILE_CHECKLIST_ENTRY
{
    wxString section;
    wxString path;    
    wxString label;   
    wxString status;  
    wxColour statusColour; 
    BITMAPS  icon = BITMAPS::INVALID_BITMAP;
    bool     checked = false;
};
 

class KICOMMON_API FILE_CHECKLIST_DATA
{
public:
    void SetEntries( const std::vector<FILE_CHECKLIST_ENTRY>& aEntries );

    const std::vector<wxString>& Sections() const { return m_sections; }

    const std::vector<FILE_CHECKLIST_ENTRY>& Rows( const wxString& aSection ) const;
 
    void SetChecked( const wxString& aPath, bool aChecked );
    void SetSectionChecked( const wxString& aSection, bool aChecked );

    bool IsSectionChecked( const wxString& aSection ) const;

    std::vector<wxString> CheckedPaths() const;
 
private:
    std::vector<wxString>                                 m_sections;
    std::map<wxString, std::vector<FILE_CHECKLIST_ENTRY>> m_rowsBySection;
};
 
 
class FILE_CHECKLIST_MODEL;
 

class KICOMMON_API FILE_CHECKLIST_CTRL : public WX_DATAVIEWCTRL
{
public:
    FILE_CHECKLIST_CTRL( wxWindow* aParent, wxWindowID aId = wxID_ANY );
    ~FILE_CHECKLIST_CTRL() override;
 
    void SetEntries( const std::vector<FILE_CHECKLIST_ENTRY>& aEntries );
 
    void SetAllChecked( bool aChecked );
 
    std::vector<wxString> GetCheckedPaths() const;

    wxString GetItemPath( const wxDataViewItem& aItem ) const;

    void DoSetToolTipText( const wxString& aTip ) override;
 
private:
    void onIdle( wxIdleEvent& aEvent );
 
    wxObjectDataPtr<FILE_CHECKLIST_MODEL> m_model;
 
    wxString m_ownerTooltip; 
    wxString m_shownTooltip; 
};
 
#endif // FILE_CHECKLIST_CTRL_H