PROJECT_TREE_PANE Window to display the tree files. More...

#include <project_tree_pane.h>

Inheritance diagram for PROJECT_TREE_PANE:

Public Member Functions
	PROJECT_TREE_PANE (KICAD_MANAGER_FRAME *parent)
	The frame that shows the tree list of files and subdirectories inside the working directory.

	~PROJECT_TREE_PANE ()

void	ReCreateTreePrj ()
	Create or modify the tree showing project file names.

void	FileWatcherReset ()
	Reinit the watched paths Should be called after opening a new project to rebuild the list of watched paths.

void	EmptyTreePrj ()
	Delete all m_TreeProject entries.

Public Attributes
KICAD_MANAGER_FRAME *	m_Parent

PROJECT_TREE *	m_TreeProject

Protected Member Functions
std::vector< PROJECT_TREE_ITEM * >	GetSelectedData ()
	Function GetSelectedData return the item data from item currently selected (highlighted) Note this is not necessary the "clicked" item, because when expanding, collapsing an item this item is not selected.

PROJECT_TREE_ITEM *	GetItemIdData (wxTreeItemId aId)
	Function GetItemIdData return the item data corresponding to a wxTreeItemId identifier.

Static Protected Member Functions
static wxString	GetFileExt (TREE_FILE_TYPE type)

Private Member Functions
void	onSelect (wxTreeEvent &Event)
	Called on a double click on an item.

void	onExpand (wxTreeEvent &Event)
	Called on a click on the + or - button of an item with children.

void	onRight (wxTreeEvent &Event)
	Called on a right click on an item.

void	onOpenSelectedFileWithTextEditor (wxCommandEvent &event)
	Function onOpenSelectedFileWithTextEditor Call the text editor to open the selected file in the tree project.

void	onDeleteFile (wxCommandEvent &event)
	Function onDeleteFile Delete the selected file or directory in the tree project.

void	onRenameFile (wxCommandEvent &event)
	Function onRenameFile Rename the selected file or directory in the tree project.

void	onOpenDirectory (wxCommandEvent &event)
	Function onOpenDirectory Handles the right-click menu for opening a directory in the current system file browser.

void	onCreateNewDirectory (wxCommandEvent &event)
	Function onCreateNewDirectory Creates a new subdirectory inside the current kicad project directory the user is prompted to enter a directory name.

void	onSwitchToSelectedProject (wxCommandEvent &event)
	Switch to a other project selected from the tree project (by selecting an other .pro file inside the current project folder)

void	onIdle (wxIdleEvent &aEvent)
	Idle event handler, used process the selected items at a point in time when all other events have been consumed.

void	onPaint (wxPaintEvent &aEvent)
	We don't have uniform borders so we have to draw them ourselves.

void	onGitInitializeProject (wxCommandEvent &event)
	Initialize a new git repository in the current project directory.

void	onGitCommit (wxCommandEvent &event)
	Commit the current project saved changes to the git repository.

void	onGitPullProject (wxCommandEvent &event)
	Pull the latest changes from the git repository.

void	onGitPushProject (wxCommandEvent &event)
	Push the current project changes to the git repository.

void	onGitSwitchBranch (wxCommandEvent &event)
	Switch to a different branch in the git repository.

void	onGitCompare (wxCommandEvent &event)
	Compare the current project to a different branch in the git repository.

void	onGitRemoveVCS (wxCommandEvent &event)
	Remove the git repository from the current project directory.

void	onGitAddToIndex (wxCommandEvent &event)
	Add a file to the git index.

void	onGitRemoveFromIndex (wxCommandEvent &event)
	Remove a file from the git index.

void	onGitSyncProject (wxCommandEvent &event)
	Sync the current project with the git repository.

void	onGitFetch (wxCommandEvent &event)
	Fetch the latest changes from the git repository.

void	onGitResolveConflict (wxCommandEvent &event)
	Resolve conflicts in the git repository.

void	onGitRevertLocal (wxCommandEvent &event)
	Revert the local repository to the last commit.

void	onRunSelectedJobsFile (wxCommandEvent &event)
	Run a selected jobs file.

void	updateGitStatusIcons ()
	Updates the icons shown in the tree project to reflect the current git status.

bool	hasChangedFiles ()
	Returns true if the current project has any uncommitted changes.

bool	hasLocalCommits ()
	Returns true if the current project has local commits that have not been pushed to the remote repository.

void	shutdownFileWatcher ()
	Shutdown the file watcher.

wxTreeItemId	addItemToProjectTree (const wxString &aName, const wxTreeItemId &aParent, std::vector< wxString > *aProjectNames, bool aRecurse)
	Function addItemToProjectTree.

wxTreeItemId	findSubdirTreeItem (const wxString &aSubDir)
	Function findSubdirTreeItem searches for the item in tree project which is the node of the subdirectory aSubDir.

void	onFileSystemEvent (wxFileSystemWatcherEvent &event)
	called when a file or directory is modified/created/deleted The tree project is modified when a file or directory is created/deleted/renamed to reflect the file change

void	onThemeChanged (wxSysColourChangedEvent &aEvent)

bool	canFileBeAddedToVCS (const wxString &aFilePath)
	Returns true if the file has already been added to the repository or false if it has not been added yet.

Private Attributes
bool	m_isRenaming

wxTreeItemId	m_root

std::vector< wxString >	m_filters

wxFileSystemWatcher *	m_watcher

PROJECT_TREE_ITEM *	m_selectedItem

bool	m_watcherNeedReset

wxDateTime	m_lastGitStatusUpdate

int	m_gitLastError

Friends
class	PROJECT_TREE_ITEM

Detailed Description

PROJECT_TREE_PANE Window to display the tree files.

Definition at line 49 of file project_tree_pane.h.

Constructor & Destructor Documentation

◆ PROJECT_TREE_PANE()

PROJECT_TREE_PANE::PROJECT_TREE_PANE ( KICAD_MANAGER_FRAME * parent )

The frame that shows the tree list of files and subdirectories inside the working directory.

Files are filtered (see s_allowedExtensionsToList) so only useful files are shown.

Definition at line 179 of file project_tree_pane.cpp.

References onFileSystemEvent(), onThemeChanged(), and s_allowedExtensionsToList.

◆ ~PROJECT_TREE_PANE()

PROJECT_TREE_PANE::~PROJECT_TREE_PANE ( )

Definition at line 212 of file project_tree_pane.cpp.

References onFileSystemEvent(), onThemeChanged(), and shutdownFileWatcher().

Member Function Documentation

◆ addItemToProjectTree()

wxTreeItemId PROJECT_TREE_PANE::addItemToProjectTree	(	const wxString &	aName,
		const wxTreeItemId &	aParent,
		std::vector< wxString > *	aProjectNames,
		bool	aRecurse
	)

private

Function addItemToProjectTree.

Add the file or directory aName to the project tree

Parameters

aName	= the filename or the directory name to add in tree
aParent	= the wxTreeItemId item where to add sub tree items
aRecurse	= true to add file or subdir names to the current tree item false to stop file add.

Returns: the Id for the new tree item

Definition at line 396 of file project_tree_pane.cpp.

References addItemToProjectTree(), alg::contains(), PROJECT_TREE_ITEM::GetDir(), GetFileExt(), PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), KICAD_MANAGER_FRAME::GetProjectFileName(), getProjects(), PROJECT_TREE_ITEM::GetType(), KIPLATFORM::IO::IsFileHidden(), m_filters, m_Parent, m_TreeProject, m_watcherNeedReset, path, project, PROJECT_TREE_ITEM, PROJECT_TREE_ITEM::SetPopulated(), PROJECT_TREE_ITEM::SetRootFile(), and PROJECT_TREE_ITEM::SetState().

Referenced by addItemToProjectTree(), onCreateNewDirectory(), onExpand(), onFileSystemEvent(), and ReCreateTreePrj().

◆ canFileBeAddedToVCS()

bool PROJECT_TREE_PANE::canFileBeAddedToVCS ( const wxString & aFilePath )

private

Returns true if the file has already been added to the repository or false if it has not been added yet.

Definition at line 2359 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), and m_TreeProject.

◆ EmptyTreePrj()

void PROJECT_TREE_PANE::EmptyTreePrj ( )

Delete all m_TreeProject entries.

Definition at line 1522 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), m_TreeProject, PROJECT_TREE::SetGitRepo(), and shutdownFileWatcher().

Referenced by KICAD_MANAGER_FRAME::CloseProject().

◆ FileWatcherReset()

void PROJECT_TREE_PANE::FileWatcherReset ( )

Reinit the watched paths Should be called after opening a new project to rebuild the list of watched paths.

Should be called after the main loop event handler is started

Definition at line 1385 of file project_tree_pane.cpp.

References _, KICAD_MANAGER_FRAME::GetProjectFileName(), KIPLATFORM::ENV::IsNetworkPath(), KICAD_MANAGER_FRAME::m_FileWatcherInfo, m_Parent, m_watcher, m_watcherNeedReset, KISTATUSBAR::SetEllipsedTextField(), TO_UTF8, tracePathsAndFiles, and wxFileSystemWatcher.

Referenced by KICAD_MANAGER_FRAME::OnChangeWatchedPaths(), and onIdle().

◆ findSubdirTreeItem()

wxTreeItemId PROJECT_TREE_PANE::findSubdirTreeItem ( const wxString & aSubDir )

private

Function findSubdirTreeItem searches for the item in tree project which is the node of the subdirectory aSubDir.

Parameters

aSubDir = the directory to find in tree

Returns: the opaque reference to the tree item; if not found, return an invalid tree item so that wxTreeItemId::IsOk() can be used to test the returned value

Definition at line 1213 of file project_tree_pane.cpp.

References PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), KICAD_MANAGER_FRAME::GetProjectFileName(), PROJECT_TREE_ITEM::GetType(), PROJECT_TREE_ITEM::IsPopulated(), m_Parent, m_root, and m_TreeProject.

Referenced by onFileSystemEvent().

◆ GetFileExt()

wxString PROJECT_TREE_PANE::GetFileExt ( TREE_FILE_TYPE type )

staticprotected

Definition at line 305 of file project_tree_pane.cpp.

Referenced by addItemToProjectTree(), and PROJECT_TREE_ITEM::Rename().

◆ GetItemIdData()

PROJECT_TREE_ITEM * PROJECT_TREE_PANE::GetItemIdData ( wxTreeItemId aId )

protected

Function GetItemIdData return the item data corresponding to a wxTreeItemId identifier.

Parameters

aId	= the wxTreeItemId identifier.

Returns: a PROJECT_TREE_ITEM pointer corresponding to item id aId

Definition at line 1207 of file project_tree_pane.cpp.

References m_TreeProject.

Referenced by addItemToProjectTree(), findSubdirTreeItem(), GetSelectedData(), onExpand(), onFileSystemEvent(), onGitInitializeProject(), and updateGitStatusIcons().

◆ GetSelectedData()

std::vector< PROJECT_TREE_ITEM * > PROJECT_TREE_PANE::GetSelectedData ( )

protected

Function GetSelectedData return the item data from item currently selected (highlighted) Note this is not necessary the "clicked" item, because when expanding, collapsing an item this item is not selected.

Definition at line 1182 of file project_tree_pane.cpp.

References GetItemIdData(), m_TreeProject, and traceGit.

Referenced by onCreateNewDirectory(), onDeleteFile(), onGitCommit(), onOpenDirectory(), onOpenSelectedFileWithTextEditor(), onRenameFile(), onRight(), onSelect(), and onSwitchToSelectedProject().

◆ hasChangedFiles()

bool PROJECT_TREE_PANE::hasChangedFiles ( )

private

Returns true if the current project has any uncommitted changes.

Definition at line 716 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), and m_TreeProject.

Referenced by onRight().

◆ hasLocalCommits()

bool PROJECT_TREE_PANE::hasLocalCommits ( )

private

Returns true if the current project has local commits that have not been pushed to the remote repository.

◆ onCreateNewDirectory()

void PROJECT_TREE_PANE::onCreateNewDirectory ( wxCommandEvent & event )

private

Function onCreateNewDirectory Creates a new subdirectory inside the current kicad project directory the user is prompted to enter a directory name.

Definition at line 275 of file project_tree_pane.cpp.

References _, addItemToProjectTree(), KICAD_MANAGER_FRAME::GetProjectFileName(), GetSelectedData(), and m_Parent.

◆ onDeleteFile()

void PROJECT_TREE_PANE::onDeleteFile ( wxCommandEvent & event )

private

Function onDeleteFile Delete the selected file or directory in the tree project.

Definition at line 1040 of file project_tree_pane.cpp.

References GetSelectedData().

◆ onExpand()

void PROJECT_TREE_PANE::onExpand ( wxTreeEvent & Event )

private

Called on a click on the + or - button of an item with children.

Definition at line 1117 of file project_tree_pane.cpp.

References addItemToProjectTree(), PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), getProjects(), PROJECT_TREE_ITEM::GetType(), PROJECT_TREE_ITEM::IsPopulated(), m_TreeProject, m_watcherNeedReset, name, and PROJECT_TREE_ITEM::SetPopulated().

◆ onFileSystemEvent()

void PROJECT_TREE_PANE::onFileSystemEvent ( wxFileSystemWatcherEvent & event )

private

called when a file or directory is modified/created/deleted The tree project is modified when a file or directory is created/deleted/renamed to reflect the file change

Definition at line 1271 of file project_tree_pane.cpp.

References addItemToProjectTree(), findSubdirTreeItem(), PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), KI_FALLTHROUGH, m_isRenaming, m_TreeProject, m_watcher, and updateGitStatusIcons().

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ onGitAddToIndex()

void PROJECT_TREE_PANE::onGitAddToIndex ( wxCommandEvent & event )

private

Add a file to the git index.

Definition at line 2353 of file project_tree_pane.cpp.

◆ onGitCommit()

void PROJECT_TREE_PANE::onGitCommit ( wxCommandEvent & event )

private

Commit the current project saved changes to the git repository.

Definition at line 2116 of file project_tree_pane.cpp.

References _, COMMON_SETTINGS::GIT::authorEmail, COMMON_SETTINGS::GIT::authorName, config, DIALOG_GIT_COMMIT::GetAuthorEmail(), DIALOG_GIT_COMMIT::GetAuthorName(), DIALOG_GIT_COMMIT::GetCommitMessage(), PGM_BASE::GetCommonSettings(), PROJECT_TREE::GetGitRepo(), GetSelectedData(), DIALOG_GIT_COMMIT::GetSelectedFiles(), ID_GIT_COMMIT_PROJECT, COMMON_SETTINGS::m_Git, m_TreeProject, Pgm(), and DIALOG_SHIM::ShowModal().

◆ onGitCompare()

void PROJECT_TREE_PANE::onGitCompare ( wxCommandEvent & event )

private

Compare the current project to a different branch in the git repository.

Definition at line 1708 of file project_tree_pane.cpp.

◆ onGitFetch()

void PROJECT_TREE_PANE::onGitFetch ( wxCommandEvent & event )

private

Fetch the latest changes from the git repository.

Definition at line 2396 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), m_TreeProject, and GIT_PULL_HANDLER::PerformFetch().

◆ onGitInitializeProject()

void PROJECT_TREE_PANE::onGitInitializeProject ( wxCommandEvent & event )

private

Initialize a new git repository in the current project directory.

Definition at line 1567 of file project_tree_pane.cpp.

References _, DisplayErrorMessage(), DisplayInfoMessage(), DIALOG_GIT_REPOSITORY::GetBareRepoURL(), KIGIT_COMMON::GetConnType(), PROJECT_TREE_ITEM::GetDir(), GetItemIdData(), PROJECT::GetLocalSettings(), DIALOG_GIT_REPOSITORY::GetPassword(), KIGIT_COMMON::GetPassword(), DIALOG_GIT_REPOSITORY::GetRepoSSHPath(), DIALOG_GIT_REPOSITORY::GetRepoType(), DIALOG_GIT_REPOSITORY::GetRepoURL(), KIGIT_COMMON::GetSSHKey(), DIALOG_GIT_REPOSITORY::GetUsername(), KIGIT_COMMON::GetUsername(), KIGIT_COMMON::GIT_CONN_HTTPS, KIGIT_COMMON::GIT_CONN_SSH, PROJECT_TREE::GitCommon(), m_gitLastError, PROJECT_LOCAL_SETTINGS::m_GitRepoPassword, PROJECT_LOCAL_SETTINGS::m_GitRepoType, PROJECT_LOCAL_SETTINGS::m_GitRepoUsername, PROJECT_LOCAL_SETTINGS::m_GitSSHKey, m_TreeProject, GIT_PULL_HANDLER::PerformFetch(), Prj(), KIGIT_COMMON::SetConnType(), PROJECT_TREE::SetGitRepo(), KIGIT_COMMON::SetPassword(), GIT_PROGRESS::SetProgressReporter(), KIGIT_COMMON::SetSSHKey(), KIGIT_COMMON::SetUsername(), and DIALOG_SHIM::ShowModal().

◆ onGitPullProject()

void PROJECT_TREE_PANE::onGitPullProject ( wxCommandEvent & event )

private

Pull the latest changes from the git repository.

Definition at line 1714 of file project_tree_pane.cpp.

References _, DisplayErrorMessage(), KIGIT_COMMON::GetConnType(), KIGIT_ERRORS::GetErrorString(), PROJECT_TREE::GetGitRepo(), KIGIT_COMMON::GetPassword(), KIGIT_COMMON::GetSSHKey(), KIGIT_COMMON::GetUsername(), PROJECT_TREE::GitCommon(), m_TreeProject, GIT_PULL_HANDLER::PerformPull(), KIGIT_COMMON::SetConnType(), KIGIT_COMMON::SetPassword(), GIT_PROGRESS::SetProgressReporter(), KIGIT_COMMON::SetSSHKey(), and KIGIT_COMMON::SetUsername().

◆ onGitPushProject()

void PROJECT_TREE_PANE::onGitPushProject ( wxCommandEvent & event )

private

Push the current project changes to the git repository.

Definition at line 1741 of file project_tree_pane.cpp.

References _, DisplayErrorMessage(), KIGIT_COMMON::GetConnType(), KIGIT_ERRORS::GetErrorString(), PROJECT_TREE::GetGitRepo(), KIGIT_COMMON::GetPassword(), KIGIT_COMMON::GetSSHKey(), KIGIT_COMMON::GetUsername(), PROJECT_TREE::GitCommon(), m_TreeProject, GIT_PUSH_HANDLER::PerformPush(), KIGIT_COMMON::SetConnType(), KIGIT_COMMON::SetPassword(), GIT_PROGRESS::SetProgressReporter(), KIGIT_COMMON::SetSSHKey(), and KIGIT_COMMON::SetUsername().

◆ onGitRemoveFromIndex()

void PROJECT_TREE_PANE::onGitRemoveFromIndex ( wxCommandEvent & event )

private

Remove a file from the git index.

Definition at line 2432 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), m_TreeProject, and GIT_REMOVE_FROM_INDEX_HANDLER::PerformRemoveFromIndex().

◆ onGitRemoveVCS()

void PROJECT_TREE_PANE::onGitRemoveVCS ( wxCommandEvent & event )

private

Remove the git repository from the current project directory.

Definition at line 1873 of file project_tree_pane.cpp.

References _, DisplayErrorMessage(), PROJECT_TREE::GetGitRepo(), KICAD_MANAGER_FRAME::GetProjectFileName(), IsOK(), m_Parent, m_TreeProject, RmDirRecursive(), and PROJECT_TREE::SetGitRepo().

◆ onGitResolveConflict()

void PROJECT_TREE_PANE::onGitResolveConflict ( wxCommandEvent & event )

private

Resolve conflicts in the git repository.

Definition at line 2408 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), m_TreeProject, and GIT_RESOLVE_CONFLICT_HANDLER::PerformResolveConflict().

◆ onGitRevertLocal()

void PROJECT_TREE_PANE::onGitRevertLocal ( wxCommandEvent & event )

private

Revert the local repository to the last commit.

Definition at line 2420 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), m_TreeProject, and GIT_REVERT_HANDLER::PerformRevert().

◆ onGitSwitchBranch()

void PROJECT_TREE_PANE::onGitSwitchBranch ( wxCommandEvent & event )

private

Switch to a different branch in the git repository.

Definition at line 1802 of file project_tree_pane.cpp.

References _, DisplayError(), DIALOG_GIT_SWITCH::GetBranchName(), PROJECT_TREE::GetGitRepo(), git_create_branch(), m_TreeProject, and DIALOG_SHIM::ShowModal().

◆ onGitSyncProject()

void PROJECT_TREE_PANE::onGitSyncProject ( wxCommandEvent & event )

private

Sync the current project with the git repository.

Definition at line 2384 of file project_tree_pane.cpp.

References PROJECT_TREE::GetGitRepo(), m_TreeProject, and GIT_SYNC_HANDLER::PerformSync().

◆ onIdle()

void PROJECT_TREE_PANE::onIdle ( wxIdleEvent & aEvent )

private

Idle event handler, used process the selected items at a point in time when all other events have been consumed.

Definition at line 1092 of file project_tree_pane.cpp.

References PROJECT_TREE_ITEM::Activate(), FileWatcherReset(), m_selectedItem, m_watcherNeedReset, and updateGitStatusIcons().

◆ onOpenDirectory()

void PROJECT_TREE_PANE::onOpenDirectory ( wxCommandEvent & event )

private

Function onOpenDirectory Handles the right-click menu for opening a directory in the current system file browser.

Definition at line 247 of file project_tree_pane.cpp.

References PATHS::GetDefaultUserProjectsPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), GetSelectedData(), LaunchExternal(), and m_Parent.

◆ onOpenSelectedFileWithTextEditor()

void PROJECT_TREE_PANE::onOpenSelectedFileWithTextEditor ( wxCommandEvent & event )

private

Function onOpenSelectedFileWithTextEditor Call the text editor to open the selected file in the tree project.

Definition at line 1016 of file project_tree_pane.cpp.

References _, ExecuteFile(), GetSelectedData(), PGM_BASE::GetTextEditor(), and Pgm().

◆ onPaint()

void PROJECT_TREE_PANE::onPaint ( wxPaintEvent & aEvent )

private

We don't have uniform borders so we have to draw them ourselves.

Definition at line 1548 of file project_tree_pane.cpp.

◆ onRenameFile()

void PROJECT_TREE_PANE::onRenameFile ( wxCommandEvent & event )

private

Function onRenameFile Rename the selected file or directory in the tree project.

Definition at line 1049 of file project_tree_pane.cpp.

References _, GetSelectedData(), m_isRenaming, and m_TreeProject.

◆ onRight()

void PROJECT_TREE_PANE::onRight ( wxTreeEvent & Event )

private

◆ onRunSelectedJobsFile()

void PROJECT_TREE_PANE::onRunSelectedJobsFile ( wxCommandEvent & event )

private

Run a selected jobs file.

Definition at line 2444 of file project_tree_pane.cpp.

◆ onSelect()

void PROJECT_TREE_PANE::onSelect ( wxTreeEvent & Event )

private

Called on a double click on an item.

Definition at line 1078 of file project_tree_pane.cpp.

References GetSelectedData(), and m_selectedItem.

◆ onSwitchToSelectedProject()

void PROJECT_TREE_PANE::onSwitchToSelectedProject ( wxCommandEvent & event )

private

Switch to a other project selected from the tree project (by selecting an other .pro file inside the current project folder)

Definition at line 234 of file project_tree_pane.cpp.

References GetSelectedData(), KICAD_MANAGER_FRAME::LoadProject(), and m_Parent.

◆ onThemeChanged()

void PROJECT_TREE_PANE::onThemeChanged ( wxSysColourChangedEvent & aEvent )

private

Definition at line 1538 of file project_tree_pane.cpp.

References GetBitmapStore(), PROJECT_TREE::LoadIcons(), m_TreeProject, and BITMAP_STORE::ThemeChanged().

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ ReCreateTreePrj()

void PROJECT_TREE_PANE::ReCreateTreePrj ( )

Create or modify the tree showing project file names.

Definition at line 604 of file project_tree_pane.cpp.

References addItemToProjectTree(), get_git_repository_for_file(), ADVANCED_CFG::GetCfg(), PATHS::GetDefaultUserProjectsPath(), PROJECT_TREE::GetGitRepo(), PROJECT::GetLocalSettings(), KICAD_MANAGER_FRAME::GetProjectFileName(), getProjects(), KIGIT_COMMON::GIT_CONN_HTTPS, KIGIT_COMMON::GIT_CONN_LOCAL, KIGIT_COMMON::GIT_CONN_SSH, PROJECT_TREE::GitCommon(), FILEEXT::LegacyProjectFileExtension, PROJECT_LOCAL_SETTINGS::m_GitRepoType, m_Parent, m_root, m_TreeProject, name, NAMELESS_PROJECT, Prj(), PROJECT_TREE_ITEM, FILEEXT::ProjectFileExtension, KIGIT_COMMON::SetConnType(), PROJECT_TREE::SetGitRepo(), KIGIT_COMMON::SetPassword(), KIGIT_COMMON::SetSSHKey(), KIGIT_COMMON::SetUsername(), and updateGitStatusIcons().

Referenced by KICAD_MANAGER_FRAME::LoadProject(), KICAD_MANAGER_FRAME::ReCreateTreePrj(), and KICAD_MANAGER_FRAME::RefreshProjectTree().

◆ shutdownFileWatcher()

void PROJECT_TREE_PANE::shutdownFileWatcher ( )

private

Shutdown the file watcher.

Used when closing to prevent post-free access into the project tree. (Using the destructor doesn't work as wxWidgets defers destruction in some cases.)

Definition at line 222 of file project_tree_pane.cpp.

References m_watcher.

Referenced by EmptyTreePrj(), and ~PROJECT_TREE_PANE().

◆ updateGitStatusIcons()

void PROJECT_TREE_PANE::updateGitStatusIcons ( )

private

Updates the icons shown in the tree project to reflect the current git status.

Definition at line 1923 of file project_tree_pane.cpp.

References ADVANCED_CFG::GetCfg(), KIGIT_COMMON::GetDifferentFiles(), PROJECT_TREE_ITEM::GetFileName(), PROJECT_TREE::GetGitRepo(), GetItemIdData(), KIGIT_COMMON::GIT_STATUS_ADDED, KIGIT_COMMON::GIT_STATUS_AHEAD, KIGIT_COMMON::GIT_STATUS_BEHIND, KIGIT_COMMON::GIT_STATUS_CURRENT, KIGIT_COMMON::GIT_STATUS_DELETED, KIGIT_COMMON::GIT_STATUS_MODIFIED, PROJECT_TREE::GitCommon(), m_gitLastError, m_lastGitStatusUpdate, m_TreeProject, path, and traceGit.

Referenced by onFileSystemEvent(), onIdle(), and ReCreateTreePrj().

Friends And Related Function Documentation

◆ PROJECT_TREE_ITEM

friend class PROJECT_TREE_ITEM

friend

Definition at line 51 of file project_tree_pane.h.

Referenced by addItemToProjectTree(), and ReCreateTreePrj().

Member Data Documentation

◆ m_filters

std::vector<wxString> PROJECT_TREE_PANE::m_filters

private

Definition at line 293 of file project_tree_pane.h.

Referenced by addItemToProjectTree().

◆ m_gitLastError

int PROJECT_TREE_PANE::m_gitLastError

private

Definition at line 300 of file project_tree_pane.h.

Referenced by onGitInitializeProject(), and updateGitStatusIcons().

◆ m_isRenaming

bool PROJECT_TREE_PANE::m_isRenaming

private

Definition at line 291 of file project_tree_pane.h.

Referenced by onFileSystemEvent(), and onRenameFile().

◆ m_lastGitStatusUpdate

wxDateTime PROJECT_TREE_PANE::m_lastGitStatusUpdate

private

Definition at line 299 of file project_tree_pane.h.

Referenced by updateGitStatusIcons().

◆ m_Parent

KICAD_MANAGER_FRAME* PROJECT_TREE_PANE::m_Parent

Definition at line 287 of file project_tree_pane.h.

Referenced by PROJECT_TREE_ITEM::Activate(), addItemToProjectTree(), FileWatcherReset(), findSubdirTreeItem(), onCreateNewDirectory(), onGitRemoveVCS(), onOpenDirectory(), onSwitchToSelectedProject(), and ReCreateTreePrj().

◆ m_root

wxTreeItemId PROJECT_TREE_PANE::m_root

private

Definition at line 292 of file project_tree_pane.h.

Referenced by findSubdirTreeItem(), and ReCreateTreePrj().

◆ m_selectedItem

PROJECT_TREE_ITEM* PROJECT_TREE_PANE::m_selectedItem

private

Definition at line 295 of file project_tree_pane.h.

Referenced by onIdle(), and onSelect().

◆ m_TreeProject

PROJECT_TREE* PROJECT_TREE_PANE::m_TreeProject

◆ m_watcher

wxFileSystemWatcher* PROJECT_TREE_PANE::m_watcher

private

Definition at line 294 of file project_tree_pane.h.

Referenced by FileWatcherReset(), onFileSystemEvent(), and shutdownFileWatcher().

◆ m_watcherNeedReset

bool PROJECT_TREE_PANE::m_watcherNeedReset

private

Definition at line 296 of file project_tree_pane.h.

Referenced by addItemToProjectTree(), FileWatcherReset(), onExpand(), and onIdle().

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

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PROJECT_TREE_PANE()

◆ ~PROJECT_TREE_PANE()

Member Function Documentation

◆ addItemToProjectTree()

◆ canFileBeAddedToVCS()

◆ EmptyTreePrj()

◆ FileWatcherReset()

◆ findSubdirTreeItem()

◆ GetFileExt()

◆ GetItemIdData()

◆ GetSelectedData()

◆ hasChangedFiles()

◆ hasLocalCommits()

◆ onCreateNewDirectory()

◆ onDeleteFile()

◆ onExpand()

◆ onFileSystemEvent()

◆ onGitAddToIndex()

◆ onGitCommit()

◆ onGitCompare()

◆ onGitFetch()

◆ onGitInitializeProject()

◆ onGitPullProject()

◆ onGitPushProject()

◆ onGitRemoveFromIndex()

◆ onGitRemoveVCS()

◆ onGitResolveConflict()

◆ onGitRevertLocal()

◆ onGitSwitchBranch()

◆ onGitSyncProject()

◆ onIdle()

◆ onOpenDirectory()

◆ onOpenSelectedFileWithTextEditor()

◆ onPaint()

◆ onRenameFile()

◆ onRight()

◆ onRunSelectedJobsFile()

◆ onSelect()

◆ onSwitchToSelectedProject()

◆ onThemeChanged()

◆ ReCreateTreePrj()

◆ shutdownFileWatcher()

◆ updateGitStatusIcons()

Friends And Related Function Documentation

◆ PROJECT_TREE_ITEM

Member Data Documentation

◆ m_filters

◆ m_gitLastError

◆ m_isRenaming

◆ m_lastGitStatusUpdate

◆ m_Parent

◆ m_root

◆ m_selectedItem

◆ m_TreeProject

◆ m_watcher

◆ m_watcherNeedReset