<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/core/qxtmultisignalwaiter.cpp -->
<head>
<title>QxtMultiSignalWaiter Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtMultiSignalWaiter Class Reference<br /><span class="small-subtitle">[<a href="qxtcore.html">QxtCore</a> module]</span>
</h1>
<p>The QxtMultiSignalWaiter class blocks and processes events until a group of signals is emitted <a href="#details">More...</a></p>
<pre> #include <QxtMultiSignalWaiter></pre><p>Inherits <a href="qxtsignalgroup.html">QxtSignalGroup</a>.</p>
<ul>
<li><a href="qxtmultisignalwaiter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtmultisignalwaiter.html#QxtMultiSignalWaiter">QxtMultiSignalWaiter</a></b> ( QObject * <i>parent</i> = 0 )</li>
<li><div class="fn"></div>virtual <b><a href="qxtmultisignalwaiter.html#dtor.QxtMultiSignalWaiter">~QxtMultiSignalWaiter</a></b> ()</li>
<li><div class="fn"></div>bool <b><a href="qxtmultisignalwaiter.html#waitForAll">waitForAll</a></b> ( int <i>msec</i> = -1, QEventLoop::ProcessEventsFlags <i>flags</i> = QEventLoop::AllEvents )</li>
<li><div class="fn"></div>bool <b><a href="qxtmultisignalwaiter.html#waitForAny">waitForAny</a></b> ( int <i>msec</i> = -1, QEventLoop::ProcessEventsFlags <i>flags</i> = QEventLoop::AllEvents )</li>
</ul>
<ul>
<li><div class="fn"></div>5 public functions inherited from <a href="qxtsignalgroup.html#public-functions">QxtSignalGroup</a></li>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="qxtsignalgroup.html#public-slots">QxtSignalGroup</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
<li><div class="fn"></div>2 signals inherited from <a href="qxtsignalgroup.html#signals">QxtSignalGroup</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtMultiSignalWaiter class blocks and processes events until a group of signals is emitted</p>
<p>Code written in a synchronous style will sometimes need to block until any of several conditions are met, or until all of a set of conditions are met. This class allows a group of signals to be defined and waited upon in a simple AND or OR fashion. More complex Boolean relationships can be written by connecting together multiple <a href="qxtsignalgroup.html">QxtSignalGroup</a> objects and waiting for all or any of these groups to emit one of their signals.</p>
<p><b>Note:</b> QxtMultiSignalWaiter is subject to the same reentrancy problems as <a href="qxtsignalwaiter.html">QxtSignalWaiter</a>.</p>
<p>See also <a href="qxtsignalwaiter.html">QxtSignalWaiter</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtMultiSignalWaiter"></a>QxtMultiSignalWaiter::QxtMultiSignalWaiter ( <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a <a href="qxtmultisignalwaiter.html">QxtMultiSignalWaiter</a> with the specified <i>parent</i>.</p>
<h3 class="fn"><a name="dtor.QxtMultiSignalWaiter"></a>QxtMultiSignalWaiter::~QxtMultiSignalWaiter () <tt> [virtual]</tt></h3>
<p>Destructs the multi signal waiter.</p>
<h3 class="fn"><a name="waitForAll"></a>bool QxtMultiSignalWaiter::waitForAll ( int <i>msec</i> = -1, <a href="http://doc.qtsoftware.com/4.5/qeventloop.html#ProcessEventsFlags-typedef">QEventLoop::ProcessEventsFlags</a> <i>flags</i> = QEventLoop::AllEvents )</h3>
<p>Blocks the current function by processing events from the event queue according to <i>flags</i> until all of the signals in the group have been emitted. If <i>msec</i> is not <tt>-1</tt>, waitForAll() will return before all of the signals are emitted if the specified number of milliseconds have elapsed. Returns <tt>true</tt> if each signal was caught at least once, or <tt>false</tt> if the timeout elapsed. Note that waitForAll() may continue to block after the last signal is emitted or the timeout elapses; the function only guarantees that it will not return BEFORE one of these conditions has occurred. This function is not reentrant.</p>
<p>See also <a href="qxtsignalgroup.html#addSignal">QxtSignalGroup::addSignal</a>() and <a href="qxtsignalgroup.html#allSignalsReceived">QxtSignalGroup::allSignalsReceived</a>().</p>
<h3 class="fn"><a name="waitForAny"></a>bool QxtMultiSignalWaiter::waitForAny ( int <i>msec</i> = -1, <a href="http://doc.qtsoftware.com/4.5/qeventloop.html#ProcessEventsFlags-typedef">QEventLoop::ProcessEventsFlags</a> <i>flags</i> = QEventLoop::AllEvents )</h3>
<p>Blocks the current function by processing events from the event queue according to <i>flags</i> until any of the signals in the group are emitted. If <i>msec</i> is not <tt>-1</tt>, waitForAny() will return before a signal is emitted if the specified number of milliseconds have elapsed. Returns <tt>true</tt> if a signal was caught, or <tt>false</tt> if the timeout elapsed. Note that waitForAny() may continue to block after a signal is emitted or the timeout elapses; the function only guarantees that it will not return BEFORE one of these conditions has occurred. This function is not reentrant.</p>
<p>See also <a href="qxtsignalgroup.html#addSignal">QxtSignalGroup::addSignal</a>() and <a href="qxtsignalgroup.html#firstSignalReceived">QxtSignalGroup::firstSignalReceived</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
