kate Library API Documentation

Kate::Project Class Reference

Interface to the project. More...

#include <project.h>

List of all members.

Signals

void dirsAdded (const QString &dir, const QStringList &dirs)
void dirsRemoved (const QString &dir, const QStringList &dirs)
void filesAdded (const QString &dir, const QStringList &files)
void filesRemoved (const QString &dir, const QStringList &files)

Public Member Functions

 Project (void *project)
virtual ~Project ()
unsigned int projectNumber () const
DCOPObject * dcopObject ()
ProjectPlugin * plugin () const
KConfig * data ()
KConfig * dirData (const QString &dir=QString::null)
KConfig * fileData (const QString &file=QString::null)
QString type ()
QString name ()
QString fileName ()
QString dir ()
bool save ()
bool queryClose ()
bool close ()
QStringList dirs (const QString &dir=QString::null)
QStringList files (const QString &dir=QString::null)
void addDirs (const QString &dir, QStringList &dirs)
void removeDirs (const QString &dir, QStringList &dirs)
void addFiles (const QString &dir, QStringList &files)
void removeFiles (const QString &dir, QStringList &files)


Detailed Description

Interface to the project.

Definition at line 34 of file project.h.


Constructor & Destructor Documentation

Kate::Project::Project void *  project  ) 
 

Construtor, should not interest, internal usage.

Definition at line 66 of file project.cpp.

Kate::Project::~Project  )  [virtual]
 

Desctructor.

Definition at line 83 of file project.cpp.


Member Function Documentation

ProjectPlugin * Kate::Project::plugin  )  const
 

Returns the project plugin of this project object.

Returns:
ProjectPlugin project plugin of this project
Definition at line 98 of file project.cpp.

KConfig * Kate::Project::data  ) 
 

Raw access to config file.

Returns:
KConfig config data
Definition at line 103 of file project.cpp.

QString Kate::Project::type  ) 
 

Return the project type.

Returns:
QString project type
Definition at line 128 of file project.cpp.

QString Kate::Project::name  ) 
 

Return the project name.

Returns:
QString project name
Definition at line 133 of file project.cpp.

QString Kate::Project::fileName  ) 
 

Return the filename of the project file.

Returns:
QString project filename
Definition at line 138 of file project.cpp.

QString Kate::Project::dir  ) 
 

Return the dir of the project.

Returns:
QString project dir
Definition at line 143 of file project.cpp.

bool Kate::Project::save  ) 
 

Saves the project.

Returns:
bool success
Definition at line 148 of file project.cpp.

bool Kate::Project::queryClose  ) 
 

Query if the project can be closed now, don't close it, only ask questions or save it, or ...

Returns:
bool success
Definition at line 155 of file project.cpp.

bool Kate::Project::close  ) 
 

Close the project (says the project plugin the app requests a close, prepare for deletion).

Returns:
bool success
Definition at line 160 of file project.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Aug 31 00:02:10 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003