Skip to content
Navigation Menu
{{ message }}
forked from MeVisLab/pythonqt
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassPythonQtImportFileInterface.html
More file actions
335 lines (317 loc) · 16.1 KB
/
Copy pathclassPythonQtImportFileInterface.html
File metadata and controls
335 lines (317 loc) · 16.1 KB
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>PythonQt: PythonQtImportFileInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">PythonQt
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classPythonQtImportFileInterface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PythonQtImportFileInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="PythonQtImportFileInterface_8h_source.html">PythonQtImportFileInterface.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PythonQtImportFileInterface:</div>
<div class="dyncontent">
<div class="center">
<img src="classPythonQtImportFileInterface.png" usemap="#PythonQtImportFileInterface_map" alt=""/>
<map id="PythonQtImportFileInterface_map" name="PythonQtImportFileInterface_map">
<area href="classPythonQtQFileImporter.html" title="default importer implementation using QFile to load python code " alt="PythonQtQFileImporter" shape="rect" coords="0,56,169,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab0081d9edda744245557b0b86c57903a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#ab0081d9edda744245557b0b86c57903a">~PythonQtImportFileInterface</a> ()</td></tr>
<tr class="separator:ab0081d9edda744245557b0b86c57903a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9af9b596837ab97779aa1be67080b9b0"><td class="memItemLeft" align="right" valign="top">virtual QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#a9af9b596837ab97779aa1be67080b9b0">readFileAsBytes</a> (const QString &filename)=0</td></tr>
<tr class="memdesc:a9af9b596837ab97779aa1be67080b9b0"><td class="mdescLeft"> </td><td class="mdescRight">read the given file as byte array, without doing any linefeed translations <a href="#a9af9b596837ab97779aa1be67080b9b0">More...</a><br /></td></tr>
<tr class="separator:a9af9b596837ab97779aa1be67080b9b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b1305a61905ad3903506ef9dccbec60"><td class="memItemLeft" align="right" valign="top">virtual QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#a5b1305a61905ad3903506ef9dccbec60">readSourceFile</a> (const QString &filename, bool &ok)=0</td></tr>
<tr class="separator:a5b1305a61905ad3903506ef9dccbec60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed04668f6896aef1c070911adbe2f950"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#aed04668f6896aef1c070911adbe2f950">exists</a> (const QString &filename)=0</td></tr>
<tr class="memdesc:aed04668f6896aef1c070911adbe2f950"><td class="mdescLeft"> </td><td class="mdescRight">returns if the file exists <a href="#aed04668f6896aef1c070911adbe2f950">More...</a><br /></td></tr>
<tr class="separator:aed04668f6896aef1c070911adbe2f950"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac23a7fe6f3305ab740da1480f7680e62"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#ac23a7fe6f3305ab740da1480f7680e62">isEggArchive</a> (const QString &filename)=0</td></tr>
<tr class="separator:ac23a7fe6f3305ab740da1480f7680e62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6b5cb249c82f6391255b3ed6b05ad2a"><td class="memItemLeft" align="right" valign="top">virtual QDateTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#ac6b5cb249c82f6391255b3ed6b05ad2a">lastModifiedDate</a> (const QString &filename)=0</td></tr>
<tr class="memdesc:ac6b5cb249c82f6391255b3ed6b05ad2a"><td class="mdescLeft"> </td><td class="mdescRight">get the last modified data of a file <a href="#ac6b5cb249c82f6391255b3ed6b05ad2a">More...</a><br /></td></tr>
<tr class="separator:ac6b5cb249c82f6391255b3ed6b05ad2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94421f6afd832ead130655c5107d633d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#a94421f6afd832ead130655c5107d633d">ignoreUpdatedPythonSourceFiles</a> ()</td></tr>
<tr class="separator:a94421f6afd832ead130655c5107d633d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac95a7ec0b5cbd30488a71d806a0c3e0a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtImportFileInterface.html#ac95a7ec0b5cbd30488a71d806a0c3e0a">importedModule</a> (const QString &)</td></tr>
<tr class="separator:ac95a7ec0b5cbd30488a71d806a0c3e0a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Defines an abstract interface to file access for the Python import statement. see <a class="el" href="classPythonQt.html#a7887ccc0daf281f429123d243085b0fc">PythonQt::setImporter()</a> </p>
<p>Definition at line <a class="el" href="PythonQtImportFileInterface_8h_source.html#l00052">52</a> of file <a class="el" href="PythonQtImportFileInterface_8h_source.html">PythonQtImportFileInterface.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab0081d9edda744245557b0b86c57903a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual PythonQtImportFileInterface::~PythonQtImportFileInterface </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="PythonQtImportFileInterface_8h_source.html#l00056">56</a> of file <a class="el" href="PythonQtImportFileInterface_8h_source.html">PythonQtImportFileInterface.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aed04668f6896aef1c070911adbe2f950"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool PythonQtImportFileInterface::exists </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns if the file exists </p>
<p>Implemented in <a class="el" href="classPythonQtQFileImporter.html#abd02482a0be62dfbf722b719af4727a2">PythonQtQFileImporter</a>.</p>
</div>
</div>
<a class="anchor" id="a94421f6afd832ead130655c5107d633d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool PythonQtImportFileInterface::ignoreUpdatedPythonSourceFiles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>indicates that *.py files which are newer than their corresponding *.pyc files are ignored </p>
<p>Definition at line <a class="el" href="PythonQtImportFileInterface_8h_source.html#l00077">77</a> of file <a class="el" href="PythonQtImportFileInterface_8h_source.html">PythonQtImportFileInterface.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ac95a7ec0b5cbd30488a71d806a0c3e0a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void PythonQtImportFileInterface::importedModule </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>called by <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton. ">PythonQt</a> after successful import to allow recording of imports </p>
<p>Definition at line <a class="el" href="PythonQtImportFileInterface_8h_source.html#l00081">81</a> of file <a class="el" href="PythonQtImportFileInterface_8h_source.html">PythonQtImportFileInterface.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> {};</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ac23a7fe6f3305ab740da1480f7680e62"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool PythonQtImportFileInterface::isEggArchive </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns true if the given file is an egg archive (e.g. zip). If the egg is a directory then false is returned. </p>
<p>Implemented in <a class="el" href="classPythonQtQFileImporter.html#af393deeacf89f58d79c642f8b5649a60">PythonQtQFileImporter</a>.</p>
</div>
</div>
<a class="anchor" id="ac6b5cb249c82f6391255b3ed6b05ad2a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QDateTime PythonQtImportFileInterface::lastModifiedDate </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the last modified data of a file </p>
<p>Implemented in <a class="el" href="classPythonQtQFileImporter.html#a7e460eb327d7eaa00ff09989e788aa9f">PythonQtQFileImporter</a>.</p>
</div>
</div>
<a class="anchor" id="a9af9b596837ab97779aa1be67080b9b0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QByteArray PythonQtImportFileInterface::readFileAsBytes </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>read the given file as byte array, without doing any linefeed translations </p>
<p>Implemented in <a class="el" href="classPythonQtQFileImporter.html#a620cfb1a5a9e3db3a2a9f36a2511ad1e">PythonQtQFileImporter</a>.</p>
</div>
</div>
<a class="anchor" id="a5b1305a61905ad3903506ef9dccbec60"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QByteArray PythonQtImportFileInterface::readSourceFile </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"><em>ok</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>read a source file, expects a readable Python text file with translated line feeds. If the file can not be load OR it can not be verified, ok is set to false </p>
<p>Implemented in <a class="el" href="classPythonQtQFileImporter.html#a8e036f00e8498b4cdca0936d1083afe0">PythonQtQFileImporter</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PythonQtImportFileInterface_8h_source.html">PythonQtImportFileInterface.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 14 2020 15:33:31 for PythonQt by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
You can’t perform that action at this time.