• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • TDevelop Interfaces Library
 

TDevelop Interfaces Library

  • lib
  • interfaces
kdevproject.h
Go to the documentation of this file.
1/* This file is part of the KDE project
2 Copyright (C) 2001 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
3 Copyright (C) 2001-2002 Bernd Gehrmann <bernd@kdevelop.org>
4 Copyright (C) 2002-2003 Roberto Raggi <roberto@kdevelop.org>
5 Copyright (C) 2002 Simon Hausmann <hausmann@kde.org>
6 Copyright (C) 2003 Jens Dagerbo <jens.dagerbo@swipnet.se>
7 Copyright (C) 2003 Mario Scalas <mario.scalas@libero.it>
8 Copyright (C) 2003-2004 Alexander Dymo <adymo@kdevelop.org>
9
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Library General Public
12 License as published by the Free Software Foundation; either
13 version 2 of the License, or (at your option) any later version.
14
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Library General Public License for more details.
19
20 You should have received a copy of the GNU Library General Public License
21 along with this library; see the file COPYING.LIB. If not, write to
22 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA.
24*/
25#ifndef KDEVPROJECT_H
26#define KDEVPROJECT_H
27
28#include "kdevplugin.h"
29#include "domutil.h"
30
31#include <tqstringlist.h>
32#include <tqmap.h>
33
39class TQTimer;
40
48class KDevProject: public KDevPlugin
49{
50 TQ_OBJECT
51
52public:
62 KDevProject(const KDevPluginInfo *info, TQObject *parent=0, const char *name=0);
64 virtual ~KDevProject();
65
67 enum Options {
68 UsesOtherBuildSystem = 0 ,
69 UsesAutotoolsBuildSystem = 1 ,
70 UsesTQMakeBuildSystem =2
71 };
72
80 virtual void openProject(const TQString &dirName, const TQString &projectName);
81
83 virtual void closeProject() = 0;
84
87 virtual Options options() const;
88
91 virtual TQString projectDirectory() const = 0;
92
94 virtual TQString projectName() const = 0;
95
97 virtual DomUtil::PairList runEnvironmentVars() const = 0;
98
101 virtual TQString mainProgram() const = 0;
102
104 virtual TQString runDirectory() const = 0;
105
107 virtual TQString runArguments() const = 0;
108
110 virtual TQString debugArguments() const = 0;
111
115 virtual TQString activeDirectory() const = 0;
116
121 virtual TQString buildDirectory() const = 0;
122
125 virtual TQStringList allFiles() const = 0;
126
129 virtual TQStringList distFiles() const = 0;
130
133 virtual void addFiles(const TQStringList &fileList) = 0;
134
137 virtual void addFile(const TQString &fileName)= 0;
138
141 virtual void removeFiles(const TQStringList& fileList)= 0;
142
145 virtual void removeFile(const TQString &fileName) = 0;
146
150 virtual void changedFiles(const TQStringList &fileList);
151
154 virtual void changedFile(const TQString &fileName);
155
158 virtual bool isProjectFile(const TQString &absFileName);
159
162 virtual TQString relativeProjectFile(const TQString &absFileName);
163
165 virtual TQStringList symlinkProjectFiles();
166
167protected:
168
181 TQString defaultRunDirectory(const TQString& projectPluginName) const;
182
183private slots:
184 void buildFileMap();
185 void slotBuildFileMap();
186 void slotAddFilesToFileMap(const TQStringList & fileList );
187 void slotRemoveFilesFromFileMap(const TQStringList & fileList );
188
189signals:
193 void addedFilesToProject(const TQStringList& fileList);
194
198 void removedFilesFromProject(const TQStringList& fileList);
199
202 void changedFilesInProject(const TQStringList& fileList);
203
206 void projectCompiled();
207
212 void activeDirectoryChanged( const TQString& olddir, const TQString& newdir );
213
214private:
215 class Private;
216 Private *d;
217};
218
219#endif
KDevPluginInfo
Information about TDevelop plugin.
Definition kdevplugininfo.h:40
KDevPlugin
The base class for all TDevelop plugins.
Definition kdevplugin.h:108
KDevPlugin::info
const KDevPluginInfo * info()
Provides an information about the plugin.
Definition kdevplugin.cpp:134
KDevProject
KDevelop project interface.
Definition kdevproject.h:49
KDevProject::~KDevProject
virtual ~KDevProject()
Destructor.
Definition kdevproject.cpp:54
KDevProject::projectCompiled
void projectCompiled()
Emitted when one compile related command (make, make install, make ...) ends sucessfuly.
KDevProject::relativeProjectFile
virtual TQString relativeProjectFile(const TQString &absFileName)
Definition kdevproject.cpp:86
KDevProject::options
virtual Options options() const
Reimplement this method to set project plugin options.
Definition kdevproject.cpp:76
KDevProject::removeFile
virtual void removeFile(const TQString &fileName)=0
Removes a file from the project.
KDevProject::addedFilesToProject
void addedFilesToProject(const TQStringList &fileList)
Emitted when a new list of files has been added to the project.
KDevProject::projectDirectory
virtual TQString projectDirectory() const =0
KDevProject::runEnvironmentVars
virtual DomUtil::PairList runEnvironmentVars() const =0
KDevProject::removeFiles
virtual void removeFiles(const TQStringList &fileList)=0
Removes a list of files from the project.
KDevProject::closeProject
virtual void closeProject()=0
This method is invoked when the project is about to be closed.
KDevProject::removedFilesFromProject
void removedFilesFromProject(const TQStringList &fileList)
Emitted when a list of files has been removed from the project.
KDevProject::debugArguments
virtual TQString debugArguments() const =0
The command line arguments that the mainProgram() should be debugged with.
KDevProject::defaultRunDirectory
TQString defaultRunDirectory(const TQString &projectPluginName) const
Default implementation of runDirectory method.
Definition kdevproject.cpp:128
KDevProject::symlinkProjectFiles
virtual TQStringList symlinkProjectFiles()
Definition kdevproject.cpp:123
KDevProject::addFiles
virtual void addFiles(const TQStringList &fileList)=0
Adds a list of files to the project.
KDevProject::changedFiles
virtual void changedFiles(const TQStringList &fileList)
Notifies the project about changes to the files.
Definition kdevproject.cpp:71
KDevProject::changedFilesInProject
void changedFilesInProject(const TQStringList &fileList)
Emitted when a list of files has changed in the project.
KDevProject::openProject
virtual void openProject(const TQString &dirName, const TQString &projectName)
This method is invoked when the project is opened (i.e.
Definition kdevproject.cpp:118
KDevProject::isProjectFile
virtual bool isProjectFile(const TQString &absFileName)
Definition kdevproject.cpp:81
KDevProject::activeDirectory
virtual TQString activeDirectory() const =0
Returns the path (relative to the project directory) of the active directory.
KDevProject::changedFile
virtual void changedFile(const TQString &fileName)
Notifies the project of a change to one of the files.
Definition kdevproject.cpp:62
KDevProject::runArguments
virtual TQString runArguments() const =0
The command line arguments that the mainProgram() should be run with.
KDevProject::activeDirectoryChanged
void activeDirectoryChanged(const TQString &olddir, const TQString &newdir)
Emitted when the active directory of the project changes.
KDevProject::projectName
virtual TQString projectName() const =0
Returns the name of the project.
KDevProject::allFiles
virtual TQStringList allFiles() const =0
KDevProject::Options
Options
Options of the project plugin.
Definition kdevproject.h:67
KDevProject::UsesTQMakeBuildSystem
@ UsesTQMakeBuildSystem
Project uses qmake for building.
Definition kdevproject.h:70
KDevProject::UsesOtherBuildSystem
@ UsesOtherBuildSystem
Project uses unknown or unspecified build system or build system is not used at all.
Definition kdevproject.h:68
KDevProject::UsesAutotoolsBuildSystem
@ UsesAutotoolsBuildSystem
Project uses autotools for building.
Definition kdevproject.h:69
KDevProject::distFiles
virtual TQStringList distFiles() const =0
KDevProject::buildDirectory
virtual TQString buildDirectory() const =0
KDevProject::runDirectory
virtual TQString runDirectory() const =0
Absolute path (directory) from where the mainProgram() should be run.
KDevProject::mainProgram
virtual TQString mainProgram() const =0
KDevProject::addFile
virtual void addFile(const TQString &fileName)=0
Adds a file to the project.
kdevplugin.h
TDevelop plugin interface.

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for TDevelop Interfaces Library by doxygen 1.9.8
This website is maintained by Timothy Pearson.