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 pathclassPythonQtDebugAPI.html
More file actions
330 lines (304 loc) · 17.7 KB
/
Copy pathclassPythonQtDebugAPI.html
File metadata and controls
330 lines (304 loc) · 17.7 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PythonQt: PythonQtDebugAPI 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PythonQt
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-slots">Public Slots</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classPythonQtDebugAPI-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PythonQtDebugAPI Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Some helper methods that allow testing of the ownership.
<a href="classPythonQtDebugAPI.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PythonQtStdDecorators_8h_source.html">PythonQtStdDecorators.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PythonQtDebugAPI:</div>
<div class="dyncontent">
<div class="center">
<img src="classPythonQtDebugAPI.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr class="memitem:a1a5f773d5e695cfd0a07b0e1f430b1fd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#a1a5f773d5e695cfd0a07b0e1f430b1fd">isOwnedByPython</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:a1a5f773d5e695cfd0a07b0e1f430b1fd"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the C++ object is owned by <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton.">PythonQt</a> and will be deleted when the reference goes away. <a href="classPythonQtDebugAPI.html#a1a5f773d5e695cfd0a07b0e1f430b1fd">More...</a><br /></td></tr>
<tr class="separator:a1a5f773d5e695cfd0a07b0e1f430b1fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0946300930153357865d4b6faabd76c0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#a0946300930153357865d4b6faabd76c0">isDerivedShellInstance</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:a0946300930153357865d4b6faabd76c0"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the C++ object is an instance of a Python class that derives a C++ class. <a href="classPythonQtDebugAPI.html#a0946300930153357865d4b6faabd76c0">More...</a><br /></td></tr>
<tr class="separator:a0946300930153357865d4b6faabd76c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4ac2a776e5f4d376ae71f9b7a5555bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#ac4ac2a776e5f4d376ae71f9b7a5555bc">hasExtraShellRefCount</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:ac4ac2a776e5f4d376ae71f9b7a5555bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the shell instance has an extra ref count from the C++ side. <a href="classPythonQtDebugAPI.html#ac4ac2a776e5f4d376ae71f9b7a5555bc">More...</a><br /></td></tr>
<tr class="separator:ac4ac2a776e5f4d376ae71f9b7a5555bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba5626baefe03e323298e689afbaf3dc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#aba5626baefe03e323298e689afbaf3dc">passOwnershipToCPP</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:aba5626baefe03e323298e689afbaf3dc"><td class="mdescLeft"> </td><td class="mdescRight">Pass the ownership of the given object to CPP (so that it will not be deleted by Python if the reference goes away) <a href="classPythonQtDebugAPI.html#aba5626baefe03e323298e689afbaf3dc">More...</a><br /></td></tr>
<tr class="separator:aba5626baefe03e323298e689afbaf3dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0fe53f543a007e7a077e136743a5000"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#aa0fe53f543a007e7a077e136743a5000">passOwnershipToPython</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:aa0fe53f543a007e7a077e136743a5000"><td class="mdescLeft"> </td><td class="mdescRight">Pass the ownership of the given object to Python (so that the C++ object will be deleted when the Python reference goes away) <a href="classPythonQtDebugAPI.html#aa0fe53f543a007e7a077e136743a5000">More...</a><br /></td></tr>
<tr class="separator:aa0fe53f543a007e7a077e136743a5000"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7218fb5467ccdc2589b97d00d0c07a5e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#a7218fb5467ccdc2589b97d00d0c07a5e">isPythonQtInstanceWrapper</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:a7218fb5467ccdc2589b97d00d0c07a5e"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the given object is a <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton.">PythonQt</a> instance wrapper (or derived class) <a href="classPythonQtDebugAPI.html#a7218fb5467ccdc2589b97d00d0c07a5e">More...</a><br /></td></tr>
<tr class="separator:a7218fb5467ccdc2589b97d00d0c07a5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ac8699b03390ce68699c7323853e221"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#a6ac8699b03390ce68699c7323853e221">isPythonQtClassWrapper</a> (<a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> *object)</td></tr>
<tr class="memdesc:a6ac8699b03390ce68699c7323853e221"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the given object is a <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton.">PythonQt</a> class wrapper (or derived class) <a href="classPythonQtDebugAPI.html#a6ac8699b03390ce68699c7323853e221">More...</a><br /></td></tr>
<tr class="separator:a6ac8699b03390ce68699c7323853e221"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a61698239e76f3608e8dca87cd6747873"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPythonQtDebugAPI.html#a61698239e76f3608e8dca87cd6747873">PythonQtDebugAPI</a> (QObject *parent)</td></tr>
<tr class="separator:a61698239e76f3608e8dca87cd6747873"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Some helper methods that allow testing of the ownership. </p>
<p class="definition">Definition at line <a class="el" href="PythonQtStdDecorators_8h_source.html#l00211">211</a> of file <a class="el" href="PythonQtStdDecorators_8h_source.html">PythonQtStdDecorators.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a61698239e76f3608e8dca87cd6747873"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61698239e76f3608e8dca87cd6747873">◆ </a></span>PythonQtDebugAPI()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PythonQtDebugAPI::PythonQtDebugAPI </td>
<td>(</td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PythonQtStdDecorators_8h_source.html#l00215">215</a> of file <a class="el" href="PythonQtStdDecorators_8h_source.html">PythonQtStdDecorators.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> :QObject(parent) {};</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac4ac2a776e5f4d376ae71f9b7a5555bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4ac2a776e5f4d376ae71f9b7a5555bc">◆ </a></span>hasExtraShellRefCount</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::hasExtraShellRefCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if the shell instance has an extra ref count from the C++ side. </p>
</div>
</div>
<a id="a0946300930153357865d4b6faabd76c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0946300930153357865d4b6faabd76c0">◆ </a></span>isDerivedShellInstance</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::isDerivedShellInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if the C++ object is an instance of a Python class that derives a C++ class. </p>
</div>
</div>
<a id="a1a5f773d5e695cfd0a07b0e1f430b1fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a5f773d5e695cfd0a07b0e1f430b1fd">◆ </a></span>isOwnedByPython</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::isOwnedByPython </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if the C++ object is owned by <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton.">PythonQt</a> and will be deleted when the reference goes away. </p>
</div>
</div>
<a id="a6ac8699b03390ce68699c7323853e221"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ac8699b03390ce68699c7323853e221">◆ </a></span>isPythonQtClassWrapper</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::isPythonQtClassWrapper </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if the given object is a <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton.">PythonQt</a> class wrapper (or derived class) </p>
</div>
</div>
<a id="a7218fb5467ccdc2589b97d00d0c07a5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7218fb5467ccdc2589b97d00d0c07a5e">◆ </a></span>isPythonQtInstanceWrapper</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::isPythonQtInstanceWrapper </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if the given object is a <a class="el" href="classPythonQt.html" title="The main interface to the Python Qt binding, realized as a singleton.">PythonQt</a> instance wrapper (or derived class) </p>
</div>
</div>
<a id="aba5626baefe03e323298e689afbaf3dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba5626baefe03e323298e689afbaf3dc">◆ </a></span>passOwnershipToCPP</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::passOwnershipToCPP </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pass the ownership of the given object to CPP (so that it will not be deleted by Python if the reference goes away) </p>
</div>
</div>
<a id="aa0fe53f543a007e7a077e136743a5000"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0fe53f543a007e7a077e136743a5000">◆ </a></span>passOwnershipToPython</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PythonQtDebugAPI::passOwnershipToPython </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PythonQtMethodInfo_8h.html#afcb7b4d4ac414eefbeef02c60e6acb52">PyObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pass the ownership of the given object to Python (so that the C++ object will be deleted when the Python reference goes away) </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PythonQtStdDecorators_8h_source.html">PythonQtStdDecorators.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 23 2024 10:20:36 for PythonQt by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
You can’t perform that action at this time.