<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/> <title>glibmm: Glib::MainLoop 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" /> <link href="doxygen-extra.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">glibmm  <span id="projectnumber">2.60.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGlib.html">Glib</a></li><li class="navelem"><a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#related">Related Functions</a> | <a href="classGlib_1_1MainLoop-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Glib::MainLoop Class Reference<div class="ingroups"><a class="el" href="group__MainLoop.html">The Main Event Loop</a></div></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <glibmm/main.h></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:ae7021d15507eaff01c941b3d6714a7bc"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#ae7021d15507eaff01c941b3d6714a7bc">CppObjectType</a> = <a class="el" href="classGlib_1_1MainLoop.html">Glib::MainLoop</a></td></tr> <tr class="separator:ae7021d15507eaff01c941b3d6714a7bc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0462e3a79ddf8626c98c6d571105be9a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a0462e3a79ddf8626c98c6d571105be9a">BaseObjectType</a> = GMainLoop</td></tr> <tr class="separator:a0462e3a79ddf8626c98c6d571105be9a"><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:a4cc8eeba5dd463189737f859974ae158"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a4cc8eeba5dd463189737f859974ae158">run</a> ()</td></tr> <tr class="memdesc:a4cc8eeba5dd463189737f859974ae158"><td class="mdescLeft"> </td><td class="mdescRight">Runs a main loop until <a class="el" href="classGlib_1_1MainLoop.html#ae1a76ab4fe58b23ec8238d6aa40cbab9" title="Stops a MainLoop from running. ">quit()</a> is called on the loop. <a href="#a4cc8eeba5dd463189737f859974ae158">More...</a><br /></td></tr> <tr class="separator:a4cc8eeba5dd463189737f859974ae158"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae1a76ab4fe58b23ec8238d6aa40cbab9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#ae1a76ab4fe58b23ec8238d6aa40cbab9">quit</a> ()</td></tr> <tr class="memdesc:ae1a76ab4fe58b23ec8238d6aa40cbab9"><td class="mdescLeft"> </td><td class="mdescRight">Stops a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> from running. <a href="#ae1a76ab4fe58b23ec8238d6aa40cbab9">More...</a><br /></td></tr> <tr class="separator:ae1a76ab4fe58b23ec8238d6aa40cbab9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9dca351bd77e00412f5e73eacc41c5fd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a9dca351bd77e00412f5e73eacc41c5fd">is_running</a> ()</td></tr> <tr class="memdesc:a9dca351bd77e00412f5e73eacc41c5fd"><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if the main loop is currently being run via <a class="el" href="classGlib_1_1MainLoop.html#a4cc8eeba5dd463189737f859974ae158" title="Runs a main loop until quit() is called on the loop. ">run()</a>. <a href="#a9dca351bd77e00412f5e73eacc41c5fd">More...</a><br /></td></tr> <tr class="separator:a9dca351bd77e00412f5e73eacc41c5fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a37b86faf3ae28cfa49c15b73b15a24f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGlib_1_1MainContext.html">MainContext</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a37b86faf3ae28cfa49c15b73b15a24f1">get_context</a> ()</td></tr> <tr class="memdesc:a37b86faf3ae28cfa49c15b73b15a24f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classGlib_1_1MainContext.html" title="Main context. ">MainContext</a> of loop. <a href="#a37b86faf3ae28cfa49c15b73b15a24f1">More...</a><br /></td></tr> <tr class="separator:a37b86faf3ae28cfa49c15b73b15a24f1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e40799cc2e26b57227c269f0d4dd831"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a5e40799cc2e26b57227c269f0d4dd831">reference</a> () const </td></tr> <tr class="memdesc:a5e40799cc2e26b57227c269f0d4dd831"><td class="mdescLeft"> </td><td class="mdescRight">Increases the reference count on a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> object by one. <a href="#a5e40799cc2e26b57227c269f0d4dd831">More...</a><br /></td></tr> <tr class="separator:a5e40799cc2e26b57227c269f0d4dd831"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a26ac94620e6b7887aedb20df468a9123"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a26ac94620e6b7887aedb20df468a9123">unreference</a> () const </td></tr> <tr class="memdesc:a26ac94620e6b7887aedb20df468a9123"><td class="mdescLeft"> </td><td class="mdescRight">Decreases the reference count on a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> object by one. <a href="#a26ac94620e6b7887aedb20df468a9123">More...</a><br /></td></tr> <tr class="separator:a26ac94620e6b7887aedb20df468a9123"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa53b9c0c885e28390b45e83aef4b2934"><td class="memItemLeft" align="right" valign="top">GMainLoop* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#aa53b9c0c885e28390b45e83aef4b2934">gobj</a> ()</td></tr> <tr class="separator:aa53b9c0c885e28390b45e83aef4b2934"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeef011a123044d42b0422c36d28c450a"><td class="memItemLeft" align="right" valign="top">const GMainLoop* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#aeef011a123044d42b0422c36d28c450a">gobj</a> () const </td></tr> <tr class="separator:aeef011a123044d42b0422c36d28c450a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af4d2883d0ce518a137f49f131225a99d"><td class="memItemLeft" align="right" valign="top">GMainLoop* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#af4d2883d0ce518a137f49f131225a99d">gobj_copy</a> () const </td></tr> <tr class="separator:af4d2883d0ce518a137f49f131225a99d"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a37a1dcf3cb167cf02260111f533d0b5b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a37a1dcf3cb167cf02260111f533d0b5b">create</a> (bool <a class="el" href="classGlib_1_1MainLoop.html#a9dca351bd77e00412f5e73eacc41c5fd">is_running</a>=false)</td></tr> <tr class="separator:a37a1dcf3cb167cf02260111f533d0b5b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab02f157ce27cd8aa5592eabc739ccdec"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#ab02f157ce27cd8aa5592eabc739ccdec">create</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGlib_1_1MainContext.html">MainContext</a> >& context, bool <a class="el" href="classGlib_1_1MainLoop.html#a9dca351bd77e00412f5e73eacc41c5fd">is_running</a>=false)</td></tr> <tr class="separator:ab02f157ce27cd8aa5592eabc739ccdec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a023045e5b0069af8260e721fde21f4c6"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a023045e5b0069af8260e721fde21f4c6">depth</a> ()</td></tr> <tr class="separator:a023045e5b0069af8260e721fde21f4c6"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr class="memitem:ga22ea72cda4ef327ca03fb72d6a3bea89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MainLoop.html#ga22ea72cda4ef327ca03fb72d6a3bea89">wrap</a> (GMainLoop* gobject, bool take_copy=false)</td></tr> <tr class="separator:ga22ea72cda4ef327ca03fb72d6a3bea89"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="a0462e3a79ddf8626c98c6d571105be9a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">using <a class="el" href="classGlib_1_1MainLoop.html#a0462e3a79ddf8626c98c6d571105be9a">Glib::MainLoop::BaseObjectType</a> = GMainLoop</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ae7021d15507eaff01c941b3d6714a7bc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">using <a class="el" href="classGlib_1_1MainLoop.html#ae7021d15507eaff01c941b3d6714a7bc">Glib::MainLoop::CppObjectType</a> = <a class="el" href="classGlib_1_1MainLoop.html">Glib::MainLoop</a></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a37a1dcf3cb167cf02260111f533d0b5b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a>> Glib::MainLoop::create </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>is_running</em> = <code>false</code></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="thread_2dispatcher_8cc-example.html#a14">thread/dispatcher.cc</a>.</dd> </dl> </div> </div> <a class="anchor" id="ab02f157ce27cd8aa5592eabc739ccdec"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a>> Glib::MainLoop::create </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGlib_1_1MainContext.html">MainContext</a> >& </td> <td class="paramname"><em>context</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>is_running</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a023045e5b0069af8260e721fde21f4c6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static int Glib::MainLoop::depth </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a37b86faf3ae28cfa49c15b73b15a24f1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> Glib::MainLoop::get_context </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns the <a class="el" href="classGlib_1_1MainContext.html" title="Main context. ">MainContext</a> of loop. </p> <dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="classGlib_1_1MainContext.html" title="Main context. ">MainContext</a> of loop. </dd></dl> </div> </div> <a class="anchor" id="aa53b9c0c885e28390b45e83aef4b2934"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GMainLoop* Glib::MainLoop::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="aeef011a123044d42b0422c36d28c450a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GMainLoop* Glib::MainLoop::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="af4d2883d0ce518a137f49f131225a99d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GMainLoop* Glib::MainLoop::gobj_copy </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a9dca351bd77e00412f5e73eacc41c5fd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Glib::MainLoop::is_running </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Checks to see if the main loop is currently being run via <a class="el" href="classGlib_1_1MainLoop.html#a4cc8eeba5dd463189737f859974ae158" title="Runs a main loop until quit() is called on the loop. ">run()</a>. </p> <dl class="section return"><dt>Returns</dt><dd>true if the mainloop is currently being run. </dd></dl> </div> </div> <a class="anchor" id="ae1a76ab4fe58b23ec8238d6aa40cbab9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glib::MainLoop::quit </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Stops a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> from running. </p> <p>Any calls to <a class="el" href="classGlib_1_1MainLoop.html#a4cc8eeba5dd463189737f859974ae158" title="Runs a main loop until quit() is called on the loop. ">run()</a> for the loop will return. </p> </div> </div> <a class="anchor" id="a5e40799cc2e26b57227c269f0d4dd831"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glib::MainLoop::reference </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Increases the reference count on a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> object by one. </p> </div> </div> <a class="anchor" id="a4cc8eeba5dd463189737f859974ae158"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glib::MainLoop::run </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Runs a main loop until <a class="el" href="classGlib_1_1MainLoop.html#ae1a76ab4fe58b23ec8238d6aa40cbab9" title="Stops a MainLoop from running. ">quit()</a> is called on the loop. </p> <p>If this is called for the thread of the loop's <a class="el" href="classGlib_1_1MainContext.html" title="Main context. ">MainContext</a>, it will process events from the loop, otherwise it will simply wait. </p> </div> </div> <a class="anchor" id="a26ac94620e6b7887aedb20df468a9123"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glib::MainLoop::unreference </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Decreases the reference count on a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> object by one. </p> <p>If the result is zero, free the loop and free all associated memory. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Tue Mar 19 2019 09:56:46 for glibmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>