graphics_import_plugin.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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 GRAPHICS_IMPORT_PLUGIN_H
#define GRAPHICS_IMPORT_PLUGIN_H
 
#include <math/box2.h>
#include <wildcards_and_files_ext.h>
#include <wx/arrstr.h>
 
class GRAPHICS_IMPORTER;
 
class GRAPHICS_IMPORT_PLUGIN
{
public:
    virtual ~GRAPHICS_IMPORT_PLUGIN() { }
 
    virtual void SetImporter( GRAPHICS_IMPORTER* aImporter ) { m_importer = aImporter; }
 
    virtual const wxString GetName() const = 0;
 
    virtual const std::vector<std::string> GetFileExtensions() const = 0;
 
    wxString GetWildcards() const
    {
        wxString ret;
        bool first = true;
 
        for( const auto& extension : GetFileExtensions() )
        {
            if( first )
                first = false;
            else
                ret += wxT( ";" );
 
            ret += wxT( "*." ) + formatWildcardExt( extension );
        }
 
        return ret;
    }
 
    virtual bool Load( const wxString& aFileName ) = 0;
 
    virtual bool LoadFromMemory( const wxMemoryBuffer& aMemBuffer ) = 0;
 
    virtual double GetImageHeight() const = 0;
 
    virtual double GetImageWidth() const = 0;
 
    virtual BOX2D GetImageBBox() const = 0;
 
    virtual bool Import() = 0;
 
    virtual void SetLineWidthMM( double aLineWidth ) {}
 
    const virtual wxString& GetMessages() const = 0;
 
    virtual void ReportMsg( const wxString& aMessage ) = 0;
 
protected:
    GRAPHICS_IMPORTER* m_importer;
};
 
 
#endif /* GRAPHICS_IMPORT_PLUGIN_H */