iprojectfilemanager.h

Go to the documentation of this file.

/* This file is part of KDevelop
    Copyright 2004 Roberto Raggi <[email protected]>
    Copyright 2006 Matt Rogers <[email protected]>
    Copyright 2006 Hamish Rodda <[email protected]>
    Copyright 2007 Andreas Pakulat <[email protected]
    Copyright 2012 Milian Wolff <[email protected]>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_IPROJECTFILEMANAGER_H
#define KDEVPLATFORM_IPROJECTFILEMANAGER_H
 
#include <QObject>
 
#include <project/projectexport.h>
 
#include <util/path.h>
 
class KJob;
 
namespace KDevelop
{
 
class IProject;
class ProjectBaseItem;
class ProjectFolderItem;
class ProjectFileItem;
 
class KDEVPLATFORMPROJECT_EXPORT IProjectFileManager
{
public:
 
    virtual ~IProjectFileManager();
    enum Feature
    {
        None     = 0 ,     
        Folders  = 1 << 0, 
        Targets  = 1 << 1, 
        Files    = 1 << 2  
    };
    Q_DECLARE_FLAGS( Features, Feature )
 
    
    virtual Features features() const = 0;
 
    virtual QList<ProjectFolderItem*> parse(ProjectFolderItem *dom) = 0;
 
    virtual ProjectFolderItem *import(IProject *project) = 0;
 
    virtual KJob* createImportJob(ProjectFolderItem* item);
 
    virtual ProjectFolderItem* addFolder(const Path& folder, ProjectFolderItem* parent) = 0;
 
    virtual ProjectFileItem* addFile(const Path& file, ProjectFolderItem *parent) = 0;
 
    virtual bool removeFilesAndFolders(const QList<ProjectBaseItem*> &items) = 0;
 
    virtual bool moveFilesAndFolders(const QList< KDevelop::ProjectBaseItem* > &items, KDevelop::ProjectFolderItem* newParent) = 0;
 
    virtual bool copyFilesAndFolders(const Path::List &items, KDevelop::ProjectFolderItem* newParent) = 0;
 
    virtual bool renameFile(ProjectFileItem* file, const Path& newPath) = 0;
 
    virtual bool renameFolder(ProjectFolderItem* oldFolder, const Path& newPath) = 0;
 
    virtual bool reload(ProjectFolderItem* item) = 0;
 
Q_SIGNALS:
    void folderAdded(KDevelop::ProjectFolderItem* folder);
    void folderRemoved(KDevelop::ProjectFolderItem* folder);
    void folderRenamed(const KDevelop::Path& oldFolder, KDevelop::ProjectFolderItem* newFolder);
 
    void fileAdded(KDevelop::ProjectFileItem* file);
    void fileRemoved(KDevelop::ProjectFileItem* file);
    void fileRenamed(const KDevelop::Path& oldFile, KDevelop::ProjectFileItem* newFile);
};
 
#if QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
Q_DECLARE_OPERATORS_FOR_FLAGS(IProjectFileManager::Features)
#endif
 
}
 
#if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
Q_DECLARE_OPERATORS_FOR_FLAGS(KDevelop::IProjectFileManager::Features)
#endif
 
Q_DECLARE_INTERFACE( KDevelop::IProjectFileManager, "org.kdevelop.IProjectFileManager")
 
#endif