PROJECT_TREE_TRAVERSER Class Reference

Traverser class to duplicate/copy project or template files with proper renaming. More...

#include <project_tree_traverser.h>

Inheritance diagram for PROJECT_TREE_TRAVERSER:

Public Member Functions
	PROJECT_TREE_TRAVERSER (KICAD_MANAGER_FRAME *aFrame, const wxString &aSrcProjectDirPath, const wxString &aSrcProjectName, const wxString &aNewProjectDirPath, const wxString &aNewProjectName)
virtual wxDirTraverseResult	OnFile (const wxString &aSrcFilePath) override
virtual wxDirTraverseResult	OnDir (const wxString &aSrcDirPath) override
wxString	GetErrors () const
wxFileName	GetNewProjectFile () const

Private Attributes
KICAD_MANAGER_FRAME *	m_frame
wxString	m_projectDirPath
wxString	m_projectName
wxString	m_newProjectDirPath
wxString	m_newProjectName
wxFileName	m_newProjectFile
wxString	m_errors

Detailed Description

Traverser class to duplicate/copy project or template files with proper renaming.

This class can operate in two modes:

1. With KICAD_MANAGER_FRAME: Uses KIFACE interfaces for proper file type handling
2. Without KICAD_MANAGER_FRAME (nullptr): Simple file copying for templates

Definition at line 40 of file project_tree_traverser.h.

Constructor & Destructor Documentation

PROJECT_TREE_TRAVERSER()

PROJECT_TREE_TRAVERSER::PROJECT_TREE_TRAVERSER	(	KICAD_MANAGER_FRAME *	aFrame,
		const wxString &	aSrcProjectDirPath,
		const wxString &	aSrcProjectName,
		const wxString &	aNewProjectDirPath,
		const wxString &	aNewProjectName )

Definition at line 38 of file project_tree_traverser.cpp.

References m_frame, m_newProjectDirPath, m_newProjectName, m_projectDirPath, and m_projectName.

Member Function Documentation

GetErrors()

wxString PROJECT_TREE_TRAVERSER::GetErrors ( ) const

inline

Definition at line 52 of file project_tree_traverser.h.

References m_errors.

Referenced by TEMPLATE_WIDGET::onDuplicateTemplate(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

GetNewProjectFile()

wxFileName PROJECT_TREE_TRAVERSER::GetNewProjectFile ( ) const

inline

Definition at line 53 of file project_tree_traverser.h.

References m_newProjectFile.

Referenced by KICAD_MANAGER_CONTROL::SaveProjectAs().

OnDir()

wxDirTraverseResult PROJECT_TREE_TRAVERSER::OnDir ( const wxString & aSrcDirPath )

overridevirtual

Definition at line 173 of file project_tree_traverser.cpp.

References _, m_errors, m_newProjectDirPath, m_newProjectName, m_projectDirPath, m_projectName, and PROJECT_BACKUPS_DIR_SUFFIX.

OnFile()

wxDirTraverseResult PROJECT_TREE_TRAVERSER::OnFile ( const wxString & aSrcFilePath )

overridevirtual

Definition at line 52 of file project_tree_traverser.cpp.

References FILEEXT::BackupFileSuffix, FILEEXT::DrawingSheetFileExtension, FILEEXT::DrillFileExtension, eeschema, KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FILEEXT::FootprintAssignmentFileExtension, FILEEXT::FootprintLibraryTableFileName, FILEEXT::GerberJobFileExtension, FILEEXT::IsGerberFileExtension(), FILEEXT::KiCadFootprintFileExtension, FILEEXT::KiCadPcbFileExtension, FILEEXT::KiCadSchematicFileExtension, FILEEXT::KiCadSymbolLibFileExtension, KiCopyFile(), FILEEXT::LegacyFootprintLibPathExtension, FILEEXT::LegacyPcbFileExtension, FILEEXT::LegacyProjectFileExtension, FILEEXT::LegacySchematicFileExtension, FILEEXT::LegacySymbolDocumentFileExtension, FILEEXT::LegacySymbolLibFileExtension, JSON_SETTINGS::LoadFromFile(), PROJECT_FILE::LoadFromFile(), FILEEXT::LockFileExtension, FILEEXT::LockFilePrefix, m_errors, m_frame, m_newProjectDirPath, m_newProjectFile, m_newProjectName, m_projectDirPath, m_projectName, FILEEXT::NetlistFileExtension, pcbnew, FILEEXT::ProjectFileExtension, FILEEXT::ProjectLocalSettingsFileExtension, PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), KIFACE::SaveFileAs(), FILEEXT::SchematicSymbolFileExtension, and FILEEXT::SymbolLibraryTableFileName.

Member Data Documentation

m_errors

wxString PROJECT_TREE_TRAVERSER::m_errors

private

Definition at line 64 of file project_tree_traverser.h.

Referenced by GetErrors(), OnDir(), and OnFile().

m_frame

KICAD_MANAGER_FRAME* PROJECT_TREE_TRAVERSER::m_frame

private

Definition at line 56 of file project_tree_traverser.h.

Referenced by OnFile(), and PROJECT_TREE_TRAVERSER().

m_newProjectDirPath

wxString PROJECT_TREE_TRAVERSER::m_newProjectDirPath

private

Definition at line 60 of file project_tree_traverser.h.

Referenced by OnDir(), OnFile(), and PROJECT_TREE_TRAVERSER().

m_newProjectFile

wxFileName PROJECT_TREE_TRAVERSER::m_newProjectFile

private

Definition at line 63 of file project_tree_traverser.h.

Referenced by GetNewProjectFile(), and OnFile().

m_newProjectName

wxString PROJECT_TREE_TRAVERSER::m_newProjectName

private

Definition at line 61 of file project_tree_traverser.h.

Referenced by OnDir(), OnFile(), and PROJECT_TREE_TRAVERSER().

m_projectDirPath

wxString PROJECT_TREE_TRAVERSER::m_projectDirPath

private

Definition at line 58 of file project_tree_traverser.h.

Referenced by OnDir(), OnFile(), and PROJECT_TREE_TRAVERSER().

m_projectName

wxString PROJECT_TREE_TRAVERSER::m_projectName

private

Definition at line 59 of file project_tree_traverser.h.

Referenced by OnDir(), OnFile(), and PROJECT_TREE_TRAVERSER().

---

The documentation for this class was generated from the following files:

• project_tree_traverser.h
• project_tree_traverser.cpp