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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qrunnable.cpp -->
<title>Qt 4.8: QRunnable Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcore.html">QtCore</a></li>
<li>QRunnable</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QRunnable Class Reference</h1>
<!-- $$$QRunnable-brief -->
<p>The QRunnable class is the base class for all runnable objects. <a href="#details">More...</a></p>
<!-- @@@QRunnable -->
<pre class="cpp"> <span class="preprocessor">#include <QRunnable></span></pre><p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qrunnable-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qrunnable.html#QRunnable">QRunnable</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qrunnable.html#dtor.QRunnable">~QRunnable</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qrunnable.html#autoDelete">autoDelete</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qrunnable.html#run">run</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qrunnable.html#setAutoDelete">setAutoDelete</a></b> ( bool <i>autoDelete</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QRunnable-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QRunnable class is the base class for all runnable objects.</p>
<p>The QRunnable class is an interface for representing a task or piece of code that needs to be executed, represented by your reimplementation of the <a href="qrunnable.html#run">run</a>() function.</p>
<p>You can use <a href="qthreadpool.html">QThreadPool</a> to execute your code in a separate thread. <a href="qthreadpool.html">QThreadPool</a> deletes the QRunnable automatically if <a href="qrunnable.html#autoDelete">autoDelete</a>() returns true (the default). Use <a href="qrunnable.html#setAutoDelete">setAutoDelete</a>() to change the auto-deletion flag.</p>
<p><a href="qthreadpool.html">QThreadPool</a> supports executing the same QRunnable more than once by calling QThreadPool::tryStart(this) from within the <a href="qrunnable.html#run">run</a>() function. If autoDelete is enabled the QRunnable will be deleted when the last thread exits the run function. Calling <a href="qthreadpool.html#start">QThreadPool::start</a>() multiple times with the same QRunnable when autoDelete is enabled creates a race condition and is not recommended.</p>
</div>
<p><b>See also </b><a href="qthreadpool.html">QThreadPool</a>.</p>
<!-- @@@QRunnable -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRunnable[overload1]$$$QRunnable -->
<h3 class="fn"><a name="QRunnable"></a>QRunnable::<span class="name">QRunnable</span> ()</h3>
<p>Constructs a <a href="qrunnable.html">QRunnable</a>. Auto-deletion is enabled by default.</p>
<p><b>See also </b><a href="qrunnable.html#autoDelete">autoDelete</a>() and <a href="qrunnable.html#setAutoDelete">setAutoDelete</a>().</p>
<!-- @@@QRunnable -->
<!-- $$$~QRunnable[overload1]$$$~QRunnable -->
<h3 class="fn"><a name="dtor.QRunnable"></a>QRunnable::<span class="name">~QRunnable</span> ()<tt> [virtual]</tt></h3>
<p><a href="qrunnable.html">QRunnable</a> virtual destructor.</p>
<!-- @@@~QRunnable -->
<!-- $$$autoDelete[overload1]$$$autoDelete -->
<h3 class="fn"><a name="autoDelete"></a><span class="type">bool</span> QRunnable::<span class="name">autoDelete</span> () const</h3>
<p>Returns true is auto-deletion is enabled; false otherwise.</p>
<p>If auto-deletion is enabled, <a href="qthreadpool.html">QThreadPool</a> will automatically delete this runnable after calling <a href="qrunnable.html#run">run</a>(); otherwise, ownership remains with the application programmer.</p>
<p><b>See also </b><a href="qrunnable.html#setAutoDelete">setAutoDelete</a>() and <a href="qthreadpool.html">QThreadPool</a>.</p>
<!-- @@@autoDelete -->
<!-- $$$run[overload1]$$$run -->
<h3 class="fn"><a name="run"></a><span class="type">void</span> QRunnable::<span class="name">run</span> ()<tt> [pure virtual]</tt></h3>
<p>Implement this pure virtual function in your subclass.</p>
<!-- @@@run -->
<!-- $$$setAutoDelete[overload1]$$$setAutoDeletebool -->
<h3 class="fn"><a name="setAutoDelete"></a><span class="type">void</span> QRunnable::<span class="name">setAutoDelete</span> ( <span class="type">bool</span> <i>autoDelete</i> )</h3>
<p>Enables auto-deletion if <i>autoDelete</i> is true; otherwise auto-deletion is disabled.</p>
<p>If auto-deletion is enabled, <a href="qthreadpool.html">QThreadPool</a> will automatically delete this runnable after calling <a href="qrunnable.html#run">run</a>(); otherwise, ownership remains with the application programmer.</p>
<p>Note that this flag must be set before calling <a href="qthreadpool.html#start">QThreadPool::start</a>(). Calling this function after <a href="qthreadpool.html#start">QThreadPool::start</a>() results in undefined behavior.</p>
<p><b>See also </b><a href="qrunnable.html#autoDelete">autoDelete</a>() and <a href="qthreadpool.html">QThreadPool</a>.</p>
<!-- @@@setAutoDelete -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
