forked from KiCad/kicad-source-mirror
-
Notifications
You must be signed in to change notification settings - Fork 0
/
project_tree_pane.h
210 lines (175 loc) · 6.8 KB
/
project_tree_pane.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2012 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2021 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
/**
* @file project_tree_pane.h
*/
#ifndef TREEPRJ_FRAME_H
#define TREEPRJ_FRAME_H
#include <vector>
#include <wx/fswatcher.h>
#include <wx/laywin.h>
#include <wx/treebase.h>
#include "tree_file_type.h"
class KICAD_MANAGER_FRAME;
class PROJECT_TREE_ITEM;
class PROJECT_TREE;
/** PROJECT_TREE_PANE
* Window to display the tree files
*/
class PROJECT_TREE_PANE : public wxSashLayoutWindow
{
friend class PROJECT_TREE_ITEM;
public:
PROJECT_TREE_PANE( KICAD_MANAGER_FRAME* parent );
~PROJECT_TREE_PANE();
/**
* Create or modify the tree showing project file names
*/
void ReCreateTreePrj();
/**
* 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
*/
void FileWatcherReset();
/**
* Delete all @ref m_TreeProject entries
*/
void EmptyTreePrj();
protected:
static wxString GetFileExt( TREE_FILE_TYPE type );
/**
* 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
*/
std::vector<PROJECT_TREE_ITEM*> GetSelectedData();
/**
* Function GetItemIdData
* return the item data corresponding to a wxTreeItemId identifier
* @param aId = the wxTreeItemId identifier.
* @return a PROJECT_TREE_ITEM pointer corresponding to item id aId
*/
PROJECT_TREE_ITEM* GetItemIdData( wxTreeItemId aId );
private:
/**
* Called on a double click on an item
*/
void onSelect( wxTreeEvent& Event );
/**
* Called on a click on the + or - button of an item with children
*/
void onExpand( wxTreeEvent& Event );
/**
* Called on a right click on an item
*/
void onRight( wxTreeEvent& Event );
/**
* Function onOpenSelectedFileWithTextEditor
* Call the text editor to open the selected file in the tree project
*/
void onOpenSelectedFileWithTextEditor( wxCommandEvent& event );
/**
* Function onDeleteFile
* Delete the selected file or directory in the tree project
*/
void onDeleteFile( wxCommandEvent& event );
/**
* Function onRenameFile
* Rename the selected file or directory in the tree project
*/
void onRenameFile( wxCommandEvent& event );
/**
* Function onOpenDirectory
* Handles the right-click menu for opening a directory in the current system file browser
*/
void onOpenDirectory( wxCommandEvent& event );
/**
* Function onCreateNewDirectory
* Creates a new subdirectory inside the current kicad project directory the user is
* prompted to enter a directory name
*/
void onCreateNewDirectory( wxCommandEvent& event );
/**
* Switch to a other project selected from the tree project (by selecting an other .pro
* file inside the current project folder)
*/
void onSwitchToSelectedProject( wxCommandEvent& event );
/**
* Idle event handler, used process the selected items at a point in time
* when all other events have been consumed
*/
void onIdle( wxIdleEvent& aEvent );
/**
* We don't have uniform borders so we have to draw them ourselves.
*/
void onPaint( wxPaintEvent& aEvent );
/**
* 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.)
*/
void shutdownFileWatcher();
/**
* Function addItemToProjectTree
* @brief Add the file or directory aName to the project tree
* @param aName = the filename or the directory name to add in tree
* @param aParent = the wxTreeItemId item where to add sub tree items
* @param aRecurse = true to add file or subdir names to the current tree item
* false to stop file add.
* @return the Id for the new tree item
*/
wxTreeItemId addItemToProjectTree( const wxString& aName, const wxTreeItemId& aParent,
std::vector<wxString>* aProjectNames, bool aRecurse );
/**
* Function findSubdirTreeItem
* searches for the item in tree project which is the node of the subdirectory aSubDir
* @param aSubDir = the directory to find in tree
* @return 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
*/
wxTreeItemId findSubdirTreeItem( const wxString& aSubDir );
/**
* 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 onFileSystemEvent( wxFileSystemWatcherEvent& event );
void onThemeChanged( wxSysColourChangedEvent &aEvent );
public:
KICAD_MANAGER_FRAME* m_Parent;
PROJECT_TREE* m_TreeProject;
private:
bool m_isRenaming; // Are we in the process of renaming a file
wxTreeItemId m_root;
std::vector<wxString> m_filters;
wxFileSystemWatcher* m_watcher; // file system watcher
PROJECT_TREE_ITEM* m_selectedItem;
bool m_watcherNeedReset; // true if FileWatcherReset() must be called
// (during an idle time for instance) after
// the main loop event handler is started
DECLARE_EVENT_TABLE()
};
#endif // TREEPRJ_FRAME_H