PageRenderTime 42ms CodeModel.GetById 11ms RepoModel.GetById 1ms app.codeStats 0ms

/PyQt-x11-gpl-4.9.4/doc/html/qeventloop.html

#
HTML | 138 lines | 123 code | 15 blank | 0 comment | 0 complexity | 15d904b1ab0b69597887190fc43fcc04 MD5 | raw file
Possible License(s): GPL-2.0, GPL-3.0 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
    3. 

  3. <html><head><title>QEventLoop Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
    4. 

  4. a:link { color: #004faf; text-decoration: none }
    5. 

  5. a:visited { color: #672967; text-decoration: none }
    6. 

  6. td.postheader { font-family: sans-serif }
    7. 

  7. tr.address { font-family: sans-serif }
    8. 

  8. body { background: #ffffff; color: black; }
    9. 

  9. </style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QEventLoop Class Reference<br /><sup><sup>[<a href="qtcore.html">QtCore</a> module]</sup></sup></h1><p>The QEventLoop class provides a means of entering and leaving an
    10. 

  10. event loop. <a href="#details">More...</a></p>
    11. 

  11. 

  12. <p>Inherits <a href="qobject.html">QObject</a>.</p><h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qeventloop.html#ProcessEventsFlag-enum">ProcessEventsFlag</a></b> { AllEvents, ExcludeUserInputEvents, ExcludeSocketNotifiers, WaitForMoreEvents, X11ExcludeTimers, DeferredDeletion }</li><li><div class="fn" />class <b><a href="qeventloop-processeventsflags.html">ProcessEventsFlags</a></b></li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qeventloop.html#QEventLoop">__init__</a></b> (<i>self</i>, QObject&#160;<i>parent</i>&#160;=&#160;None)</li><li><div class="fn" />int <b><a href="qeventloop.html#exec">exec_</a></b> (<i>self</i>, ProcessEventsFlags&#160;<i>flags</i>&#160;=&#160;QEventLoop.AllEvents)</li><li><div class="fn" /><b><a href="qeventloop.html#exit">exit</a></b> (<i>self</i>, int&#160;<i>returnCode</i>&#160;=&#160;0)</li><li><div class="fn" />bool <b><a href="qeventloop.html#isRunning">isRunning</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qeventloop.html#processEvents">processEvents</a></b> (<i>self</i>, ProcessEventsFlags&#160;<i>flags</i>&#160;=&#160;QEventLoop.AllEvents)</li><li><div class="fn" /><b><a href="qeventloop.html#processEvents-2">processEvents</a></b> (<i>self</i>, ProcessEventsFlags&#160;<i>flags</i>, int&#160;<i>maximumTime</i>)</li><li><div class="fn" /><b><a href="qeventloop.html#quit">quit</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qeventloop.html#wakeUp">wakeUp</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QEventLoop class provides a means of entering and leaving an
    13. 

  13. event loop.</p>
    14. 

  14. <p>At any time, you can create a QEventLoop object and call
    15. 

  15. <a href="qeventloop.html#exec">exec_</a>() on it to start a local
    16. 

  16. 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>
    17. 

  17. <hr /><h2>Type Documentation</h2><h3 class="fn"><a name="ProcessEventsFlag-enum" />QEventLoop.ProcessEventsFlag</h3><p>This enum controls the types of events processed by the <a href="qeventloop.html#processEvents">processEvents</a>() functions.</p>
    18. 

  18. <table class="valuelist">
    19. 

  19. <tr class="odd" valign="top">
    20. 

  20. <th class="tblConst">Constant</th>
    21. 

  21. <th class="tblval">Value</th>
    22. 

  22. <th class="tbldscr">Description</th>
    23. 

  23. </tr>
    24. 

  24. <tr>
    25. 

  25. <td class="topAlign"><tt>QEventLoop.AllEvents</tt></td>
    26. 

  26. <td class="topAlign"><tt>0x00</tt></td>
    27. 

  27. <td class="topAlign">All events. Note that <a href="qevent.html#Type-enum">DeferredDelete</a> events are processed
    28. 

  28. specially. See <a href="qobject.html#deleteLater">QObject.deleteLater</a>() for more
    29. 

  29. details.</td>
    30. 

  30. </tr>
    31. 

  31. <tr>
    32. 

  32. <td class="topAlign">
    33. 

  33. <tt>QEventLoop.ExcludeUserInputEvents</tt></td>
    34. 

  34. <td class="topAlign"><tt>0x01</tt></td>
    35. 

  35. <td class="topAlign">Do not process user input events, such as
    36. 

  36. ButtonPress and KeyPress. Note that the events are not discarded;
    37. 

  37. they will be delivered the next time <a href="qeventloop.html#processEvents">processEvents</a>() is called
    38. 

  38. without the ExcludeUserInputEvents flag.</td>
    39. 

  39. </tr>
    40. 

  40. <tr>
    41. 

  41. <td class="topAlign">
    42. 

  42. <tt>QEventLoop.ExcludeSocketNotifiers</tt></td>
    43. 

  43. <td class="topAlign"><tt>0x02</tt></td>
    44. 

  44. <td class="topAlign">Do not process socket notifier events. Note
    45. 

  45. that the events are not discarded; they will be delivered the next
    46. 

  46. time <a href="qeventloop.html#processEvents">processEvents</a>() is
    47. 

  47. called without the ExcludeSocketNotifiers flag.</td>
    48. 

  48. </tr>
    49. 

  49. <tr>
    50. 

  50. <td class="topAlign"><tt>QEventLoop.WaitForMoreEvents</tt></td>
    51. 

  51. <td class="topAlign"><tt>0x04</tt></td>
    52. 

  52. <td class="topAlign">Wait for events if no pending events are
    53. 

  53. available.</td>
    54. 

  54. </tr>
    55. 

  55. <tr>
    56. 

  56. <td class="topAlign"><tt>QEventLoop.DeferredDeletion</tt></td>
    57. 

  57. <td class="topAlign"><tt>0x10</tt></td>
    58. 

  58. <td class="topAlign">deprecated - do not use.</td>
    59. 

  59. </tr>
    60. 

  60. </table>
    61. 

  61. <p>The ProcessEventsFlags type is a typedef for <a href="qflags.html">QFlags</a>&lt;ProcessEventsFlag&gt;. It stores an OR
    62. 

  62. combination of ProcessEventsFlag values.</p>
    63. 

  63. <p><b>See also</b> <a href="qeventloop.html#processEvents">processEvents</a>().</p>
    64. 

  64. <hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QEventLoop" />QEventLoop.__init__ (<i>self</i>, <a href="qobject.html">QObject</a>&#160;<i>parent</i>&#160;=&#160;None)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs an event loop object with the given
    65. 

  65. <i>parent</i>.</p>
    66. 

  66. 

  67. 

  68. <h3 class="fn"><a name="exec" />int QEventLoop.exec_ (<i>self</i>, <a href="qeventloop-processeventsflags.html">ProcessEventsFlags</a>&#160;<i>flags</i>&#160;=&#160;QEventLoop.AllEvents)</h3><p>Enters the main event loop and waits until <a href="qeventloop.html#exit">exit</a>() is called. Returns the value that
    69. 

  69. was passed to <a href="qeventloop.html#exit">exit</a>().</p>
    70. 

  70. <p>If <i>flags</i> are specified, only events of the types allowed
    71. 

  71. by the <i>flags</i> will be processed.</p>
    72. 

  72. <p>It is necessary to call this function to start event handling.
    73. 

  73. The main event loop receives events from the window system and
    74. 

  74. dispatches these to the application widgets.</p>
    75. 

  75. <p>Generally speaking, no user interaction can take place before
    76. 

  76. calling exec(). As a special case, modal widgets like <a href="qmessagebox.html">QMessageBox</a> can be used before calling
    77. 

  77. exec(), because modal widgets use their own local event loop.</p>
    78. 

  78. <p>To make your application perform idle processing (i.e. executing
    79. 

  79. a special function whenever there are no pending events), use a
    80. 

  80. <a href="qtimer.html">QTimer</a> with 0 timeout. More sophisticated
    81. 

  81. idle processing schemes can be achieved using <a href="qeventloop.html#processEvents">processEvents</a>().</p>
    82. 

  82. <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>
    83. 

  83. 

  84. 

  85. <h3 class="fn"><a name="exit" />QEventLoop.exit (<i>self</i>, int&#160;<i>returnCode</i>&#160;=&#160;0)</h3><p>Tells the event loop to exit with a return code.</p>
    86. 

  86. <p>After this function has been called, the event loop returns from
    87. 

  87. the call to <a href="qeventloop.html#exec">exec_</a>(). The <a href="qeventloop.html#exec">exec_</a>() function returns
    88. 

  88. <i>returnCode</i>.</p>
    89. 

  89. <p>By convention, a <i>returnCode</i> of 0 means success, and any
    90. 

  90. non-zero value indicates an error.</p>
    91. 

  91. <p>Note that unlike the C library function of the same name, this
    92. 

  92. function <i>does</i> return to the caller -- it is event processing
    93. 

  93. that stops.</p>
    94. 

  94. <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>
    95. 

  95. 

  96. 

  97. <h3 class="fn"><a name="isRunning" />bool QEventLoop.isRunning (<i>self</i>)</h3><p>Returns true if the event loop is running; otherwise returns
    98. 

  98. false. The event loop is considered running from the time when
    99. 

  99. <a href="qeventloop.html#exec">exec_</a>() is called until <a href="qeventloop.html#exit">exit</a>() is called.</p>
    100. 

  100. <p><b>See also</b> <a href="qeventloop.html#exec">exec_</a>() and
    101. 

  101. <a href="qeventloop.html#exit">exit</a>().</p>
    102. 

  102. 

  103. 

  104. <h3 class="fn"><a name="processEvents" />bool QEventLoop.processEvents (<i>self</i>, <a href="qeventloop-processeventsflags.html">ProcessEventsFlags</a>&#160;<i>flags</i>&#160;=&#160;QEventLoop.AllEvents)</h3><p>Processes pending events that match <i>flags</i> until there are
    105. 

  105. no more events to process. Returns true if pending events were
    106. 

  106. handled; otherwise returns false.</p>
    107. 

  107. <p>This function is especially useful if you have a long running
    108. 

  108. operation and want to show its progress without allowing user
    109. 

  109. input; i.e. by using the <a href="qeventloop.html#ProcessEventsFlag-enum">ExcludeUserInputEvents</a>
    110. 

  110. flag.</p>
    111. 

  111. <p>This function is simply a wrapper for <a href="qabstracteventdispatcher.html#processEvents">QAbstractEventDispatcher.processEvents</a>().
    112. 

  112. See the documentation for that function for details.</p>
    113. 

  113. 

  114. 

  115. <h3 class="fn"><a name="processEvents-2" />QEventLoop.processEvents (<i>self</i>, <a href="qeventloop-processeventsflags.html">ProcessEventsFlags</a>&#160;<i>flags</i>, int&#160;<i>maximumTime</i>)</h3><p>Process pending events that match <i>flags</i> for a maximum of
    116. 

  116. <i>maxTime</i> milliseconds, or until there are no more events to
    117. 

  117. process, whichever is shorter. This function is especially useful
    118. 

  118. if you have a long running operation and want to show its progress
    119. 

  119. without allowing user input, i.e. by using the <a href="qeventloop.html#ProcessEventsFlag-enum">ExcludeUserInputEvents</a>
    120. 

  120. flag.</p>
    121. 

  121. <p><b>Notes:</b></p>
    122. 

  122. <ul>
    123. 

  123. <li>This function does not process events continuously; it returns
    124. 

  124. after all available events are processed.</li>
    125. 

  125. <li>Specifying the <a href="qeventloop.html#ProcessEventsFlag-enum">WaitForMoreEvents</a> flag
    126. 

  126. makes no sense and will be ignored.</li>
    127. 

  127. </ul>
    128. 

  128. 

  129. 

  130. <h3 class="fn"><a name="quit" />QEventLoop.quit (<i>self</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void quit()</tt>.</p><p>Tells the event loop to exit normally.</p>
    131. 

  131. <p>Same as exit(0).</p>
    132. 

  132. <p><b>See also</b> <a href="qcoreapplication.html#quit">QCoreApplication.quit</a>() and
    133. 

  133. <a href="qeventloop.html#exit">exit</a>().</p>
    134. 

  134. 

  135. 

  136. <h3 class="fn"><a name="wakeUp" />QEventLoop.wakeUp (<i>self</i>)</h3><p>Wakes up the event loop.</p>
    137. 

  137. <p><b>See also</b> <a href="qabstracteventdispatcher.html#wakeUp">QAbstractEventDispatcher.wakeUp</a>().</p>
    138. 

  138. <address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.9.4 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt&#160;4.8.2</td></tr></table></div></address></body></html>
    139.