<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <title>kate Library: Kate::Project Class Reference (kate Library)</title> <link href="../../common/doxygen.css" rel="stylesheet" type="text/css"> </head> <div class="header"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td rowspan="2" width="92"> <a href="../../index.html" title="The API documentation main page"><img src="../../common/docheadergears.png" style="border:0px;" alt=""></a> </td> <td width="95%"> <h1>kate Library API Documentation</h1> </td> </tr> <tr> <td valign="bottom"> <table class="links" border=0 cellspacing=0> <tr> <td><a href="index.html">Overview</a></td> <td><a href="hierarchy.html" title="Inheritance list, sorted roughly alphabetically">Class Hierarchy</a></td> <td><a href="classes.html" title="Alphabetical list of classes">Classes</a></td> <td><a href="annotated.html" title="Classes, structs, unions and interfaces with brief descriptions">Classes (annotated)</a></td> <td><a href="functions.html" title="Documented class members with links to the classes they belong to">Members</a></td> <td><a href="namespaces.html" title="All documented namespaces with brief descriptions">Namespaces</a></td> <td><a href="files.html" title="A list of all documented files with brief descriptions">Source Files</a></td> </tr> </table> </td></tr></table> </div> <div id="hgrad"></div> <div class="text"> <!-- Generated by Doxygen 1.4.4 --> <div class="nav"> <a class="el" href="namespaceKate.html">Kate</a>::<a class="el" href="classKate_1_1Project.html">Project</a></div> <h1>Kate::Project Class Reference</h1><!-- doxytag: class="Kate::Project" --><!-- doxytag: inherits="QObject" -->Interface to the project. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="project_8h-source.html">project.h</a>></code> <p> <a href="classKate_1_1Project-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Signals</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="l0"></a><!-- doxytag: member="Kate::Project::dirsAdded" ref="l0" args="(const QString &dir, const QStringList &dirs)" --> void </td><td class="memItemRight" valign="bottom"><b>dirsAdded</b> (const QString &dir, const QStringList &dirs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="l1"></a><!-- doxytag: member="Kate::Project::dirsRemoved" ref="l1" args="(const QString &dir, const QStringList &dirs)" --> void </td><td class="memItemRight" valign="bottom"><b>dirsRemoved</b> (const QString &dir, const QStringList &dirs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="l2"></a><!-- doxytag: member="Kate::Project::filesAdded" ref="l2" args="(const QString &dir, const QStringList &files)" --> void </td><td class="memItemRight" valign="bottom"><b>filesAdded</b> (const QString &dir, const QStringList &files)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="l3"></a><!-- doxytag: member="Kate::Project::filesRemoved" ref="l3" args="(const QString &dir, const QStringList &files)" --> void </td><td class="memItemRight" valign="bottom"><b>filesRemoved</b> (const QString &dir, const QStringList &files)</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a0">Project</a> (void *project)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a1">~Project</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Kate::Project::projectNumber" ref="a2" args="() const " --> unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a2">projectNumber</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Kate::Project::dcopObject" ref="a3" args="()" --> DCOPObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a3">dcopObject</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKate_1_1ProjectPlugin.html">ProjectPlugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a4">plugin</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">KConfig * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a5">data</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Kate::Project::dirData" ref="a6" args="(const QString &dir=QString::null)" --> KConfig * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a6">dirData</a> (const QString &dir=QString::null)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="Kate::Project::fileData" ref="a7" args="(const QString &file=QString::null)" --> KConfig * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a7">fileData</a> (const QString &file=QString::null)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="Kate::Project::pluginData" ref="a8" args="(Plugin *plugin, const QString &group=QString::null)" --> KConfig * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a8">pluginData</a> (<a class="el" href="classKate_1_1Plugin.html">Plugin</a> *plugin, const QString &group=QString::null)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a9">type</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a10">name</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a11">fileName</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a12">dir</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a13">save</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a14">queryClose</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a15">close</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a16"></a><!-- doxytag: member="Kate::Project::dirs" ref="a16" args="(const QString &dir=QString::null)" --> QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a16">dirs</a> (const QString &dir=QString::null)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a17"></a><!-- doxytag: member="Kate::Project::files" ref="a17" args="(const QString &dir=QString::null)" --> QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a17">files</a> (const QString &dir=QString::null)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18"></a><!-- doxytag: member="Kate::Project::addDirs" ref="a18" args="(const QString &dir, QStringList &dirs)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a18">addDirs</a> (const QString &dir, QStringList &dirs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a19"></a><!-- doxytag: member="Kate::Project::removeDirs" ref="a19" args="(const QString &dir, QStringList &dirs)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a19">removeDirs</a> (const QString &dir, QStringList &dirs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a20"></a><!-- doxytag: member="Kate::Project::addFiles" ref="a20" args="(const QString &dir, QStringList &files)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a20">addFiles</a> (const QString &dir, QStringList &files)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a21"></a><!-- doxytag: member="Kate::Project::removeFiles" ref="a21" args="(const QString &dir, QStringList &files)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#a21">removeFiles</a> (const QString &dir, QStringList &files)</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="n0"></a><!-- doxytag: member="Kate::Project::PrivateProject" ref="n0" args="" --> class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Project.html#n0">PrivateProject</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Interface to the project. <p> <p> Definition at line <a class="el" href="project_8h-source.html#l00038">38</a> of file <a class="el" href="project_8h-source.html">project.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a0"></a><!-- doxytag: member="Kate::Project::Project" ref="a0" args="(void *project)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Kate::Project::Project </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void * </td> <td class="mdname1" valign="top" nowrap> <em>project</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Construtor, should not interest, internal usage. <p> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00066">66</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. <p> References <a class="el" href="project_8h-source.html#l00040">PrivateProject</a>. </td> </tr> </table> <a class="anchor" name="a1"></a><!-- doxytag: member="Kate::Project::~Project" ref="a1" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Kate::Project::~Project </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Desctructor. <p> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00083">83</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a4"></a><!-- doxytag: member="Kate::Project::plugin" ref="a4" args="() const " --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="classKate_1_1ProjectPlugin.html">ProjectPlugin</a> * Kate::Project::plugin </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns the project plugin of this project object. <p> <dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classKate_1_1ProjectPlugin.html">ProjectPlugin</a> project plugin of this project</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00098">98</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. <p> Referenced by <a class="el" href="project_8cpp-source.html#l00184">addDirs()</a>, <a class="el" href="project_8cpp-source.html#l00227">addFiles()</a>, <a class="el" href="kateprojectmanager_8cpp-source.html#l00125">KateProjectManager::close()</a>, <a class="el" href="kateprojectmanager_8cpp-source.html#l00199">KateProjectManager::disableProjectGUI()</a>, <a class="el" href="kateprojectmanager_8cpp-source.html#l00191">KateProjectManager::enableProjectGUI()</a>, <a class="el" href="project_8cpp-source.html#l00201">removeDirs()</a>, and <a class="el" href="project_8cpp-source.html#l00244">removeFiles()</a>. </td> </tr> </table> <a class="anchor" name="a5"></a><!-- doxytag: member="Kate::Project::data" ref="a5" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">KConfig * Kate::Project::data </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Raw access to config file. <p> <dl compact><dt><b>Returns:</b></dt><dd>KConfig config data</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00103">103</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. </td> </tr> </table> <a class="anchor" name="a9"></a><!-- doxytag: member="Kate::Project::type" ref="a9" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">QString Kate::Project::type </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Return the project type. <p> <dl compact><dt><b>Returns:</b></dt><dd>QString project type</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00137">137</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. <p> References <a class="el" href="project_8cpp-source.html#l00118">fileData()</a>. <p> Referenced by <a class="el" href="kateprojectmanager_8cpp-source.html#l00169">KateProjectManager::createPlugin()</a>. </td> </tr> </table> <a class="anchor" name="a10"></a><!-- doxytag: member="Kate::Project::name" ref="a10" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">QString Kate::Project::name </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Return the project name. <p> <dl compact><dt><b>Returns:</b></dt><dd>QString project name</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00142">142</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. <p> References <a class="el" href="project_8cpp-source.html#l00118">fileData()</a>. <p> Referenced by <a class="el" href="kateprojecttreeview_8cpp-source.html#l00117">KateProjectTreeView::KateProjectTreeView()</a>. </td> </tr> </table> <a class="anchor" name="a11"></a><!-- doxytag: member="Kate::Project::fileName" ref="a11" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">QString Kate::Project::fileName </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Return the filename of the project file. <p> <dl compact><dt><b>Returns:</b></dt><dd>QString project filename</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00147">147</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. </td> </tr> </table> <a class="anchor" name="a12"></a><!-- doxytag: member="Kate::Project::dir" ref="a12" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">QString Kate::Project::dir </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Return the dir of the project. <p> <dl compact><dt><b>Returns:</b></dt><dd>QString project dir</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00152">152</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. <p> Referenced by <a class="el" href="kateprojecttreeview_8cpp-source.html#l00073">KateProjectTreeViewItem::init()</a>, and <a class="el" href="kateprojectdirview_8cpp-source.html#l00042">KateProjectDirView::KateProjectDirView()</a>. </td> </tr> </table> <a class="anchor" name="a13"></a><!-- doxytag: member="Kate::Project::save" ref="a13" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">bool Kate::Project::save </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Saves the project. <p> <dl compact><dt><b>Returns:</b></dt><dd>bool success</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00157">157</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. </td> </tr> </table> <a class="anchor" name="a14"></a><!-- doxytag: member="Kate::Project::queryClose" ref="a14" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">bool Kate::Project::queryClose </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Query if the project can be closed now, don't close it, only ask questions or save it, or . <p> .. <dl compact><dt><b>Returns:</b></dt><dd>bool success</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00164">164</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. </td> </tr> </table> <a class="anchor" name="a15"></a><!-- doxytag: member="Kate::Project::close" ref="a15" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">bool Kate::Project::close </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Close the project (says the project plugin the app requests a close, prepare for deletion). <p> <dl compact><dt><b>Returns:</b></dt><dd>bool success</dd></dl> <p> Definition at line <a class="el" href="project_8cpp-source.html#l00169">169</a> of file <a class="el" href="project_8cpp-source.html">project.cpp</a>. <p> Referenced by <a class="el" href="kateprojectmanager_8cpp-source.html#l00125">KateProjectManager::close()</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="project_8h-source.html">project.h</a><li><a class="el" href="project_8cpp-source.html">project.cpp</a></ul> </div> <div id="bottom-nav"> <img src="../../common/bottom2.png" align="right" height="59" width="227" alt="KDE Logo"> </div> <div class="bottom"> This file is part of the documentation for kate Library Version 3.4.2. </div> <div class="bottom" style="color:#cccccc"> Documentation copyright © 1996-2004 the KDE developers.<br> Generated on Wed Jun 14 19:05:55 2006 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.4.4 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2003 </div> </body> </html>