<!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::InitPlugin 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_1InitPlugin.html">InitPlugin</a></div>
<h1>Kate::InitPlugin Class Reference</h1><!-- doxytag: class="Kate::InitPlugin" --><!-- doxytag: inherits="Kate::Plugin" -->Inheritance diagram for Kate::InitPlugin:<p><center><img src="classKate_1_1InitPlugin__inherit__graph.png" border="0" usemap="#Kate_1_1InitPlugin__inherit__map" alt="Inheritance graph"></center>
<map name="Kate_1_1InitPlugin__inherit__map">
<area href="classKate_1_1Plugin.html" shape="rect" coords="17,7,110,34" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Kate::InitPlugin:<p><center><img src="classKate_1_1InitPlugin__coll__graph.png" border="0" usemap="#Kate_1_1InitPlugin__coll__map" alt="Collaboration graph"></center>
<map name="Kate_1_1InitPlugin__coll__map">
<area href="classKate_1_1Plugin.html" shape="rect" coords="17,7,110,34" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classKate_1_1InitPlugin-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></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_1InitPlugin.html#a0">InitPlugin</a> (<a class="el" href="classKate_1_1Application.html">Application</a> *application=0, const char *name=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Kate::InitPlugin::~InitPlugin" ref="a1" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#a1">~InitPlugin</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Kate::InitPlugin::initPluginNumber" ref="a2" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#a2">initPluginNumber</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Kate::InitPlugin::activate" ref="a3" args="(const KURL &configScript=KURL())" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#a3">activate</a> (const KURL &configScript=KURL())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#a4">actionsKateShouldNotPerformOnRealStartup</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#a5">initKate</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Kate::InitPlugin::configScript" ref="a6" args="() const " -->
const KURL </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#a6">configScript</a> () const </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::InitPlugin::PrivateInitPlugin" ref="n0" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1InitPlugin.html#n0">PrivateInitPlugin</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="plugin_8h-source.html#l00091">91</a> of file <a class="el" href="plugin_8h-source.html">plugin.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="Kate::InitPlugin::InitPlugin" ref="a0" args="(Application *application=0, const char *name=0)" --><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::InitPlugin::InitPlugin </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classKate_1_1Application.html">Application</a> * </td>
<td class="mdname" nowrap> <em>application</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>name</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Please never instanciate this class yourself from a plugin.
<p>
Use the Applications performInit(pluginname,configscript) method instead You must neither assume that theol init object still exist after control returned to the main event loop after a call to performInit nor that the init library is still loaded
<p>
Definition at line <a class="el" href="plugin_8cpp-source.html#l00163">163</a> of file <a class="el" href="plugin_8cpp-source.html">plugin.cpp</a>.
<p>
References <a class="el" href="plugin_8h-source.html#l00093">PrivateInitPlugin</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4"></a><!-- doxytag: member="Kate::InitPlugin::actionsKateShouldNotPerformOnRealStartup" ref="a4" 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">int Kate::InitPlugin::actionsKateShouldNotPerformOnRealStartup </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>
I don't create an enum, because I want this to be freely extensible Please return the or'ed values from the list, you don't need initialized by kate.
<p>
That speeds up appliaction startup. Be aware though, that you have to unload plugins or clear view/document lists yourself anyway. This is needed, because There could be a reinitialisation during the application runtime. (eg if another config script is opened)<p>
0x1: restoreDocuments 0x2: restoreViews; 0x4: loadPlugins
<p>
Definition at line <a class="el" href="plugin_8cpp-source.html#l00187">187</a> of file <a class="el" href="plugin_8cpp-source.html">plugin.cpp</a>.
<p>
Referenced by <a class="el" href="kateapp_8cpp-source.html#l00047">KateApp::KateApp()</a>. </td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="Kate::InitPlugin::initKate" 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">int Kate::InitPlugin::initKate </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>
This should initiate the real kate initialisation.
<p>
Please always return "0". The return value is for later extenstion
<p>
Definition at line <a class="el" href="plugin_8cpp-source.html#l00198">198</a> of file <a class="el" href="plugin_8cpp-source.html">plugin.cpp</a>.
<p>
Referenced by <a class="el" href="kateapp_8cpp-source.html#l00188">KateApp::newInstance()</a>, and <a class="el" href="kateapp_8cpp-source.html#l00164">KateApp::performInit()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="plugin_8h-source.html">plugin.h</a><li><a class="el" href="plugin_8cpp-source.html">plugin.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>
