kate Library API Documentation

project.h

00001 /* This file is part of the KDE project
00002    Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
00003 
00004    This library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Library General Public
00006    License version 2 as published by the Free Software Foundation.
00007 
00008    This library is distributed in the hope that it will be useful,
00009    but WITHOUT ANY WARRANTY; without even the implied warranty of
00010    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011    Library General Public License for more details.
00012 
00013    You should have received a copy of the GNU Library General Public License
00014    along with this library; see the file COPYING.LIB.  If not, write to
00015    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00016    Boston, MA 02111-1307, USA.
00017 */
00018 
00019 #ifndef _KATE_PROJECT_INCLUDE_
00020 #define _KATE_PROJECT_INCLUDE_
00021 
00022 #include <qobject.h>
00023 #include <qstringlist.h>
00024 
00025 #include <kdemacros.h>
00026 
00027 class KConfig;
00028 class DCOPObject;
00029 
00030 namespace Kate
00031 {
00032 
00033   class Plugin;
00034 
00038 class KDE_EXPORT Project : public QObject
00039 {
00040   friend class PrivateProject;
00041 
00042   Q_OBJECT
00043 
00044   public:
00048     Project (void *project);
00049 
00053     virtual ~Project ();
00054 
00055     unsigned int projectNumber () const;
00056 
00057     DCOPObject *dcopObject ();
00058 
00063     class ProjectPlugin *plugin () const;
00064 
00069     KConfig *data ();
00070 
00071     KConfig *dirData (const QString &dir = QString::null);
00072 
00073     KConfig *fileData (const QString &file = QString::null);
00074 
00075     KConfig *pluginData(Plugin *plugin,const QString& group=QString::null);
00076 
00081     QString type ();
00082 
00087     QString name ();
00088 
00093     QString fileName ();
00094 
00099     QString dir ();
00100 
00105     bool save ();
00106 
00112     bool queryClose ();
00113     
00118     bool close ();
00119 
00120     QStringList dirs (const QString &dir = QString::null);
00121 
00122     QStringList files (const QString &dir = QString::null);
00123 
00124     void addDirs (const QString &dir, QStringList &dirs);
00125     void removeDirs (const QString &dir, QStringList &dirs);
00126 
00127     void addFiles (const QString &dir, QStringList &files);
00128     void removeFiles (const QString &dir, QStringList &files);
00129 
00130   #undef signals
00131   #define signals public
00132   signals:
00133   #undef signals
00134   #define signals protected
00135 
00136     void dirsAdded (const QString &dir, const QStringList &dirs);
00137     void dirsRemoved (const QString &dir, const QStringList &dirs);
00138 
00139     void filesAdded (const QString &dir, const QStringList &files);
00140     void filesRemoved (const QString &dir, const QStringList &files);
00141 
00142   private:
00146     class PrivateProject *d;
00147     static unsigned int globalProjectNumber;
00148     unsigned int myProjectNumber;
00149 };
00150 
00151 }
00152 
00153 #endif
KDE Logo
This file is part of the documentation for kate Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Sep 30 18:40:32 2005 by doxygen 1.4.3 written by Dimitri van Heesch, © 1997-2003