<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KTextEditor.Factory</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>Factory Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Inherits: <a href="../kparts/KParts.Factory.html">KParts.Factory</a> → <a href="../kdecore/KPluginFactory.html">KPluginFactory</a> → QObject<br />
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>Accessor to the Editor implementation.
</p>
<p>
Topics:
- factory_intro
- factory_example
- factory_notes
</p>
<p>
<b>Introduction </b>
</p>
<p>
The Factory provides access to the chosen Editor (selected with
KTextEditor.EditorChooser). The Editor itself then provides methods
to handle documents and config options.
</p>
<p>
To access the Editor use editor().
</p>
<p>
Each KTextEditor implementation must reimplement this factory to allow
access to the editor object.
</p>
<p>
<b>Creating an Editor Part </b>
To get a kate part the following code snippet can be used:
<pre class="fragment">
KLibFactory* factory = KLibLoader.self()->factory("katepart");
KTextEditor.Factory* kte_factory =
qobject_cast<KTextEditor.Factory*>(factory);
if(kte_factory) {
// valid editor factory, it is possible to access the editor now
KTextEditor.Editor* editor = kte_factory->editor();
} else {
// error
}
</pre>
If another editor part is desired substitue the string "katepart" with the
corresponding library name.
</p>
<p>
However, if you are only interested in getting the editor part (which is
usually the case) a simple call of
<pre class="fragment">
KTextEditor.Editor* editor = KTextEditor.editor("katepart");
</pre>
is enough.
</p>
<p>
<b>Notes </b>
It is recommend to use the EditorChooser to get the used editor part. This
way the user can choose the editor implementation. The Factory itself is
not needed to get the Editor with the help of the EditorChooser.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KParts.Factory, KTextEditor.Editor
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Christoph Cullmann <cullmann@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Factory">__init__</a> (self, QObject parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Editor.html">KTextEditor.Editor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#editor">editor</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Factory"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor.
</p>
<p>
Create a new Factory with <b>parent.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> parent object
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="editor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Editor.html">KTextEditor.Editor</a> editor</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the global Editor object. The editor part implementation must
ensure that this object lives as long as any factory or document
object exists.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> global KTextEditor.Editor object
</dd></dl>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
