KDE 4.2 API Reference project
KDevelop::IProjectFileManager Class Reference
#include <iprojectfilemanager.h>
Detailed Description
An interface to project file management.FileManager is the class you want to implement for integrating a project manager in KDevelop. For build systems, implement its child class, BuildManager.
These classes do not cause files, folders etc. to be created or removed on disk. They simply read from and write to the file(s) which describe the structure (eg. CMakeLists.txt for cmake, Makefile.am for automake, etc).
Definition at line 57 of file iprojectfilemanager.h.
Public Types | |
| enum | Feature { None = 0, Folders = 1 << 0, Targets = 1 << 1, Files = 1 << 2 } |
Signals | |
| void | fileAdded (ProjectFileItem *file) |
| void | fileRemoved (ProjectFileItem *file) |
| void | fileRenamed (const KUrl &oldFile, ProjectFileItem *newFile) |
| void | folderAdded (ProjectFolderItem *folder) |
| void | folderRemoved (ProjectFolderItem *folder) |
| void | folderRenamed (const KUrl &oldFolder, ProjectFolderItem *newFolder) |
| void | projectItemConfigWidget (const QList< ProjectBaseItem * > &dom, KDialogBase *dialog) |
Public Member Functions | |
| virtual ProjectFileItem * | addFile (const KUrl &folder, ProjectFolderItem *parent)=0 |
| virtual ProjectFolderItem * | addFolder (const KUrl &folder, ProjectFolderItem *parent)=0 |
| virtual Features | features () const =0 |
| virtual ProjectFolderItem * | import (IProject *project)=0 |
| virtual QList < ProjectFolderItem * > | parse (ProjectFolderItem *dom)=0 |
| virtual bool | reload (ProjectBaseItem *item)=0 |
| virtual bool | removeFile (ProjectFileItem *file)=0 |
| virtual bool | removeFolder (ProjectFolderItem *folder)=0 |
| virtual bool | renameFile (ProjectFileItem *oldFile, const KUrl &newFile)=0 |
| virtual bool | renameFolder (ProjectFolderItem *oldFolder, const KUrl &newFolder)=0 |
Member Enumeration Documentation
Features the file manager supports.
- Enumerator:
-
None This manager supports nothing. Folders Folders are supported by the manager. Targets Targets are supported by the manager. Files Files are supported by the manager.
Definition at line 63 of file iprojectfilemanager.h.
Member Function Documentation
| virtual ProjectFileItem* KDevelop::IProjectFileManager::addFile | ( | const KUrl & | folder, | |
| ProjectFolderItem * | parent | |||
| ) | [pure virtual] |
Add a file to a folder.
Adds the file specified by file to the folder parent and modifies the underlying build system if needed. The file is not added to a target
| virtual ProjectFolderItem* KDevelop::IProjectFileManager::addFolder | ( | const KUrl & | folder, | |
| ProjectFolderItem * | parent | |||
| ) | [pure virtual] |
Add a folder to the project.
Adds the folder specified by folder to parent and modifies the underlying build system if needed
| virtual Features KDevelop::IProjectFileManager::features | ( | ) | const [pure virtual] |
- Returns:
- the Features supported by the filemanager
| virtual ProjectFolderItem* KDevelop::IProjectFileManager::import | ( | IProject * | project | ) | [pure virtual] |
This method creates the root item from the file.
- fileName
- Returns:
- The created item
| virtual QList<ProjectFolderItem*> KDevelop::IProjectFileManager::parse | ( | ProjectFolderItem * | dom | ) | [pure virtual] |
This method initialize the model item.
- dom
- Returns:
- The list of the sub folders
| virtual bool KDevelop::IProjectFileManager::reload | ( | ProjectBaseItem * | item | ) | [pure virtual] |
Reload an item in the project.
Reloads the item specified by item
| virtual bool KDevelop::IProjectFileManager::removeFile | ( | ProjectFileItem * | file | ) | [pure virtual] |
Remove a file from the project.
Removes the file specified by file and modifies the underlying build system if needed. If the file being removed is also part of a target, it should be removed from the target as well
| virtual bool KDevelop::IProjectFileManager::removeFolder | ( | ProjectFolderItem * | folder | ) | [pure virtual] |
Remove a folder from the project.
Removes the folder specified by folder from folder parent and modifies the underlying build system if needed.
| virtual bool KDevelop::IProjectFileManager::renameFile | ( | ProjectFileItem * | oldFile, | |
| const KUrl & | newFile | |||
| ) | [pure virtual] |
Rename a file in the project.
Renames the file specified by oldFile to newFile
| virtual bool KDevelop::IProjectFileManager::renameFolder | ( | ProjectFolderItem * | oldFolder, | |
| const KUrl & | newFolder | |||
| ) | [pure virtual] |
Rename a folder in the project.
Renames the folder specified by oldFile to newFile
The documentation for this class was generated from the following files:
