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. More...

	~PROJECT_TREE_PANE ()

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

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

void	EmptyTreePrj ()
	Delete all m_TreeProject entries. More...

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. More...

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

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. More...

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

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

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

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

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

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

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. More...

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) More...

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

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

void	shutdownFileWatcher ()
	Shutdown the file watcher. More...

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

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

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 More...

void	onThemeChanged (wxSysColourChangedEvent &aEvent)

Private Attributes
bool	m_isRenaming

wxTreeItemId	m_root

std::vector< wxString >	m_filters

wxFileSystemWatcher *	m_watcher

PROJECT_TREE_ITEM *	m_selectedItem

bool	m_watcherNeedReset

Friends
class	PROJECT_TREE_ITEM

Detailed Description

PROJECT_TREE_PANE Window to display the tree files.

Definition at line 48 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 134 of file project_tree_pane.cpp.

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

◆ ~PROJECT_TREE_PANE()

PROJECT_TREE_PANE::~PROJECT_TREE_PANE ( )

Definition at line 164 of file project_tree_pane.cpp.

References 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 306 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(), 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().

◆ EmptyTreePrj()

void PROJECT_TREE_PANE::EmptyTreePrj ( )

Delete all m_TreeProject entries.

Definition at line 1253 of file project_tree_pane.cpp.

References m_TreeProject, 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 1139 of file project_tree_pane.cpp.

References _, PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), KICAD_MANAGER_FRAME::GetProjectFileName(), PROJECT_TREE_ITEM::GetType(), KIPLATFORM::ENV::IsNetworkPath(), PROJECT_TREE_ITEM::IsPopulated(), m_Parent, m_root, m_TreeProject, m_watcher, m_watcherNeedReset, path, TO_UTF8, and tracePathsAndFiles.

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 970 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

◆ 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 964 of file project_tree_pane.cpp.

References m_TreeProject.

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

◆ 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 941 of file project_tree_pane.cpp.

References GetItemIdData(), and m_TreeProject.

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

◆ 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 223 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 802 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 876 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 1028 of file project_tree_pane.cpp.

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

Referenced by PROJECT_TREE_PANE().

◆ 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 854 of file project_tree_pane.cpp.

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

◆ 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 195 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 775 of file project_tree_pane.cpp.

References _, ExecuteFile(), GetSelectedData(), 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 1272 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 811 of file project_tree_pane.cpp.

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

◆ onRight()

void PROJECT_TREE_PANE::onRight ( wxTreeEvent & Event )

private

Called on a right click on an item.

Definition at line 600 of file project_tree_pane.cpp.

References _, AddMenuItem(), GetSelectedData(), ID_PROJECT_DELETE, ID_PROJECT_NEWDIR, ID_PROJECT_OPEN_DIR, ID_PROJECT_RENAME, ID_PROJECT_SWITCH_TO_OTHER, ID_PROJECT_TXTEDIT, KiBitmap(), m_TreeProject, and text.

◆ onSelect()

void PROJECT_TREE_PANE::onSelect ( wxTreeEvent & Event )

private

Called on a double click on an item.

Definition at line 840 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 182 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 1262 of file project_tree_pane.cpp.

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

Referenced by PROJECT_TREE_PANE().

◆ ReCreateTreePrj()

void PROJECT_TREE_PANE::ReCreateTreePrj ( )

Create or modify the tree showing project file names.

Definition at line 516 of file project_tree_pane.cpp.

References addItemToProjectTree(), PATHS::GetDefaultUserProjectsPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), getProjects(), LegacyProjectFileExtension, m_Parent, m_root, m_TreeProject, name, NAMELESS_PROJECT, PROJECT_TREE_ITEM, and ProjectFileExtension.

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 170 of file project_tree_pane.cpp.

References m_watcher.

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

Friends And Related Function Documentation

◆ PROJECT_TREE_ITEM

friend class PROJECT_TREE_ITEM

friend

Definition at line 50 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 200 of file project_tree_pane.h.

Referenced by addItemToProjectTree().

◆ m_isRenaming

bool PROJECT_TREE_PANE::m_isRenaming

private

Definition at line 198 of file project_tree_pane.h.

Referenced by onFileSystemEvent(), and onRenameFile().

◆ m_Parent

KICAD_MANAGER_FRAME* PROJECT_TREE_PANE::m_Parent

Definition at line 194 of file project_tree_pane.h.

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

◆ m_root

wxTreeItemId PROJECT_TREE_PANE::m_root

private

Definition at line 199 of file project_tree_pane.h.

Referenced by FileWatcherReset(), findSubdirTreeItem(), and ReCreateTreePrj().

◆ m_selectedItem

PROJECT_TREE_ITEM* PROJECT_TREE_PANE::m_selectedItem

private

Definition at line 202 of file project_tree_pane.h.

Referenced by onIdle(), and onSelect().

◆ m_TreeProject

PROJECT_TREE* PROJECT_TREE_PANE::m_TreeProject

Definition at line 195 of file project_tree_pane.h.

Referenced by PROJECT_TREE_ITEM::Activate(), addItemToProjectTree(), EmptyTreePrj(), FileWatcherReset(), findSubdirTreeItem(), GetItemIdData(), GetSelectedData(), onExpand(), onFileSystemEvent(), onRenameFile(), onRight(), onThemeChanged(), and ReCreateTreePrj().

◆ m_watcher

wxFileSystemWatcher* PROJECT_TREE_PANE::m_watcher

private

Definition at line 201 of file project_tree_pane.h.

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

◆ m_watcherNeedReset

bool PROJECT_TREE_PANE::m_watcherNeedReset

private

Definition at line 203 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()

◆ EmptyTreePrj()

◆ FileWatcherReset()

◆ findSubdirTreeItem()

◆ GetFileExt()

◆ GetItemIdData()

◆ GetSelectedData()

◆ onCreateNewDirectory()

◆ onDeleteFile()

◆ onExpand()

◆ onFileSystemEvent()

◆ onIdle()

◆ onOpenDirectory()

◆ onOpenSelectedFileWithTextEditor()

◆ onPaint()

◆ onRenameFile()

◆ onRight()

◆ onSelect()

◆ onSwitchToSelectedProject()

◆ onThemeChanged()

◆ ReCreateTreePrj()

◆ shutdownFileWatcher()

Friends And Related Function Documentation

◆ PROJECT_TREE_ITEM

Member Data Documentation

◆ m_filters

◆ m_isRenaming

◆ m_Parent

◆ m_root

◆ m_selectedItem

◆ m_TreeProject

◆ m_watcher

◆ m_watcherNeedReset