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">
6
<title>Marble.AbstractDataPlugin</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" />
18
<img alt ="" src="../common/top-kde.jpg"/>
19
KDE 4.7 PyKDE API Reference
23
<div id="header_bottom">
26
<li>KDE's Python API</li>
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>
41
<div id="body_wrapper">
46
<div class="clearer"> </div>
48
<h1>AbstractDataPlugin Class Reference</h1>
49
<code>from PyKDE4.marble import *</code>
51
Inherits: <a href="../marble/Marble.RenderPlugin.html">Marble.RenderPlugin</a> → QObject<br />
53
Namespace: <a href="../marble/Marble.html">Marble</a><br />
54
<h2>Detailed Description</h2>
55
<dl class="abstract" compact><dt><b>Abstract class:</b></dt>
56
<dd>This class can be used as a base class for new classes, but can not be instantiated directly.</dd></dl>
57
<p>@short: An abstract class for plugins that show data that has a geo coordinate
60
This is the abstract class for plugins that show data on Marble map.
61
It takes care of painting all items it gets from the corresponding AbstractDataPluginModel
62
that has to be set on initialisation.
65
The user has to set the nameId as well as the number of items to fetch.
66
Additionally it should be useful to set standard values via setEnabled (often true)
67
and setVisible (often false) in the constructor of a subclass.
69
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
70
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#changedNumberOfItems">changedNumberOfItems</a> (long number)</td></tr>
71
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
72
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AbstractDataPlugin">__init__</a> (self)</td></tr>
73
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#backendTypes">backendTypes</a> (self)</td></tr>
74
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#initialize">initialize</a> (self)</td></tr>
75
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isInitialized">isInitialized</a> (self)</td></tr>
76
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../marble/Marble.AbstractDataPluginModel.html">Marble.AbstractDataPluginModel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#model">model</a> (self)</td></tr>
77
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#nameId">nameId</a> (self)</td></tr>
78
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#numberOfItems">numberOfItems</a> (self)</td></tr>
79
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#render">render</a> (self, <a href="../marble/Marble.GeoPainter.html">Marble.GeoPainter</a> painter, <a href="../marble/Marble.ViewportParams.html">Marble.ViewportParams</a> viewport, QString renderPos="NONE", <a href="../marble/Marble.GeoSceneLayer.html">Marble.GeoSceneLayer</a> layer=0)</td></tr>
80
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#renderPolicy">renderPolicy</a> (self)</td></tr>
81
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#renderPosition">renderPosition</a> (self)</td></tr>
82
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../marble/Marble.RenderPlugin.html#RenderType">Marble.RenderPlugin.RenderType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#renderType">renderType</a> (self)</td></tr>
83
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModel">setModel</a> (self, <a href="../marble/Marble.AbstractDataPluginModel.html">Marble.AbstractDataPluginModel</a> model)</td></tr>
84
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setNameId">setNameId</a> (self, QString name)</td></tr>
85
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setNumberOfItems">setNumberOfItems</a> (self, long number)</td></tr>
86
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../marble/Marble.AbstractDataPluginItem.html">Marble.AbstractDataPluginItem</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#whichItemAt">whichItemAt</a> (self, QPoint curpos)</td></tr>
88
<hr><h2>Signal Documentation</h2><a class="anchor" name="changedNumberOfItems"></a>
90
<div class="memproto">
91
<table class="memname"><tr>
92
<td class="memname"> changedNumberOfItems</td>
94
<td class="paramtype">long </td>
95
<td class="paramname"><em>number</em></td>
102
<td width="100%"> </td>
105
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("changedNumberOfItems(quint32)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="AbstractDataPlugin"></a>
106
<div class="memitem">
107
<div class="memproto">
108
<table class="memname"><tr>
109
<td class="memname">__init__</td>
111
<td class="paramtype"> </td>
112
<td class="paramname"><em>self</em> )</td>
113
<td width="100%"> </td>
117
<div class="memdoc"></div></div><a class="anchor" name="backendTypes"></a>
118
<div class="memitem">
119
<div class="memproto">
120
<table class="memname"><tr>
121
<td class="memname">QStringList backendTypes</td>
123
<td class="paramtype"> </td>
124
<td class="paramname"><em>self</em> )</td>
125
<td width="100%"> </td>
129
<div class="memdoc"><p>Returns the name(s) of the backend that the plugin can render
130
</p></div></div><a class="anchor" name="initialize"></a>
131
<div class="memitem">
132
<div class="memproto">
133
<table class="memname"><tr>
134
<td class="memname"> initialize</td>
136
<td class="paramtype"> </td>
137
<td class="paramname"><em>self</em> )</td>
138
<td width="100%"> </td>
142
<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>Initialized the plugin and make it ready to be painted.
143
</p></div></div><a class="anchor" name="isInitialized"></a>
144
<div class="memitem">
145
<div class="memproto">
146
<table class="memname"><tr>
147
<td class="memname">bool isInitialized</td>
149
<td class="paramtype"> </td>
150
<td class="paramname"><em>self</em> )</td>
151
<td width="100%"> </td>
155
<div class="memdoc"></div></div><a class="anchor" name="model"></a>
156
<div class="memitem">
157
<div class="memproto">
158
<table class="memname"><tr>
159
<td class="memname"><a href="../marble/Marble.AbstractDataPluginModel.html">Marble.AbstractDataPluginModel</a> model</td>
161
<td class="paramtype"> </td>
162
<td class="paramname"><em>self</em> )</td>
163
<td width="100%"> </td>
167
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> The model associated with the plugin.
169
</p></div></div><a class="anchor" name="nameId"></a>
170
<div class="memitem">
171
<div class="memproto">
172
<table class="memname"><tr>
173
<td class="memname">QString nameId</td>
175
<td class="paramtype"> </td>
176
<td class="paramname"><em>self</em> )</td>
177
<td width="100%"> </td>
181
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns the nameId of the item
183
</p></div></div><a class="anchor" name="numberOfItems"></a>
184
<div class="memitem">
185
<div class="memproto">
186
<table class="memname"><tr>
187
<td class="memname">long numberOfItems</td>
189
<td class="paramtype"> </td>
190
<td class="paramname"><em>self</em> )</td>
191
<td width="100%"> </td>
195
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> The number of items to be shown at the same time.
197
</p></div></div><a class="anchor" name="render"></a>
198
<div class="memitem">
199
<div class="memproto">
200
<table class="memname"><tr>
201
<td class="memname">bool render</td>
203
<td class="paramtype"> <em>self</em>, </td>
204
<td class="paramname"></td>
206
<td class="memname"></td>
208
<td class="paramtype"><a href="../marble/Marble.GeoPainter.html">Marble.GeoPainter</a> </td>
209
<td class="paramname"><em>painter</em>, </td>
212
<td class="memname"></td>
214
<td class="paramtype"><a href="../marble/Marble.ViewportParams.html">Marble.ViewportParams</a> </td>
215
<td class="paramname"><em>viewport</em>, </td>
218
<td class="memname"></td>
220
<td class="paramtype">QString </td>
221
<td class="paramname"><em>renderPos="NONE"</em>, </td>
224
<td class="memname"></td>
226
<td class="paramtype"><a href="../marble/Marble.GeoSceneLayer.html">Marble.GeoSceneLayer</a> </td>
227
<td class="paramname"><em>layer=0</em></td>
234
<td width="100%"> </td>
237
<div class="memdoc"><p>Renders the content provided by the plugin on the viewport.
238
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true Returns whether the rendering has been successful
240
</p></div></div><a class="anchor" name="renderPolicy"></a>
241
<div class="memitem">
242
<div class="memproto">
243
<table class="memname"><tr>
244
<td class="memname">QString renderPolicy</td>
246
<td class="paramtype"> </td>
247
<td class="paramname"><em>self</em> )</td>
248
<td width="100%"> </td>
252
<div class="memdoc"><p>Return how the plugin settings should be used.
253
</p></div></div><a class="anchor" name="renderPosition"></a>
254
<div class="memitem">
255
<div class="memproto">
256
<table class="memname"><tr>
257
<td class="memname">QStringList renderPosition</td>
259
<td class="paramtype"> </td>
260
<td class="paramname"><em>self</em> )</td>
261
<td width="100%"> </td>
265
<div class="memdoc"><p>Preferred level in the layer stack for the rendering
266
</p></div></div><a class="anchor" name="renderType"></a>
267
<div class="memitem">
268
<div class="memproto">
269
<table class="memname"><tr>
270
<td class="memname"><a href="../marble/Marble.RenderPlugin.html#RenderType">Marble.RenderPlugin.RenderType</a> renderType</td>
272
<td class="paramtype"> </td>
273
<td class="paramname"><em>self</em> )</td>
274
<td width="100%"> </td>
278
<div class="memdoc"><p>Function for returning the type of plugin this is for.
279
This affects where in the menu tree the action() is placed.
282
@return: The type of render plugin this is.
283
</p></div></div><a class="anchor" name="setModel"></a>
284
<div class="memitem">
285
<div class="memproto">
286
<table class="memname"><tr>
287
<td class="memname"> setModel</td>
289
<td class="paramtype"> <em>self</em>, </td>
290
<td class="paramname"></td>
292
<td class="memname"></td>
294
<td class="paramtype"><a href="../marble/Marble.AbstractDataPluginModel.html">Marble.AbstractDataPluginModel</a> </td>
295
<td class="paramname"><em>model</em></td>
302
<td width="100%"> </td>
305
<div class="memdoc"><p>Set the model of the plugin.
306
</p></div></div><a class="anchor" name="setNameId"></a>
307
<div class="memitem">
308
<div class="memproto">
309
<table class="memname"><tr>
310
<td class="memname"> setNameId</td>
312
<td class="paramtype"> <em>self</em>, </td>
313
<td class="paramname"></td>
315
<td class="memname"></td>
317
<td class="paramtype">QString </td>
318
<td class="paramname"><em>name</em></td>
325
<td width="100%"> </td>
328
<div class="memdoc"><p>Set the name id of the plugin
329
</p></div></div><a class="anchor" name="setNumberOfItems"></a>
330
<div class="memitem">
331
<div class="memproto">
332
<table class="memname"><tr>
333
<td class="memname"> setNumberOfItems</td>
335
<td class="paramtype"> <em>self</em>, </td>
336
<td class="paramname"></td>
338
<td class="memname"></td>
340
<td class="paramtype">long </td>
341
<td class="paramname"><em>number</em></td>
348
<td width="100%"> </td>
351
<div class="memdoc"><p>Set the number of items to be shown at the same time.
352
</p></div></div><a class="anchor" name="whichItemAt"></a>
353
<div class="memitem">
354
<div class="memproto">
355
<table class="memname"><tr>
356
<td class="memname">[<a href="../marble/Marble.AbstractDataPluginItem.html">Marble.AbstractDataPluginItem</a>] whichItemAt</td>
358
<td class="paramtype"> <em>self</em>, </td>
359
<td class="paramname"></td>
361
<td class="memname"></td>
363
<td class="paramtype">QPoint </td>
364
<td class="paramname"><em>curpos</em></td>
371
<td width="100%"> </td>
374
<div class="memdoc"><p>This function returns all items at the position <b>curpos.</b> Depending on where they have
375
been painted the last time.
378
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The items at the given position.
387
<div class="menu_box">
388
<div class="nav_list">
390
<li><a href="../allclasses.html">Full Index</a></li>
394
<a name="cp-menu" /><div class="menutitle"><div>
395
<h2 id="cp-menu-project">Modules</h2>
397
<div class="nav_list">
398
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
399
<li><a href="../dnssd/index.html">dnssd</a></li>
400
<li><a href="../kdecore/index.html">kdecore</a></li>
401
<li><a href="../kdeui/index.html">kdeui</a></li>
402
<li><a href="../khtml/index.html">khtml</a></li>
403
<li><a href="../kio/index.html">kio</a></li>
404
<li><a href="../knewstuff/index.html">knewstuff</a></li>
405
<li><a href="../kparts/index.html">kparts</a></li>
406
<li><a href="../kutils/index.html">kutils</a></li>
407
<li><a href="../nepomuk/index.html">nepomuk</a></li>
408
<li><a href="../phonon/index.html">phonon</a></li>
409
<li><a href="../plasma/index.html">plasma</a></li>
410
<li><a href="../polkitqt/index.html">polkitqt</a></li>
411
<li><a href="../solid/index.html">solid</a></li>
412
<li><a href="../soprano/index.html">soprano</a></li>
418
<div class="clearer"/>
421
<div id="end_body"></div>
423
<div id="footer"><div id="footer_text">
424
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
425
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> |
426
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
added
removed
docs/bindings/python/html/marble/Marble.AbstractDataPlugin.html
