<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>glibmm 2.4: Glib::MainLoop Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../../../gtkmm-2.4/docs/index.html">Main Page</a>
<a href="../../../../gtkmm-2.4/docs/reference/html/group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html">glibmm Namespaces</a>
<a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="nav">
<a class="el" href="namespaceGlib.html">Glib</a>::<a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a></div>
<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><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap 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#5cf7f1f3137b7ecfde3a843087cc89d8">CppObjectType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef GMainLoop </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#d5e8a0005860126cac043cb60be70078">BaseObjectType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#4cc8eeba5dd463189737f859974ae158">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#e1a76ab4fe58b23ec8238d6aa40cbab9" title="Stops a MainLoop from running.">quit()</a> is called on the loop. <a href="#4cc8eeba5dd463189737f859974ae158"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#e1a76ab4fe58b23ec8238d6aa40cbab9">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="#e1a76ab4fe58b23ec8238d6aa40cbab9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#9dca351bd77e00412f5e73eacc41c5fd">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#4cc8eeba5dd463189737f859974ae158" title="Runs a main loop until quit() is called on the loop.">run()</a>. <a href="#9dca351bd77e00412f5e73eacc41c5fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#37b86faf3ae28cfa49c15b73b15a24f1">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="#37b86faf3ae28cfa49c15b73b15a24f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#5e40799cc2e26b57227c269f0d4dd831">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="#5e40799cc2e26b57227c269f0d4dd831"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#26ac94620e6b7887aedb20df468a9123">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="#26ac94620e6b7887aedb20df468a9123"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GMainLoop* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#a53b9c0c885e28390b45e83aef4b2934">gobj</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GMainLoop* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#eef011a123044d42b0422c36d28c450a">gobj</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GMainLoop* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#f4d2883d0ce518a137f49f131225a99d">gobj_copy</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#37a1dcf3cb167cf02260111f533d0b5b">create</a> (bool is_running=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#b02f157ce27cd8aa5592eabc739ccdec">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" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainLoop.html#023045e5b0069af8260e721fde21f4c6">depth</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#g22ea72cda4ef327ca03fb72d6a3bea89">wrap</a> (GMainLoop* gobject, bool take_copy=false)</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="5cf7f1f3137b7ecfde3a843087cc89d8"></a><!-- doxytag: member="Glib::MainLoop::CppObjectType" ref="5cf7f1f3137b7ecfde3a843087cc89d8" 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">
<p>
</div>
</div><p>
<a class="anchor" name="d5e8a0005860126cac043cb60be70078"></a><!-- doxytag: member="Glib::MainLoop::BaseObjectType" ref="d5e8a0005860126cac043cb60be70078" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef GMainLoop <a class="el" href="classGlib_1_1MainLoop.html#d5e8a0005860126cac043cb60be70078">Glib::MainLoop::BaseObjectType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="37a1dcf3cb167cf02260111f533d0b5b"></a><!-- doxytag: member="Glib::MainLoop::create" ref="37a1dcf3cb167cf02260111f533d0b5b" 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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="thread_2dispatcher_8cc-example.html#a12">thread/dispatcher.cc</a>.</dl>
</div>
</div><p>
<a class="anchor" name="b02f157ce27cd8aa5592eabc739ccdec"></a><!-- doxytag: member="Glib::MainLoop::create" ref="b02f157ce27cd8aa5592eabc739ccdec" 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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="4cc8eeba5dd463189737f859974ae158"></a><!-- doxytag: member="Glib::MainLoop::run" ref="4cc8eeba5dd463189737f859974ae158" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Runs a main loop until <a class="el" href="classGlib_1_1MainLoop.html#e1a76ab4fe58b23ec8238d6aa40cbab9" title="Stops a MainLoop from running.">quit()</a> is called on the loop.
<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.
</div>
</div><p>
<a class="anchor" name="e1a76ab4fe58b23ec8238d6aa40cbab9"></a><!-- doxytag: member="Glib::MainLoop::quit" ref="e1a76ab4fe58b23ec8238d6aa40cbab9" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stops a <a class="el" href="classGlib_1_1MainLoop.html">MainLoop</a> from running.
<p>
Any calls to <a class="el" href="classGlib_1_1MainLoop.html#4cc8eeba5dd463189737f859974ae158" title="Runs a main loop until quit() is called on the loop.">run()</a> for the loop will return.
</div>
</div><p>
<a class="anchor" name="9dca351bd77e00412f5e73eacc41c5fd"></a><!-- doxytag: member="Glib::MainLoop::is_running" ref="9dca351bd77e00412f5e73eacc41c5fd" 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 width="100%"></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#4cc8eeba5dd463189737f859974ae158" title="Runs a main loop until quit() is called on the loop.">run()</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the mainloop is currently being run. </dd></dl>
</div>
</div><p>
<a class="anchor" name="37b86faf3ae28cfa49c15b73b15a24f1"></a><!-- doxytag: member="Glib::MainLoop::get_context" ref="37b86faf3ae28cfa49c15b73b15a24f1" 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 width="100%"></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" compact><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><p>
<a class="anchor" name="023045e5b0069af8260e721fde21f4c6"></a><!-- doxytag: member="Glib::MainLoop::depth" ref="023045e5b0069af8260e721fde21f4c6" 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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5e40799cc2e26b57227c269f0d4dd831"></a><!-- doxytag: member="Glib::MainLoop::reference" ref="5e40799cc2e26b57227c269f0d4dd831" 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 width="100%"> 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><p>
<a class="anchor" name="26ac94620e6b7887aedb20df468a9123"></a><!-- doxytag: member="Glib::MainLoop::unreference" ref="26ac94620e6b7887aedb20df468a9123" 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 width="100%"> 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>
If the result is zero, free the loop and free all associated memory.
</div>
</div><p>
<a class="anchor" name="a53b9c0c885e28390b45e83aef4b2934"></a><!-- doxytag: member="Glib::MainLoop::gobj" ref="a53b9c0c885e28390b45e83aef4b2934" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="eef011a123044d42b0422c36d28c450a"></a><!-- doxytag: member="Glib::MainLoop::gobj" ref="eef011a123044d42b0422c36d28c450a" 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 width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="f4d2883d0ce518a137f49f131225a99d"></a><!-- doxytag: member="Glib::MainLoop::gobj_copy" ref="f4d2883d0ce518a137f49f131225a99d" 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 width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="main_8h.html">main.h</a></ul>
</div> <!-- end main content -->
<hr><address><small>
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.3 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
e8cbfa9673da18966abee0a6d7051b87
>
files
>
191
