listboxes.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 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 LISTBOXES_H
#define LISTBOXES_H
 
#include <wx/listctrl.h>
#include <footprint_filter.h>
#include <memory>
 
/*  Forward declarations of all top-level window classes. */
class CVPCB_MAINFRAME;
class COMPONENT;
class FOOTPRINT_LIST;
 
#define LISTBOX_STYLE     ( wxBORDER_NONE | wxLC_NO_HEADER | wxLC_REPORT | wxLC_VIRTUAL | \
                            wxVSCROLL | wxHSCROLL )

class ITEMS_LISTBOX_BASE : public wxListView
{
public:
    ITEMS_LISTBOX_BASE( CVPCB_MAINFRAME* aParent, wxWindowID aId,
                        const wxPoint& aLocation = wxDefaultPosition,
                        const wxSize& aSize = wxDefaultSize, long aStyle = 0 );
 
    virtual ~ITEMS_LISTBOX_BASE() = default;

    int GetSelection();

    void DeselectAll();
 
    virtual CVPCB_MAINFRAME* GetParent() const;

    void UpdateWidth( int aLine = -1 );
 
    void Shutdown() { m_isClosing = true; }
 
private:
    void UpdateLineWidth( unsigned aLine, wxClientDC& dc );
 
protected:
    bool m_isClosing;
 
private:
    int  m_columnWidth;
};
 
 
class FOOTPRINTS_LISTBOX : public ITEMS_LISTBOX_BASE
{
public:
    enum FP_FILTER_T: int
    {
        UNFILTERED_FP_LIST                = 0,
        FILTERING_BY_COMPONENT_FP_FILTERS = 0x0001,
        FILTERING_BY_PIN_COUNT            = 0x0002,
        FILTERING_BY_LIBRARY              = 0x0004
    };
 
    FOOTPRINTS_LISTBOX( CVPCB_MAINFRAME* parent, wxWindowID id );
    virtual ~FOOTPRINTS_LISTBOX() = default;
 
    int      GetCount();
    void     SetSelection( int aIndex, bool aState = true );
    void     SetSelectedFootprint( const LIB_ID& aFPID );
    void     SetString( unsigned linecount, const wxString& text );

    void     SetFootprints( FOOTPRINT_LIST& aList, const wxString& aLibName, COMPONENT* aComponent,
                            const wxString& aFootPrintFilterPattern, int aFilterType );
 
    wxString GetSelectedFootprint();

    wxString OnGetItemText( long item, long column ) const override;
 
    // Events functions:
    void     OnLeftClick( wxListEvent& event );
    void     OnLeftDClick( wxListEvent& event );
    void     OnChar( wxKeyEvent& event );
 
    DECLARE_EVENT_TABLE();
 
private:
    wxArrayString  m_footprintList;
};
 
 
class LIBRARY_LISTBOX : public ITEMS_LISTBOX_BASE
{
public:
    LIBRARY_LISTBOX( CVPCB_MAINFRAME* parent, wxWindowID id );
    virtual ~LIBRARY_LISTBOX() = default;
 
    int      GetCount();
    void     SetSelection( int index, bool State = true );
    void     SetString( unsigned linecount, const wxString& text );
    void     AppendLine( const wxString& text );
    void     Finish();
    void     ClearList();
 
    wxString GetSelectedLibrary();
    wxString OnGetItemText( long item, long column ) const override;
 
    void     OnSelectLibrary( wxListEvent& event );

    void     OnChar( wxKeyEvent& event );
 
    DECLARE_EVENT_TABLE();
 
private:
    wxArrayString  m_libraryList;
};
 
 
class SYMBOLS_LISTBOX : public ITEMS_LISTBOX_BASE
{
public:
    SYMBOLS_LISTBOX( CVPCB_MAINFRAME* parent, wxWindowID id );
    virtual ~SYMBOLS_LISTBOX() = default;
 
    void     Clear();
    int      GetCount();

    wxString OnGetItemText( long item, long column ) const override;
    wxListItemAttr* OnGetItemAttr( long item) const override;
 
    /*
     * Enable or disable an item
     */
    void     SetSelection( int index, bool State = true );
    void     SetString( unsigned linecount, const wxString& text );
    void     AppendLine( const wxString& text );
    void     AppendWarning( int index );
    void     RemoveWarning( int index );
 
    // Events functions:

    void     OnChar( wxKeyEvent& event );
 
    void     OnSelectComponent( wxListEvent& event );
 
    DECLARE_EVENT_TABLE();
 
public:
    wxArrayString                   m_SymbolList;
 
private:
    std::vector<long>               m_symbolWarning;
    std::unique_ptr<wxListItemAttr> m_warningAttr;
};
 
 
#endif  //#ifndef LISTBOXES_H