model_zones_overview.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Ethan Chien <[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, 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
 */
 
 
#pragma once
 
#include <memory>
#include <utility>
#include <vector>
#include <wx/dataview.h>
#include <wx/event.h>
#include <wx/string.h>
#include <board.h>
#include <zone.h>
#include <zone_settings_bag.h>
 
class PCB_BASE_FRAME;
class PCB_BASE_FRAME;
class MANAGED_ZONE;
 
wxDECLARE_EVENT( EVT_ZONES_OVERVIEW_COUNT_CHANGE, wxCommandEvent );
 
#define LAYER_BAR_WIDTH 16
#define LAYER_BAR_HEIGHT 16
 
 
enum class ZONE_INDEX_MOVEMENT
{
    MOVE_UP,
    MOVE_DOWN
};
 
 
class MODEL_ZONES_OVERVIEW : public wxDataViewVirtualListModel
{
public:
    enum
    {
        NAME,
        NET,
        LAYERS,
 
        COL_COUNT
    };
 
    static std::map<int, wxString> GetColumnNames()
    {
        //NOTE - Build the column name dynamicly in case the display language changed
        const std::map<int, wxString> ColNames = std::map<int, wxString>{
            std::make_pair( NAME, _( "Name" ) ),
            std::make_pair( NET, _( "Net" ) ),
            std::make_pair( LAYERS, _( "Layers" ) )
        };
        return ColNames;
    }
 
    MODEL_ZONES_OVERVIEW( wxWindow* aParent, PCB_BASE_FRAME* aFrame, ZONE_SETTINGS_BAG& aZoneSettingsBag );
 
    ~MODEL_ZONES_OVERVIEW() override = default;
 
    void EnableFitterByName( bool aEnable );
 
    void EnableFitterByNet( bool aEnable );
 
    void GetValueByRow( wxVariant& aVariant, unsigned aRow, unsigned aCol ) const override;
 
    bool SetValueByRow( const wxVariant& aVariant, unsigned aRow, unsigned aCol ) override;
 
    // returns the number of rows
    unsigned int GetCount() const override;
 
    ZONE* GetZone( wxDataViewItem const& item ) const;
 
    wxDataViewItem GetItemByZone( ZONE* ) const;

    std::optional<unsigned> MoveZoneIndex( unsigned aIndex, ZONE_INDEX_MOVEMENT aMovement );

    std::optional<unsigned> SwapZonePriority( unsigned aDragIndex, unsigned aDropIndex );

    wxDataViewItem ApplyFilter( wxString const& aFilterText, wxDataViewItem aSelection );

    wxDataViewItem ClearFilter( wxDataViewItem aSelection );
 
private:
    void SortFilteredZones();
 
    void OnRowCountChange();
 
private:
    wxWindow*          m_parent;
    PCB_BASE_FRAME*    m_frame;
    ZONE_SETTINGS_BAG& m_zoneSettingsBag;
    std::vector<ZONE*> m_filteredZones;
    bool               m_sortByName;
    bool               m_sortByNet;
};