project_template.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Brian Sidebotham <[email protected]>
 * Copyright (C) 1992-2017 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 PROJECT_TEMPLATE_H
#define PROJECT_TEMPLATE_H
 
 
#include <vector>
 
#include <wx/filename.h>
#include <wx/intl.h>
 
 
class wxBitmap;
class wxFileName;
 
#define METADIR             wxT( "meta" )
 
 
#define METAFILE_INFO_HTML  wxT( "info.html" )
 
 
#define METAFILE_ICON       wxT( "icon.png" )
 
class PROJECT_TEMPLATE
{
protected:
    wxFileName m_basePath;
    wxFileName m_metaPath;
    wxFileName m_metaHtmlFile;
    wxFileName m_metaIconFile;
    wxBitmap*  m_metaIcon;
    wxString   m_title;
 
public:
 
    PROJECT_TEMPLATE( const wxString& aPath );
 
    ~PROJECT_TEMPLATE();
 
    wxString GetPrjDirName();
 
    wxFileName GetHtmlFile();
 
    bool CreateProject( wxFileName& aNewProjectPath, wxString* aErrorMsg = nullptr );
 
    wxBitmap* GetIcon();
 
    wxString* GetTitle();
 
    std::vector<wxFileName> GetFileList();
 
    size_t GetDestinationFiles( const wxFileName& aNewProjectPath,
                                std::vector< wxFileName >& aDestFiles );
};
 
#endif