kicad/pcbnew/tools/size_menu.h

73 lines
2.4 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015-2017 CERN
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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/>.
*/
#include <tool/context_menu.h>
class BOARD;
class BOARD_DESIGN_SETTINGS;
/**
* @brief Context menu that displays track and/or via sizes basing on the board design settings
* of a BOARD object.
*/
class TRACK_VIA_SIZE_MENU : public CONTEXT_MENU
{
public:
/**
* Constructor.
* @param aTrackSizes decides if the context menu should contain track sizes.
* @param aViaSizes decides if the context menu should contain via sizes.
*/
TRACK_VIA_SIZE_MENU( bool aTrackSizes, bool aViaSizes );
virtual ~TRACK_VIA_SIZE_MENU() {}
/**
* Function AppendSizes()
* Appends the list of tracks/vias (depending on the parameters passed to the constructor).
* @param aBoard is the BOARD object whose board settings will be used to generate the list.
*/
virtual void AppendSizes( const BOARD* aBoard );
virtual CONTEXT_MENU* create() const override
{
return new TRACK_VIA_SIZE_MENU( m_tracks, m_vias );
}
protected:
virtual void update() override;
///> Generates a description string for track size from BOARD_DESIGN_SETTINGS list
wxString getTrackDescription( unsigned int aIndex ) const;
///> Generates a description string for via size from BOARD_DESIGN_SETTINGS list
wxString getViaDescription( unsigned int aIndex ) const;
///> Source of information about track/via sizes
const BOARD_DESIGN_SETTINGS* m_designSettings;
///> Whether the generated menu should contain track sizes.
bool m_tracks;
///> Whether the generated menu should contain via sizes.
bool m_vias;
};