← Back to branch summary

~neon/pykde4/master

« back to all changes in this revision

Viewing changes to docs/html/ktexteditor/KTextEditor.TemplateScriptRegistrar.html

  • Committer: Simon Edwards
  • Date: 2013-05-17 19:15:12 UTC
  • Revision ID: git-v1:a46160bff9c0346159e2d50fd33680a25403b964
Updated the ktexteditor bindings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/ktexteditor/KTextEditor.TemplateScriptRegistrar.html
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 
4
 
 
5
<head>
 
6
  <title>KTextEditor.TemplateScriptRegistrar</title>
 
7
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
8
  <meta http-equiv="Content-Style-Type" content="text/css" />
 
9
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
 
10
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
 
11
</head>
 
12
<body>
 
13
<div id="container">
 
14
<div id="header">
 
15
  <div id="header_top">
 
16
    <div>
 
17
      <div>
 
18
        <img alt ="" src="../common/top-kde.jpg"/>
 
19
        KDE 4.9 PyKDE API Reference
 
20
      </div>
 
21
    </div>
 
22
  </div>
 
23
  <div id="header_bottom">
 
24
    <div id="location">
 
25
      <ul>
 
26
        <li>KDE's Python API</li>
 
27
      </ul>
 
28
    </div>
 
29
 
 
30
    <div id="menu">
 
31
      <ul>
 
32
        <li><a href="../modules.html">Overview</a></li>
 
33
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
 
34
<li><a href="http://kde.org/family/">Sitemap</a></li>
 
35
<li><a href="http://kde.org/contact/">Contact Us</a></li>
 
36
</ul>
 
37
    </div>
 
38
  </div>
 
39
</div>
 
40
 
 
41
<div id="body_wrapper">
 
42
<div id="body">
 
43
<div id="right">
 
44
<div class="content">
 
45
<div id="main">
 
46
<div class="clearer">&nbsp;</div>
 
47
 
 
48
<h1>TemplateScriptRegistrar Class Reference</h1>
 
49
<code>from PyKDE4.ktexteditor import *</code>
 
50
<p>
 
51
 
 
52
 
 
53
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
 
54
<h2>Detailed Description</h2>
 
55
 
 
56
<p><dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
 
57
This is an interface for inserting template strings with user editable
 
58
fields into a document and support for scripts. Fold back into base Interface in KDE 5
 
59
</dd></dl>
 
60
</p>
 
61
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#TemplateScriptRegistrar">__init__</a> (self)</td></tr>
 
63
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.TemplateScript.html">KTextEditor.TemplateScript</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#registerTemplateScript">registerTemplateScript</a> (self, QObject owner, QString script)</td></tr>
 
64
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#unregisterTemplateScript">unregisterTemplateScript</a> (self, <a href="../ktexteditor/KTextEditor.TemplateScript.html">KTextEditor.TemplateScript</a> templateScript)</td></tr>
 
65
</table>
 
66
<hr><h2>Method Documentation</h2><a class="anchor" name="TemplateScriptRegistrar"></a>
 
67
<div class="memitem">
 
68
<div class="memproto">
 
69
<table class="memname"><tr>
 
70
<td class="memname">__init__</td>
 
71
<td>(</td>
 
72
<td class="paramtype">&nbsp;</td>
 
73
<td class="paramname"><em>self</em>&nbsp;)</td>
 
74
<td width="100%"> </td>
 
75
</tr>
 
76
</table>
 
77
</div>
 
78
<div class="memdoc"></div></div><a class="anchor" name="registerTemplateScript"></a>
 
79
<div class="memitem">
 
80
<div class="memproto">
 
81
<table class="memname"><tr>
 
82
<td class="memname"><a href="../ktexteditor/KTextEditor.TemplateScript.html">KTextEditor.TemplateScript</a> registerTemplateScript</td>
 
83
<td>(</td>
 
84
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
85
<td class="paramname"></td>
 
86
</tr><tr>
 
87
<td class="memname"></td>
 
88
<td></td>
 
89
<td class="paramtype">QObject&nbsp;</td>
 
90
<td class="paramname"><em>owner</em>, </td>
 
91
</tr>
 
92
<tr>
 
93
<td class="memname"></td>
 
94
<td></td>
 
95
<td class="paramtype">QString&nbsp;</td>
 
96
<td class="paramname"><em>script</em></td>
 
97
</tr>
 
98
<tr>
 
99
<td></td>
 
100
<td>)</td>
 
101
<td></td>
 
102
<td></td>
 
103
<td width="100%"> </td>
 
104
</tr></table>
 
105
</div>
 
106
<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>This registeres the script, which is contained in </p><dl compact><dt><b>Parameters:</b></dt><dd>
 
107
<table border="0" cellspacing="2" cellpadding="0">
 
108
<tr><td></td><td valign="top"><em>script.</em>&nbsp;</td><td>
 
109
</td></tr> </table></dl>
 
110
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the template script pointer, returns an empty QString on error
 
111
The implementation has to register the script for all views and all documents,
 
112
== globally
 
113
If owner is destructed, all scripts owned by it are automatically freed.
 
114
Scripts have to be self contained.
 
115
Depending on the underlying editor, there might be some global functions,
 
116
perhaps there will be a specifiction for a common functionset later on, but not
 
117
yet.
 
118
</dd></dl>
 
119
</p></div></div><a class="anchor" name="unregisterTemplateScript"></a>
 
120
<div class="memitem">
 
121
<div class="memproto">
 
122
<table class="memname"><tr>
 
123
<td class="memname"> unregisterTemplateScript</td>
 
124
<td>(</td>
 
125
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
126
<td class="paramname"></td>
 
127
</tr><tr>
 
128
<td class="memname"></td>
 
129
<td></td>
 
130
<td class="paramtype"><a href="../ktexteditor/KTextEditor.TemplateScript.html">KTextEditor.TemplateScript</a>&nbsp;</td>
 
131
<td class="paramname"><em>templateScript</em></td>
 
132
</tr>
 
133
<tr>
 
134
<td></td>
 
135
<td>)</td>
 
136
<td></td>
 
137
<td></td>
 
138
<td width="100%"> </td>
 
139
</tr></table>
 
140
</div>
 
141
<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>This frees the template script which is identified by the token
 
142
</p></div></div>
 
143
</div>
 
144
</div>
 
145
</div>
 
146
 
 
147
<div id="left">
 
148
 
 
149
<div class="menu_box">
 
150
<div class="nav_list">
 
151
<ul>
 
152
<li><a href="../allclasses.html">Full Index</a></li>
 
153
</ul>
 
154
</div>
 
155
 
 
156
<a name="cp-menu" /><div class="menutitle"><div>
 
157
  <h2 id="cp-menu-project">Modules</h2>
 
158
</div></div>
 
159
<div class="nav_list">
 
160
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
 
161
<li><a href="../dnssd/index.html">dnssd</a></li>
 
162
<li><a href="../kdecore/index.html">kdecore</a></li>
 
163
<li><a href="../kdeui/index.html">kdeui</a></li>
 
164
<li><a href="../khtml/index.html">khtml</a></li>
 
165
<li><a href="../kio/index.html">kio</a></li>
 
166
<li><a href="../knewstuff/index.html">knewstuff</a></li>
 
167
<li><a href="../kparts/index.html">kparts</a></li>
 
168
<li><a href="../kutils/index.html">kutils</a></li>
 
169
<li><a href="../nepomuk/index.html">nepomuk</a></li>
 
170
<li><a href="../phonon/index.html">phonon</a></li>
 
171
<li><a href="../plasma/index.html">plasma</a></li>
 
172
<li><a href="../polkitqt/index.html">polkitqt</a></li>
 
173
<li><a href="../solid/index.html">solid</a></li>
 
174
<li><a href="../soprano/index.html">soprano</a></li>
 
175
</ul></div></div>
 
176
 
 
177
</div>
 
178
 
 
179
</div>
 
180
  <div class="clearer"/>
 
181
</div>
 
182
 
 
183
<div id="end_body"></div>
 
184
</div>
 
185
<div id="footer"><div id="footer_text">
 
186
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
 
187
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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> |
 
188
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
 
189
    </div></div>
 
190
</body>
 
191
</html>