#include <vector>
#include <wx/filename.h>
#include <wx/intl.h>

Classes
class	PROJECT_TEMPLATE
	A class which provides project template functionality. More...

Macros
#define	METADIR wxT( "meta" )
	A directory which contains information about the project template and does not get copied.

#define	METAFILE_INFO_HTML wxT( "info.html" )
	A required html formatted file which contains information about the project template.

#define	METAFILE_ICON wxT( "icon.png" )
	An optional png icon, exactly 64px x 64px which is used in the template selector if present.

Functions
wxFileName	EnsureDefaultProjectTemplate (const wxString &aBaseDir)
	Seed the built-in "default" project template under aBaseDir, creating the directory tree and minimal metadata (meta/info.html) and project (default.kicad_pro) files when they are missing.

Macro Definition Documentation

◆ METADIR

#define METADIR wxT( "meta" )

A directory which contains information about the project template and does not get copied.

This define is the default filename for this directory

Definition at line 118 of file project_template.h.

Referenced by DIALOG_TEMPLATE_SELECTOR::BuildTemplateList(), EnsureDefaultProjectTemplate(), and PROJECT_TEMPLATE::PROJECT_TEMPLATE().

◆ METAFILE_ICON

#define METAFILE_ICON wxT( "icon.png" )

An optional png icon, exactly 64px x 64px which is used in the template selector if present.

This define is the default filename for this file

Definition at line 134 of file project_template.h.

Referenced by PROJECT_TEMPLATE::PROJECT_TEMPLATE().

◆ METAFILE_INFO_HTML

#define METAFILE_INFO_HTML wxT( "info.html" )

A required html formatted file which contains information about the project template.

This define is the default filename for this file

Definition at line 126 of file project_template.h.

Referenced by EnsureDefaultProjectTemplate(), and PROJECT_TEMPLATE::PROJECT_TEMPLATE().

Function Documentation

◆ EnsureDefaultProjectTemplate()

wxFileName EnsureDefaultProjectTemplate ( const wxString & aBaseDir )

Seed the built-in "default" project template under aBaseDir, creating the directory tree and minimal metadata (meta/info.html) and project (default.kicad_pro) files when they are missing.

The default template is always seeded into the stable default user templates path rather than KICAD_USER_TEMPLATE_DIR so that it remains available regardless of how the user configures that variable.

Parameters

aBaseDir is the directory under which the "default" template directory is created. It must already be expanded (no unresolved environment variable references).

Returns: the full path of the seeded "default" template directory on success, otherwise an invalid wxFileName.

Definition at line 440 of file project_template.cpp.

References FN_NORMALIZE_FLAGS, info, METADIR, and METAFILE_INFO_HTML.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and KICAD_MANAGER_CONTROL::NewProject().

Classes