<?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" />
<!-- qeventloop.cpp -->
<title>Qt 4.8: QEventLoop Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<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>QEventLoop</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></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-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QEventLoop Class Reference</h1>
<!-- $$$QEventLoop-brief -->
<p>The QEventLoop class provides a means of entering and leaving an event loop. <a href="#details">More...</a></p>
<!-- @@@QEventLoop -->
<pre class="cpp"> <span class="preprocessor">#include <QEventLoop></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<ul>
<li><a href="qeventloop-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#ProcessEventsFlag-enum">ProcessEventsFlag</a></b> { AllEvents, ExcludeUserInputEvents, ExcludeSocketNotifiers, WaitForMoreEvents, DeferredDeletion }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#ProcessEventsFlag-enum">ProcessEventsFlags</a></b></td></tr>
</table>
<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="qeventloop.html#QEventLoop">QEventLoop</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#dtor.QEventLoop">~QEventLoop</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#exec">exec</a></b> ( ProcessEventsFlags <i>flags</i> = AllEvents )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#exit">exit</a></b> ( int <i>returnCode</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#isRunning">isRunning</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#processEvents">processEvents</a></b> ( ProcessEventsFlags <i>flags</i> = AllEvents )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#processEvents-2">processEvents</a></b> ( ProcessEventsFlags <i>flags</i>, int <i>maxTime</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#wakeUp">wakeUp</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qeventloop.html#quit">quit</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QEventLoop-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QEventLoop class provides a means of entering and leaving an event loop.</p>
<p>At any time, you can create a QEventLoop object and call <a href="qeventloop.html#exec">exec</a>() on it to start a local event loop. From within the event loop, calling <a href="qeventloop.html#exit">exit</a>() will force <a href="qeventloop.html#exec">exec</a>() to return.</p>
</div>
<p><b>See also </b><a href="qabstracteventdispatcher.html">QAbstractEventDispatcher</a>.</p>
<!-- @@@QEventLoop -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ProcessEventsFlag$$$AllEvents$$$ExcludeUserInputEvents$$$ExcludeSocketNotifiers$$$WaitForMoreEvents$$$ExcludeUserInput$$$WaitForMore$$$X11ExcludeTimers$$$DeferredDeletion$$$EventLoopExec$$$DialogExec -->
<h3 class="flags"><a name="ProcessEventsFlag-enum"></a>enum QEventLoop::<span class="name">ProcessEventsFlag</span><br/>flags QEventLoop::<span class="name">ProcessEventsFlags</span></h3>
<p>This enum controls the types of events processed by the <a href="qeventloop.html#processEvents">processEvents</a>() functions.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QEventLoop::AllEvents</tt></td><td class="topAlign"><tt>0x00</tt></td><td class="topAlign">All events. Note that <a href="qevent.html#Type-enum">DeferredDelete</a> events are processed specially. See <a href="qobject.html#deleteLater">QObject::deleteLater</a>() for more details.</td></tr>
<tr><td class="topAlign"><tt>QEventLoop::ExcludeUserInputEvents</tt></td><td class="topAlign"><tt>0x01</tt></td><td class="topAlign">Do not process user input events, such as ButtonPress and KeyPress. Note that the events are not discarded; they will be delivered the next time <a href="qeventloop.html#processEvents">processEvents</a>() is called without the ExcludeUserInputEvents flag.</td></tr>
<tr><td class="topAlign"><tt>QEventLoop::ExcludeSocketNotifiers</tt></td><td class="topAlign"><tt>0x02</tt></td><td class="topAlign">Do not process socket notifier events. Note that the events are not discarded; they will be delivered the next time <a href="qeventloop.html#processEvents">processEvents</a>() is called without the ExcludeSocketNotifiers flag.</td></tr>
<tr><td class="topAlign"><tt>QEventLoop::WaitForMoreEvents</tt></td><td class="topAlign"><tt>0x04</tt></td><td class="topAlign">Wait for events if no pending events are available.</td></tr>
<tr><td class="topAlign"><tt>QEventLoop::DeferredDeletion</tt></td><td class="topAlign"><tt>0x10</tt></td><td class="topAlign">deprecated - do not use.</td></tr>
</table>
<p>The ProcessEventsFlags type is a typedef for <a href="qflags.html">QFlags</a><ProcessEventsFlag>. It stores an OR combination of ProcessEventsFlag values.</p>
<p><b>See also </b><a href="qeventloop.html#processEvents">processEvents</a>().</p>
<!-- @@@ProcessEventsFlag -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QEventLoop[overload1]$$$QEventLoopQObject* -->
<h3 class="fn"><a name="QEventLoop"></a>QEventLoop::<span class="name">QEventLoop</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs an event loop object with the given <i>parent</i>.</p>
<!-- @@@QEventLoop -->
<!-- $$$~QEventLoop[overload1]$$$~QEventLoop -->
<h3 class="fn"><a name="dtor.QEventLoop"></a>QEventLoop::<span class="name">~QEventLoop</span> ()</h3>
<p>Destroys the event loop object.</p>
<!-- @@@~QEventLoop -->
<!-- $$$exec[overload1]$$$execProcessEventsFlags -->
<h3 class="fn"><a name="exec"></a><span class="type">int</span> QEventLoop::<span class="name">exec</span> ( <span class="type"><a href="qeventloop.html#ProcessEventsFlag-enum">ProcessEventsFlags</a></span> <i>flags</i> = AllEvents )</h3>
<p>Enters the main event loop and waits until <a href="qeventloop.html#exit">exit</a>() is called. Returns the value that was passed to <a href="qeventloop.html#exit">exit</a>().</p>
<p>If <i>flags</i> are specified, only events of the types allowed by the <i>flags</i> will be processed.</p>
<p>It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets.</p>
<p>Generally speaking, no user interaction can take place before calling exec(). As a special case, modal widgets like <a href="qmessagebox.html">QMessageBox</a> can be used before calling exec(), because modal widgets use their own local event loop.</p>
<p>To make your application perform idle processing (i.e. executing a special function whenever there are no pending events), use a <a href="qtimer.html">QTimer</a> with 0 timeout. More sophisticated idle processing schemes can be achieved using <a href="qeventloop.html#processEvents">processEvents</a>().</p>
<p><b>See also </b><a href="qcoreapplication.html#quit">QApplication::quit</a>(), <a href="qeventloop.html#exit">exit</a>(), and <a href="qeventloop.html#processEvents">processEvents</a>().</p>
<!-- @@@exec -->
<!-- $$$exit[overload1]$$$exitint -->
<h3 class="fn"><a name="exit"></a><span class="type">void</span> QEventLoop::<span class="name">exit</span> ( <span class="type">int</span> <i>returnCode</i> = 0 )</h3>
<p>Tells the event loop to exit with a return code.</p>
<p>After this function has been called, the event loop returns from the call to <a href="qeventloop.html#exec">exec</a>(). The <a href="qeventloop.html#exec">exec</a>() function returns <i>returnCode</i>.</p>
<p>By convention, a <i>returnCode</i> of 0 means success, and any non-zero value indicates an error.</p>
<p>Note that unlike the C library function of the same name, this function <i>does</i> return to the caller -- it is event processing that stops.</p>
<p><b>See also </b><a href="qcoreapplication.html#quit">QCoreApplication::quit</a>(), <a href="qeventloop.html#quit">quit</a>(), and <a href="qeventloop.html#exec">exec</a>().</p>
<!-- @@@exit -->
<!-- $$$isRunning[overload1]$$$isRunning -->
<h3 class="fn"><a name="isRunning"></a><span class="type">bool</span> QEventLoop::<span class="name">isRunning</span> () const</h3>
<p>Returns true if the event loop is running; otherwise returns false. The event loop is considered running from the time when <a href="qeventloop.html#exec">exec</a>() is called until <a href="qeventloop.html#exit">exit</a>() is called.</p>
<p><b>See also </b><a href="qeventloop.html#exec">exec</a>() and <a href="qeventloop.html#exit">exit</a>().</p>
<!-- @@@isRunning -->
<!-- $$$processEvents[overload1]$$$processEventsProcessEventsFlags -->
<h3 class="fn"><a name="processEvents"></a><span class="type">bool</span> QEventLoop::<span class="name">processEvents</span> ( <span class="type"><a href="qeventloop.html#ProcessEventsFlag-enum">ProcessEventsFlags</a></span> <i>flags</i> = AllEvents )</h3>
<p>Processes pending events that match <i>flags</i> until there are no more events to process. Returns true if pending events were handled; otherwise returns false.</p>
<p>This function is especially useful if you have a long running operation and want to show its progress without allowing user input; i.e. by using the <a href="qeventloop.html#ProcessEventsFlag-enum">ExcludeUserInputEvents</a> flag.</p>
<p>This function is simply a wrapper for <a href="qabstracteventdispatcher.html#processEvents">QAbstractEventDispatcher::processEvents</a>(). See the documentation for that function for details.</p>
<!-- @@@processEvents -->
<!-- $$$processEvents$$$processEventsProcessEventsFlagsint -->
<h3 class="fn"><a name="processEvents-2"></a><span class="type">void</span> QEventLoop::<span class="name">processEvents</span> ( <span class="type"><a href="qeventloop.html#ProcessEventsFlag-enum">ProcessEventsFlags</a></span> <i>flags</i>, <span class="type">int</span> <i>maxTime</i> )</h3>
<p>Process pending events that match <i>flags</i> for a maximum of <i>maxTime</i> milliseconds, or until there are no more events to process, whichever is shorter. This function is especially useful if you have a long running operation and want to show its progress without allowing user input, i.e. by using the <a href="qeventloop.html#ProcessEventsFlag-enum">ExcludeUserInputEvents</a> flag.</p>
<p><b>Notes:</b></p>
<ul>
<li>This function does not process events continuously; it returns after all available events are processed.</li>
<li>Specifying the <a href="qeventloop.html#ProcessEventsFlag-enum">WaitForMoreEvents</a> flag makes no sense and will be ignored.</li>
</ul>
<!-- @@@processEvents -->
<!-- $$$quit[overload1]$$$quit -->
<h3 class="fn"><a name="quit"></a><span class="type">void</span> QEventLoop::<span class="name">quit</span> ()<tt> [slot]</tt></h3>
<p>Tells the event loop to exit normally.</p>
<p>Same as exit(0).</p>
<p><b>See also </b><a href="qcoreapplication.html#quit">QCoreApplication::quit</a>() and <a href="qeventloop.html#exit">exit</a>().</p>
<!-- @@@quit -->
<!-- $$$wakeUp[overload1]$$$wakeUp -->
<h3 class="fn"><a name="wakeUp"></a><span class="type">void</span> QEventLoop::<span class="name">wakeUp</span> ()</h3>
<p>Wakes up the event loop.</p>
<p><b>See also </b><a href="qabstracteventdispatcher.html#wakeUp">QAbstractEventDispatcher::wakeUp</a>().</p>
<!-- @@@wakeUp -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc 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>
Digia, Qt and their respective logos are trademarks of Digia Plc
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>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
