<!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"/>
<title>glibmm: Glib::MainLoop Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGlib.html">Glib</a>::<a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a>
</div>
</div>
<div class="contents">
<h1>Glib::MainLoop Class Reference<br/>
<small>
[<a class="el" href="group__MainLoop.html">The Main Event Loop</a>]</small>
</h1><!-- doxytag: class="Glib::MainLoop" -->
<p><a href="classGlib_1_1MainLoop-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classGlib_1_1MainLoop.html">Glib::MainLoop</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a5cf7f1f3137b7ecfde3a843087cc89d8">CppObjectType</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef GMainLoop </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#ad5e8a0005860126cac043cb60be70078">BaseObjectType</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Stops a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> from running. <a href="#ae1a76ab4fe58b23ec8238d6aa40cbab9"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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><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><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><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><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 is_running=false)</td></tr>
<tr><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 is_running=false)</td></tr>
<tr><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><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><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>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="ad5e8a0005860126cac043cb60be70078"></a><!-- doxytag: member="Glib::MainLoop::BaseObjectType" ref="ad5e8a0005860126cac043cb60be70078" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef GMainLoop <a class="el" href="classGlib_1_1MainLoop.html#ad5e8a0005860126cac043cb60be70078">Glib::MainLoop::BaseObjectType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5cf7f1f3137b7ecfde3a843087cc89d8"></a><!-- doxytag: member="Glib::MainLoop::CppObjectType" ref="a5cf7f1f3137b7ecfde3a843087cc89d8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classGlib_1_1MainLoop.html">Glib::MainLoop</a> <a class="el" href="classGlib_1_1MainLoop.html">Glib::MainLoop::CppObjectType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab02f157ce27cd8aa5592eabc739ccdec"></a><!-- doxytag: member="Glib::MainLoop::create" ref="ab02f157ce27cd8aa5592eabc739ccdec" args="(const Glib::RefPtr< MainContext > &context, bool is_running=false)" -->
<div class="memitem">
<div class="memproto">
<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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a37a1dcf3cb167cf02260111f533d0b5b"></a><!-- doxytag: member="Glib::MainLoop::create" ref="a37a1dcf3cb167cf02260111f533d0b5b" args="(bool is_running=false)" -->
<div class="memitem">
<div class="memproto">
<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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="thread_2dispatcher_8cc-example.html#a13">thread/dispatcher.cc</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a023045e5b0069af8260e721fde21f4c6"></a><!-- doxytag: member="Glib::MainLoop::depth" ref="a023045e5b0069af8260e721fde21f4c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int Glib::MainLoop::depth </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a37b86faf3ae28cfa49c15b73b15a24f1"></a><!-- doxytag: member="Glib::MainLoop::get_context" ref="a37b86faf3ae28cfa49c15b73b15a24f1" args="()" -->
<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="return"><dt><b>Returns:</b></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="aeef011a123044d42b0422c36d28c450a"></a><!-- doxytag: member="Glib::MainLoop::gobj" ref="aeef011a123044d42b0422c36d28c450a" args="() const " -->
<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="aa53b9c0c885e28390b45e83aef4b2934"></a><!-- doxytag: member="Glib::MainLoop::gobj" ref="aa53b9c0c885e28390b45e83aef4b2934" args="()" -->
<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="af4d2883d0ce518a137f49f131225a99d"></a><!-- doxytag: member="Glib::MainLoop::gobj_copy" ref="af4d2883d0ce518a137f49f131225a99d" args="() const " -->
<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><!-- doxytag: member="Glib::MainLoop::is_running" ref="a9dca351bd77e00412f5e73eacc41c5fd" args="()" -->
<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="return"><dt><b>Returns:</b></dt><dd>true if the mainloop is currently being run. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1a76ab4fe58b23ec8238d6aa40cbab9"></a><!-- doxytag: member="Glib::MainLoop::quit" ref="ae1a76ab4fe58b23ec8238d6aa40cbab9" args="()" -->
<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><!-- doxytag: member="Glib::MainLoop::reference" ref="a5e40799cc2e26b57227c269f0d4dd831" args="() const " -->
<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><!-- doxytag: member="Glib::MainLoop::run" ref="a4cc8eeba5dd463189737f859974ae158" args="()" -->
<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><!-- doxytag: member="Glib::MainLoop::unreference" ref="a26ac94620e6b7887aedb20df468a9123" args="() const " -->
<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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>glibmm/main.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:26 2009 for glibmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
