project_tree_pane.h

Go to the documentation of this file.

/*
 * 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
 */

#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;

class PROJECT_TREE_PANE : public wxSashLayoutWindow
{
 friend class PROJECT_TREE_ITEM;

public:
 PROJECT_TREE_PANE( KICAD_MANAGER_FRAME* parent );
 ~PROJECT_TREE_PANE();

 void ReCreateTreePrj();

 void FileWatcherReset();

 void EmptyTreePrj();

protected:
 static wxString GetFileExt( TREE_FILE_TYPE type );

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

 PROJECT_TREE_ITEM* GetItemIdData( wxTreeItemId aId );

private:
 void onSelect( wxTreeEvent& Event );

 void onExpand( wxTreeEvent& Event );

 void onRight( wxTreeEvent& Event );

 void onOpenSelectedFileWithTextEditor( wxCommandEvent& event );

 void onDeleteFile( wxCommandEvent& event );

 void onRenameFile( wxCommandEvent& event );

 void onOpenDirectory( wxCommandEvent& event );

 void onCreateNewDirectory( wxCommandEvent& event );

 void onSwitchToSelectedProject( wxCommandEvent& event );

 void onIdle( wxIdleEvent& aEvent );

 void onPaint( wxPaintEvent& aEvent );

 void shutdownFileWatcher();

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

 wxTreeItemId findSubdirTreeItem( const wxString& aSubDir );

 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