footprint_wizard.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 NBEE Embedded Systems SL, Miguel Angel Ajo <miguelangel@ajo.es>
 * Copyright (C) 2013-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 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
 */


#ifndef FOOTPRINT_WIZARD_H
#define FOOTPRINT_WIZARD_H

#include <vector>
#include <pcb_edit_frame.h>

// Allowable parameter types for PCB wizards
const wxString WIZARD_PARAM_UNITS_MM        = "mm";          // Millimetres
const wxString WIZARD_PARAM_UNITS_MILS      = "mils";        // Mils / thou
const wxString WIZARD_PARAM_UNITS_FLOAT     = "float";       // Floating point (dimensionless)
const wxString WIZARD_PARAM_UNITS_INTEGER   = "integer";     // Integer (dimensionless)
const wxString WIZARD_PARAM_UNITS_BOOL      = "bool";        // Boolean option
const wxString WIZARD_PARAM_UNITS_RADIANS   = "radians";     // Angle (radians)
const wxString WIZARD_PARAM_UNITS_DEGREES   = "degrees";     // Angle (degrees)
const wxString WIZARD_PARAM_UNITS_PERCENT   = "%";           // Percent (0% -> 100%)
const wxString WIZARD_PARAM_UNITS_STRING    = "string";      // String

class FOOTPRINT_WIZARD
{
public:
    FOOTPRINT_WIZARD() {}
    virtual ~FOOTPRINT_WIZARD();

    virtual wxString GetName() = 0;

    virtual wxString GetImage() = 0;

    virtual wxString GetDescription() = 0;

    virtual int GetNumParameterPages() = 0;

    virtual wxString GetParameterPageName( int aPage ) = 0;

    virtual wxArrayString GetParameterNames( int aPage ) = 0;

    virtual wxArrayString GetParameterTypes( int aPage ) = 0;


    virtual wxArrayString GetParameterValues( int aPage ) = 0;

    virtual wxArrayString GetParameterErrors( int aPage ) = 0;

    virtual wxArrayString GetParameterHints( int aPage ) = 0;

    virtual wxArrayString GetParameterDesignators( int aPage ) = 0;

    virtual wxString SetParameterValues( int aPage, wxArrayString& aValues ) = 0;

    virtual void ResetParameters() = 0;

    virtual FOOTPRINT* GetFootprint( wxString* aMessage ) = 0;

    virtual void* GetObject() = 0;

    void register_wizard();
};


class FOOTPRINT_WIZARD_LIST
{
public:

    static void                 register_wizard( FOOTPRINT_WIZARD* aWizard );

    static bool                 deregister_object( void* aObject );

    static FOOTPRINT_WIZARD*    GetWizard( const wxString& aName );

    static FOOTPRINT_WIZARD*    GetWizard( int aIndex );

    static int                  GetWizardsCount();

private:
    static std::vector<FOOTPRINT_WIZARD*> m_FootprintWizards;
};

#endif /* PCBNEW_FOOTPRINT_WIZARDS_H */