7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-22 11:14:59 +00:00
kicad/pcbnew/dialogs/dialog_map_layers.h
Jeff Young 14a55facf2 Clearer naming and commenting.
Also some const& hygiene and some formatting.
2024-06-25 11:07:14 +01:00

81 lines
3.2 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Roberto Fernandez Bautista <roberto.fer.bau@gmail.com>
* Copyright (C) 2020-2021 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 <http://www.gnu.org/licenses/>.
*/
#ifndef DIALOG_IMPORTED_LAYERS_H
#define DIALOG_IMPORTED_LAYERS_H
#include <dialog_imported_layers_base.h>
#include <pcb_io/common/plugin_common_layer_mapping.h>
class DIALOG_MAP_LAYERS : public DIALOG_IMPORTED_LAYERS_BASE
{
public:
DIALOG_MAP_LAYERS( wxWindow* aParent, const std::vector<INPUT_LAYER_DESC>& aLayerDesc );
/**
* Return a list of layers names that are required, but they are not mapped.
*/
std::vector<wxString> GetUnmappedRequiredLayers() const;
/**
* Create and show a dialog (modal) and returns the data from it after completion. If the
* dialog is closed or cancel is pressed, returns an empty map.
*
* @param aParent Parent window for the invoked dialog.
* @param aLayerDesc
* @return Mapped layers
*/
static std::map<wxString, PCB_LAYER_ID> RunModal( wxWindow* aParent,
const std::vector<INPUT_LAYER_DESC>& aLayerDesc );
private:
//Helper functions
PCB_LAYER_ID GetSelectedLayerID();
PCB_LAYER_ID GetAutoMatchLayerID( const wxString& aInputLayerName );
void AddMappings();
void RemoveMappings( int aStatus );
void DeleteListItems( const wxArrayInt& aRowsToDelete, wxListCtrl* aListCtrl );
const INPUT_LAYER_DESC* GetLayerDescription( const wxString& aLayerName ) const;
static wxString WrapRequired( const wxString& aLayerName );
static wxString UnwrapRequired( const wxString& aLayerName );
//Event Handlers
void OnAutoMatchLayersClicked( wxCommandEvent& event ) override;
void OnUnMatchedDoubleClick( wxListEvent& event ) override { AddMappings(); }
void OnAddClicked( wxCommandEvent& event ) override { AddMappings(); }
void OnMatchedDoubleClick( wxListEvent& event ) override { RemoveMappings( selected ); }
void OnRemoveClicked( wxCommandEvent& event ) override { RemoveMappings( selected ); }
void OnRemoveAllClicked( wxCommandEvent& event ) override { RemoveMappings( allitems ); }
const int selected = wxLIST_STATE_SELECTED;
const int allitems = wxLIST_STATE_DONTCARE;
std::vector<INPUT_LAYER_DESC> m_input_layers;
std::vector<wxString> m_unmatched_layer_names;
std::map<wxString, PCB_LAYER_ID> m_matched_layers_map;
};
#endif // DIALOG_IMPORTED_LAYERS_H