1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?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</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>KTextEditor Namespace Reference</h1>
<code>from PyKDE4.ktexteditor.KTextEditor import *</code>
<p>
<h2>Detailed Description</h2>
<p>Namespace for the KDE Text Editor Interfaces.
These interfaces provide easy access to editor parts for the
applications embedding them. At the moment they are at least
supported by both the Kate Part and the Yzis Part.
</p>
<h2>Class Index</h2>
<table width="95%" align="center" border="0" cellpadding="0" cellspacing="0">
<tbody><tr><td><a name="letter_A"> A </a></td><td><a class="el" href="KTextEditor.EditorChooser.html">EditorChooser</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.RangeCommand.html">RangeCommand</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.AnnotationInterface.html">AnnotationInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_F"> F </a></td><td><a class="el" href="KTextEditor.RecoveryInterface.html">RecoveryInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.AnnotationModel.html">AnnotationModel</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.Factory.html">Factory</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_S"> S </a></td></tr>
<tr><td><a class="el" href="KTextEditor.AnnotationViewInterface.html">AnnotationViewInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_H"> H </a></td><td><a class="el" href="KTextEditor.SearchInterface.html">SearchInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.Attribute.html">Attribute</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.HighlightInterface.html">HighlightInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.SessionConfigInterface.html">SessionConfigInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a name="letter_C"> C </a></td><td><a name="letter_L"> L </a></td><td><a class="el" href="KTextEditor.SmartCursor.html">SmartCursor</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CodeCompletionInterface.html">CodeCompletionInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.LoadSaveFilterCheckPlugin.html">LoadSaveFilterCheckPlugin</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.SmartCursorNotifier.html">SmartCursorNotifier</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CodeCompletionModel.html">CodeCompletionModel</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_M"> M </a></td><td><a class="el" href="KTextEditor.SmartCursorWatcher.html">SmartCursorWatcher</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CodeCompletionModel2.html">CodeCompletionModel2</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.Mark.html">Mark</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.SmartInterface.html">SmartInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CodeCompletionModelControllerInterface3.html">CodeCompletionModelControllerInterface3</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.MarkInterface.html">MarkInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.SmartRange.html">SmartRange</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.Command.html">Command</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.MdiContainer.html">MdiContainer</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.SmartRangeNotifier.html">SmartRangeNotifier</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CommandExtension.html">CommandExtension</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.ModeInterface.html">ModeInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.SmartRangeWatcher.html">SmartRangeWatcher</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CommandInterface.html">CommandInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.ModificationInterface.html">ModificationInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_T"> T </a></td></tr>
<tr><td><a class="el" href="KTextEditor.ConfigInterface.html">ConfigInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.MovingCursor.html">MovingCursor</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.TemplateInterface.html">TemplateInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.ConfigPage.html">ConfigPage</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.MovingInterface.html">MovingInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.TemplateInterface2.html">TemplateInterface2</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.ContainerInterface.html">ContainerInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.MovingRange.html">MovingRange</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.TemplateScript.html">TemplateScript</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.CoordinatesToCursorInterface.html">CoordinatesToCursorInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.MovingRangeFeedback.html">MovingRangeFeedback</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.TemplateScriptRegistrar.html">TemplateScriptRegistrar</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.Cursor.html">Cursor</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_P"> P </a></td><td><a class="el" href="KTextEditor.TextHintInterface.html">TextHintInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a name="letter_D"> D </a></td><td><a class="el" href="KTextEditor.ParameterizedSessionConfigInterface.html">ParameterizedSessionConfigInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a name="letter_V"> V </a></td></tr>
<tr><td><a class="el" href="KTextEditor.Document.html">Document</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.Plugin.html">Plugin</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.VariableInterface.html">VariableInterface</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a name="letter_E"> E </a></td><td><a name="letter_R"> R </a></td><td><a class="el" href="KTextEditor.View.html">View</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
<tr><td><a class="el" href="KTextEditor.Editor.html">Editor</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.Range.html">Range</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td><td><a class="el" href="KTextEditor.ViewBarContainer.html">ViewBarContainer</a> (<a class="el" href="KTextEditor.html">KTextEditor</a>) </td></tr>
</table>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Plugin.html">KTextEditor.Plugin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createPlugin">createPlugin</a> (KSharedPtr<KService> service, 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> (QString libname)</td></tr>
</table>
<hr><h2>Function Documentation</h2><a class="anchor" name="createPlugin"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Plugin.html">KTextEditor.Plugin</a> createPlugin</td>
<td>(</td>
<td class="paramtype">KSharedPtr<KService> </td>
<td class="paramname"><em>service</em>, </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>Create a plugin represented by <b>service</b> with parent object <b>parent.</b>
To get the KService object you usually use KServiceTypeTrader. Example
<pre class="fragment">
KService.List list = KServiceTypeTrader.self()->query("KTextEditor/Plugin");
foreach(const KService.Ptr &service, list) {
// do something with service
}
</pre>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the plugin or NULL if it could not be loaded
</dd></dl>
</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">QString </td>
<td class="paramname"><em>libname</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Helper function for the EditorChooser.
Usually you do not have to use this function. Instead, use
KTextEditor.EditorChooser.editor().
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>libname</em> </td><td> library name, for example "katepart"
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the Editor object on success, otherwise NULL
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.EditorChooser.editor()
</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>
|
