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 The 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, see <https://www.gnu.org/licenses/>.
 */

 
#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;
    wxString   m_error;
 
public:

    PROJECT_TEMPLATE( const wxString& aPath );

    ~PROJECT_TEMPLATE();

    wxString GetPrjDirName();

    wxFileName GetHtmlFile();

    bool CreateProject( wxFileName& aNewProjectPath, wxString* aErrorMsg = nullptr );

    wxBitmap* GetIcon();

    wxString* GetTitle();
 
    const wxString& GetError() const { return m_error; }

    std::vector<wxFileName> GetFileList();

    size_t GetDestinationFiles( const wxFileName& aNewProjectPath,
                                std::vector< wxFileName >& aDestFiles );
};
 

wxFileName EnsureDefaultProjectTemplate( const wxString& aBaseDir );
 
#endif