1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::Main Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1Main.html">Main</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pub-static-methods">Static Public Member Functions</a> |
51
<a href="#pro-methods">Protected Member Functions</a> |
52
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
53
<div class="headertitle">
54
<h1>Gtk::Main Class Reference</h1> </div>
56
<div class="contents">
57
<!-- doxytag: class="Gtk::Main" --><!-- doxytag: inherits="sigc::trackable" -->
58
<p><a class="el" href="classGtk_1_1Main.html" title="Main application class Every application must have one of these objects.">Main</a> application class Every application must have one of these objects. <a href="#_details">More...</a></p>
59
<div class="dynheader">
60
Inheritance diagram for Gtk::Main:</div>
61
<div class="dyncontent">
62
<div class="center"><img src="classGtk_1_1Main__inherit__graph.png" border="0" usemap="#Gtk_1_1Main_inherit__map" alt="Inheritance graph"/></div>
63
<map name="Gtk_1_1Main_inherit__map" id="Gtk_1_1Main_inherit__map">
64
<area shape="rect" id="node2" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="5,6,112,37"/></map>
65
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
66
<div class="dynheader">
67
Collaboration diagram for Gtk::Main:</div>
68
<div class="dyncontent">
69
<div class="center"><img src="classGtk_1_1Main__coll__graph.png" border="0" usemap="#Gtk_1_1Main_coll__map" alt="Collaboration graph"/></div>
70
<map name="Gtk_1_1Main_coll__map" id="Gtk_1_1Main_coll__map">
71
<area shape="rect" id="node2" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="5,6,112,37"/></map>
72
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
74
<p><a href="classGtk_1_1Main-members.html">List of all members.</a></p>
75
<table class="memberdecls">
76
<tr><td colspan="2"><h2><a name="pub-methods"></a>
77
Public Member Functions</h2></td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#afbc89daf89de698660ce02426967e135">Main</a> (int& argc, char**& argv, <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a>& option_context)</td></tr>
79
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scans the argument vector, and strips off all parameters parsed by GTK+ or your <em>option_context</em>. <a href="#afbc89daf89de698660ce02426967e135"></a><br/></td></tr>
80
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#ae02744d26abd4abfe106ed31f05ad2dc">Main</a> (int* argc, char*** argv, bool set_locale=true)</td></tr>
81
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scans the argument vector, and strips off all parameters known to GTK+. <a href="#ae02744d26abd4abfe106ed31f05ad2dc"></a><br/></td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a2b7340ad84fe8d66bb7489c635e8fd5e">Main</a> (int& argc, char**& argv, bool set_locale=true)</td></tr>
83
<tr><td class="mdescLeft"> </td><td class="mdescRight">See <a class="el" href="classGtk_1_1Main.html#ae02744d26abd4abfe106ed31f05ad2dc" title="Scans the argument vector, and strips off all parameters known to GTK+.">Main(int* argc, char*** argv, bool set_locale)</a>. <a href="#a2b7340ad84fe8d66bb7489c635e8fd5e"></a><br/></td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a485eeb37361615a021ca21fb2a6f257c">~Main</a> ()</td></tr>
85
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
86
Static Public Member Functions</h2></td></tr>
87
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGtk_1_1Main.html">Gtk::Main</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a94b74eb618f4b0d213c79c2ada927446">instance</a> ()</td></tr>
88
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access to the one global instance of <a class="el" href="classGtk_1_1Main.html" title="Main application class Every application must have one of these objects.">Gtk::Main</a>. <a href="#a94b74eb618f4b0d213c79c2ada927446"></a><br/></td></tr>
89
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a6a8904c35952006d13cb07c1d0c16c10">run</a> ()</td></tr>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the event loop. <a href="#a6a8904c35952006d13cb07c1d0c16c10"></a><br/></td></tr>
91
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#aaa2e4e282834cbe2d789fe34c447a0dd">run</a> (<a class="el" href="classGtk_1_1Window.html">Window</a>& window)</td></tr>
92
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns from the main loop when the window is closed. <a href="#aaa2e4e282834cbe2d789fe34c447a0dd"></a><br/></td></tr>
93
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a8719a8ac37ff6bb66048ca8967dbd782">quit</a> ()</td></tr>
94
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes the innermost invocation of the main loop return when it regains control. <a href="#a8719a8ac37ff6bb66048ca8967dbd782"></a><br/></td></tr>
95
<tr><td class="memItemLeft" align="right" valign="top">static guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a78f66b89dbe811cdce075a8b00c8987a">level</a> ()</td></tr>
96
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a16e384f8b3a02af8d3e86f59053b218e">add_gtk_option_group</a> (<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a>& option_context, bool open_default_display=true)</td></tr>
97
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionGroup.html">Glib::OptionGroup</a>, for the commandline arguments recognized by GTK+ and GDK, to a <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a>, so that these commandline arguments will be processed in addition to the existing commandline arguments specified by the <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a>. <a href="#a16e384f8b3a02af8d3e86f59053b218e"></a><br/></td></tr>
98
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#ab9ba7993ef8a22b6bf8796a2e4862e68">iteration</a> (bool blocking=true)</td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs a single iteration of the main loop. <a href="#ab9ba7993ef8a22b6bf8796a2e4862e68"></a><br/></td></tr>
100
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a2a2a6cddef82f8c52026790f3f7887e0">events_pending</a> ()</td></tr>
101
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if any events are pending. <a href="#a2a2a6cddef82f8c52026790f3f7887e0"></a><br/></td></tr>
102
<tr><td class="memItemLeft" align="right" valign="top">static RunSig& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#aec1562f7b2a23858472aa94d23b66173">signal_run</a> ()</td></tr>
103
<tr><td class="mdescLeft"> </td><td class="mdescRight">Run signal. <a href="#aec1562f7b2a23858472aa94d23b66173"></a><br/></td></tr>
104
<tr><td class="memItemLeft" align="right" valign="top">static QuitSig& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#ac1b6ae5b79cb84158f3caf3e9382492d">signal_quit</a> ()</td></tr>
105
<tr><td class="mdescLeft"> </td><td class="mdescRight">Quit signal You can connect signal handlers to invoke actions when <a class="el" href="classGtk_1_1Main.html#a8719a8ac37ff6bb66048ca8967dbd782" title="Makes the innermost invocation of the main loop return when it regains control.">Gtk::Main::quit()</a> has been called. <a href="#ac1b6ae5b79cb84158f3caf3e9382492d"></a><br/></td></tr>
106
<tr><td class="memItemLeft" align="right" valign="top">static KeySnooperSig& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#ab4c316c0789dfb4ab7926e062196c4e5">signal_key_snooper</a> ()</td></tr>
107
<tr><td class="mdescLeft"> </td><td class="mdescRight">KeySnooper signal Allows you to channel keypresses to a signal handler without registering with the widget. <a href="#ab4c316c0789dfb4ab7926e062196c4e5"></a><br/></td></tr>
108
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#aab3b3f72ad21e91e4c644ee5131d4058">init_gtkmm_internals</a> ()</td></tr>
109
<tr><td colspan="2"><h2><a name="pro-methods"></a>
110
Protected Member Functions</h2></td></tr>
111
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a8a5748d38300e0484a8cf7c756af8c99">Main</a> ()</td></tr>
112
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a6f855eae235b700e2242fb68252dcea5">init</a> (int* argc, char*** argv, bool set_locale)</td></tr>
113
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a2642c570bde971015f97b97cce743f80">run_impl</a> ()</td></tr>
114
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a785e09dce370a1c5260885ced9efb4a6">quit_impl</a> ()</td></tr>
115
<tr><td class="memItemLeft" align="right" valign="top">virtual guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#aad90e366d331016ce5ff68023f214d8b">level_impl</a> ()</td></tr>
116
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a681a82f7118d71188e64ba9379bb33e7">iteration_impl</a> (bool blocking)</td></tr>
117
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a4a8ca03d685b708e9dc38e3ddaa0875a">events_pending_impl</a> ()</td></tr>
118
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a7c3bb918c54342b71e9e56d999b4dd4e">on_window_hide</a> ()</td></tr>
119
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
120
Static Protected Attributes</h2></td></tr>
121
<tr><td class="memItemLeft" align="right" valign="top">static RunSig </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a459e2ec96368ff1c28f351496c3200d6">signal_run_</a></td></tr>
122
<tr><td class="memItemLeft" align="right" valign="top">static QuitSig </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#aee8ba380608053d85a98847eaeb564da">signal_quit_</a></td></tr>
123
<tr><td class="memItemLeft" align="right" valign="top">static KeySnooperSig </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Main.html#a97582880bbb0ac12e957861a7ed165a3">signal_key_snooper_</a></td></tr>
125
<hr/><a name="_details"></a><h2>Detailed Description</h2>
126
<div class="textblock"><p><a class="el" href="classGtk_1_1Main.html" title="Main application class Every application must have one of these objects.">Main</a> application class Every application must have one of these objects. </p>
127
<p>It may not be global and must be the first <a class="el" href="namespaceGtk.html">Gtk</a> object created. It is a singleton so declaring more than one will simply access the first created.</p>
128
<p>Normal use of this class is in the main() function to give argc and argv to the gtk initialization. Widgets can use <a class="el" href="classGtk_1_1Main.html#a8719a8ac37ff6bb66048ca8967dbd782" title="Makes the innermost invocation of the main loop return when it regains control.">Gtk::Main::quit()</a> to exit from the application.</p>
129
<p>The internals of the widget have been disguised as signals so that the user can easily connect using the same methods used throughout the widget interface.</p>
130
<p>Minimal gtkmm application is something like this: </p>
131
<div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[]) {
132
<a class="code" href="classGtk_1_1Main.html" title="Main application class Every application must have one of these objects.">Gtk::Main</a> kit(argc, argv);
133
... create some widgets ...
136
</pre></div> </div><hr/><h2>Constructor & Destructor Documentation</h2>
137
<a class="anchor" id="afbc89daf89de698660ce02426967e135"></a><!-- doxytag: member="Gtk::Main::Main" ref="afbc89daf89de698660ce02426967e135" args="(int &argc, char **&argv, Glib::OptionContext &option_context)" -->
138
<div class="memitem">
139
<div class="memproto">
140
<table class="memname">
142
<td class="memname">Gtk::Main::Main </td>
144
<td class="paramtype">int & </td>
145
<td class="paramname"><em>argc</em>, </td>
148
<td class="paramkey"></td>
150
<td class="paramtype">char **& </td>
151
<td class="paramname"><em>argv</em>, </td>
154
<td class="paramkey"></td>
156
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a> & </td>
157
<td class="paramname"><em>option_context</em> </td>
168
<p>Scans the argument vector, and strips off all parameters parsed by GTK+ or your <em>option_context</em>. </p>
169
<p>Add a <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionGroup.html">Glib::OptionGroup</a> to the <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a> to parse your own command-line arguments.</p>
170
<p>Note: The argument strings themself won't be modified, although the pointers to them might change. This makes it possible to create your own argv of string literals, which have the type 'const char[]' in standard C++. (You might need to use const_cast<>, though.)</p>
171
<p>This function automatically generates nicely formatted <option>--help</option> output. Note that your program will be terminated after writing out the help output.</p>
172
<dl><dt><b>Parameters:</b></dt><dd>
173
<table class="params">
174
<tr><td class="paramname">argc</td><td>a reference to the number of command line arguments. </td></tr>
175
<tr><td class="paramname">argv</td><td>a reference to the array of command line arguments. a string which is displayed in the first line of <option>--help</option> output, after <literal><replaceable>programname</replaceable> [OPTION...]</literal> </td></tr>
176
<tr><td class="paramname">option_context</td><td>A <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a> containing Glib::OptionGroups which described the command-line arguments taken by your program.</td></tr>
180
<dl><dt><b>Exceptions:</b></dt><dd>
181
<table class="exception">
182
<tr><td class="paramname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionError.html">Glib::OptionError</a></td><td></td></tr>
189
<a class="anchor" id="ae02744d26abd4abfe106ed31f05ad2dc"></a><!-- doxytag: member="Gtk::Main::Main" ref="ae02744d26abd4abfe106ed31f05ad2dc" args="(int *argc, char ***argv, bool set_locale=true)" -->
190
<div class="memitem">
191
<div class="memproto">
192
<table class="memname">
194
<td class="memname">Gtk::Main::Main </td>
196
<td class="paramtype">int * </td>
197
<td class="paramname"><em>argc</em>, </td>
200
<td class="paramkey"></td>
202
<td class="paramtype">char *** </td>
203
<td class="paramname"><em>argv</em>, </td>
206
<td class="paramkey"></td>
208
<td class="paramtype">bool </td>
209
<td class="paramname"><em>set_locale</em> = <code>true</code> </td>
220
<p>Scans the argument vector, and strips off all parameters known to GTK+. </p>
221
<p>Your application may then handle the remaining arguments.</p>
222
<p>Note: The argument strings themself won't be modified, although the pointers to them might change. This makes it possible to create your own argv of string literals, which have the type 'const char[]' in standard C++. (You might need to use const_cast<>, though.) </p>
226
<a class="anchor" id="a2b7340ad84fe8d66bb7489c635e8fd5e"></a><!-- doxytag: member="Gtk::Main::Main" ref="a2b7340ad84fe8d66bb7489c635e8fd5e" args="(int &argc, char **&argv, bool set_locale=true)" -->
227
<div class="memitem">
228
<div class="memproto">
229
<table class="memname">
231
<td class="memname">Gtk::Main::Main </td>
233
<td class="paramtype">int & </td>
234
<td class="paramname"><em>argc</em>, </td>
237
<td class="paramkey"></td>
239
<td class="paramtype">char **& </td>
240
<td class="paramname"><em>argv</em>, </td>
243
<td class="paramkey"></td>
245
<td class="paramtype">bool </td>
246
<td class="paramname"><em>set_locale</em> = <code>true</code> </td>
257
<p>See <a class="el" href="classGtk_1_1Main.html#ae02744d26abd4abfe106ed31f05ad2dc" title="Scans the argument vector, and strips off all parameters known to GTK+.">Main(int* argc, char*** argv, bool set_locale)</a>. </p>
261
<a class="anchor" id="a485eeb37361615a021ca21fb2a6f257c"></a><!-- doxytag: member="Gtk::Main::~Main" ref="a485eeb37361615a021ca21fb2a6f257c" args="()" -->
262
<div class="memitem">
263
<div class="memproto">
264
<table class="memname">
266
<td class="memname">virtual Gtk::Main::~Main </td>
268
<td class="paramname"></td><td>)</td>
269
<td><code> [virtual]</code></td>
277
<a class="anchor" id="a8a5748d38300e0484a8cf7c756af8c99"></a><!-- doxytag: member="Gtk::Main::Main" ref="a8a5748d38300e0484a8cf7c756af8c99" args="()" -->
278
<div class="memitem">
279
<div class="memproto">
280
<table class="memname">
282
<td class="memname">Gtk::Main::Main </td>
284
<td class="paramname"></td><td>)</td>
285
<td><code> [protected]</code></td>
293
<hr/><h2>Member Function Documentation</h2>
294
<a class="anchor" id="a16e384f8b3a02af8d3e86f59053b218e"></a><!-- doxytag: member="Gtk::Main::add_gtk_option_group" ref="a16e384f8b3a02af8d3e86f59053b218e" args="(Glib::OptionContext &option_context, bool open_default_display=true)" -->
295
<div class="memitem">
296
<div class="memproto">
297
<table class="memname">
299
<td class="memname">static void Gtk::Main::add_gtk_option_group </td>
301
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a> & </td>
302
<td class="paramname"><em>option_context</em>, </td>
305
<td class="paramkey"></td>
307
<td class="paramtype">bool </td>
308
<td class="paramname"><em>open_default_display</em> = <code>true</code> </td>
313
<td></td><td><code> [static]</code></td>
319
<p>Add a <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionGroup.html">Glib::OptionGroup</a>, for the commandline arguments recognized by GTK+ and GDK, to a <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a>, so that these commandline arguments will be processed in addition to the existing commandline arguments specified by the <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a>. </p>
320
<p>You do not need to use this method if you pass your <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1OptionContext.html">Glib::OptionContext</a> to the <a class="el" href="classGtk_1_1Main.html" title="Main application class Every application must have one of these objects.">Main</a> constructor, because it adds the gtk option group automatically.</p>
321
<dl><dt><b>Parameters:</b></dt><dd>
322
<table class="params">
323
<tr><td class="paramname">option_context</td><td>Option Context to which the group will be added. </td></tr>
324
<tr><td class="paramname">open_default_display</td><td>Whether to open the default display when parsing the commandline arguments. </td></tr>
331
<a class="anchor" id="a2a2a6cddef82f8c52026790f3f7887e0"></a><!-- doxytag: member="Gtk::Main::events_pending" ref="a2a2a6cddef82f8c52026790f3f7887e0" args="()" -->
332
<div class="memitem">
333
<div class="memproto">
334
<table class="memname">
336
<td class="memname">static bool Gtk::Main::events_pending </td>
338
<td class="paramname"></td><td>)</td>
339
<td><code> [static]</code></td>
345
<p>Checks if any events are pending. </p>
346
<p>This can be used to update the GUI and invoke timeouts etc. while doing some time intensive computation.</p>
347
<p>Example: Updating the GUI during a long computation. </p>
348
<div class="fragment"><pre class="fragment"> <span class="comment">// computation going on</span>
349
<span class="keywordflow">while</span>( <a class="code" href="classGtk_1_1Main.html#a2a2a6cddef82f8c52026790f3f7887e0" title="Checks if any events are pending.">Gtk::Main::events_pending</a>() )
350
<a class="code" href="classGtk_1_1Main.html#ab9ba7993ef8a22b6bf8796a2e4862e68" title="Runs a single iteration of the main loop.">Gtk::Main::iteration</a>();
352
<span class="comment">// computation continued</span>
353
</pre></div><dl class="return"><dt><b>Returns:</b></dt><dd>true if any events are pending, false otherwise. </dd></dl>
357
<a class="anchor" id="a4a8ca03d685b708e9dc38e3ddaa0875a"></a><!-- doxytag: member="Gtk::Main::events_pending_impl" ref="a4a8ca03d685b708e9dc38e3ddaa0875a" args="()" -->
358
<div class="memitem">
359
<div class="memproto">
360
<table class="memname">
362
<td class="memname">virtual bool Gtk::Main::events_pending_impl </td>
364
<td class="paramname"></td><td>)</td>
365
<td><code> [protected, virtual]</code></td>
373
<a class="anchor" id="a6f855eae235b700e2242fb68252dcea5"></a><!-- doxytag: member="Gtk::Main::init" ref="a6f855eae235b700e2242fb68252dcea5" args="(int *argc, char ***argv, bool set_locale)" -->
374
<div class="memitem">
375
<div class="memproto">
376
<table class="memname">
378
<td class="memname">void Gtk::Main::init </td>
380
<td class="paramtype">int * </td>
381
<td class="paramname"><em>argc</em>, </td>
384
<td class="paramkey"></td>
386
<td class="paramtype">char *** </td>
387
<td class="paramname"><em>argv</em>, </td>
390
<td class="paramkey"></td>
392
<td class="paramtype">bool </td>
393
<td class="paramname"><em>set_locale</em> </td>
398
<td></td><td><code> [protected]</code></td>
406
<a class="anchor" id="aab3b3f72ad21e91e4c644ee5131d4058"></a><!-- doxytag: member="Gtk::Main::init_gtkmm_internals" ref="aab3b3f72ad21e91e4c644ee5131d4058" args="()" -->
407
<div class="memitem">
408
<div class="memproto">
409
<table class="memname">
411
<td class="memname">static void Gtk::Main::init_gtkmm_internals </td>
413
<td class="paramname"></td><td>)</td>
414
<td><code> [static]</code></td>
422
<a class="anchor" id="a94b74eb618f4b0d213c79c2ada927446"></a><!-- doxytag: member="Gtk::Main::instance" ref="a94b74eb618f4b0d213c79c2ada927446" args="()" -->
423
<div class="memitem">
424
<div class="memproto">
425
<table class="memname">
427
<td class="memname">static <a class="el" href="classGtk_1_1Main.html">Gtk::Main</a>* Gtk::Main::instance </td>
429
<td class="paramname"></td><td>)</td>
430
<td><code> [static]</code></td>
436
<p>Access to the one global instance of <a class="el" href="classGtk_1_1Main.html" title="Main application class Every application must have one of these objects.">Gtk::Main</a>. </p>
440
<a class="anchor" id="ab9ba7993ef8a22b6bf8796a2e4862e68"></a><!-- doxytag: member="Gtk::Main::iteration" ref="ab9ba7993ef8a22b6bf8796a2e4862e68" args="(bool blocking=true)" -->
441
<div class="memitem">
442
<div class="memproto">
443
<table class="memname">
445
<td class="memname">static bool Gtk::Main::iteration </td>
447
<td class="paramtype">bool </td>
448
<td class="paramname"><em>blocking</em> = <code>true</code></td><td>)</td>
449
<td><code> [static]</code></td>
455
<p>Runs a single iteration of the main loop. </p>
456
<p>If no events are waiting to be processed GTK+ will block until the next event is noticed. If you don't want to block then pass false for <em>blocking</em> or check if any events are pending with pending() first.</p>
457
<dl><dt><b>Parameters:</b></dt><dd>
458
<table class="params">
459
<tr><td class="paramname">blocking</td><td>Whether the caller must wait until the next event is noticed, or return immediately if there are no events. </td></tr>
463
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <a class="el" href="classGtk_1_1Main.html#a8719a8ac37ff6bb66048ca8967dbd782" title="Makes the innermost invocation of the main loop return when it regains control.">quit()</a> has been called for the innermost main loop. </dd></dl>
467
<a class="anchor" id="a681a82f7118d71188e64ba9379bb33e7"></a><!-- doxytag: member="Gtk::Main::iteration_impl" ref="a681a82f7118d71188e64ba9379bb33e7" args="(bool blocking)" -->
468
<div class="memitem">
469
<div class="memproto">
470
<table class="memname">
472
<td class="memname">virtual bool Gtk::Main::iteration_impl </td>
474
<td class="paramtype">bool </td>
475
<td class="paramname"><em>blocking</em></td><td>)</td>
476
<td><code> [protected, virtual]</code></td>
484
<a class="anchor" id="a78f66b89dbe811cdce075a8b00c8987a"></a><!-- doxytag: member="Gtk::Main::level" ref="a78f66b89dbe811cdce075a8b00c8987a" args="()" -->
485
<div class="memitem">
486
<div class="memproto">
487
<table class="memname">
489
<td class="memname">static guint Gtk::Main::level </td>
491
<td class="paramname"></td><td>)</td>
492
<td><code> [static]</code></td>
500
<a class="anchor" id="aad90e366d331016ce5ff68023f214d8b"></a><!-- doxytag: member="Gtk::Main::level_impl" ref="aad90e366d331016ce5ff68023f214d8b" args="()" -->
501
<div class="memitem">
502
<div class="memproto">
503
<table class="memname">
505
<td class="memname">virtual guint Gtk::Main::level_impl </td>
507
<td class="paramname"></td><td>)</td>
508
<td><code> [protected, virtual]</code></td>
516
<a class="anchor" id="a7c3bb918c54342b71e9e56d999b4dd4e"></a><!-- doxytag: member="Gtk::Main::on_window_hide" ref="a7c3bb918c54342b71e9e56d999b4dd4e" args="()" -->
517
<div class="memitem">
518
<div class="memproto">
519
<table class="memname">
521
<td class="memname">virtual void Gtk::Main::on_window_hide </td>
523
<td class="paramname"></td><td>)</td>
524
<td><code> [protected, virtual]</code></td>
532
<a class="anchor" id="a8719a8ac37ff6bb66048ca8967dbd782"></a><!-- doxytag: member="Gtk::Main::quit" ref="a8719a8ac37ff6bb66048ca8967dbd782" args="()" -->
533
<div class="memitem">
534
<div class="memproto">
535
<table class="memname">
537
<td class="memname">static void Gtk::Main::quit </td>
539
<td class="paramname"></td><td>)</td>
540
<td><code> [static]</code></td>
546
<p>Makes the innermost invocation of the main loop return when it regains control. </p>
550
<a class="anchor" id="a785e09dce370a1c5260885ced9efb4a6"></a><!-- doxytag: member="Gtk::Main::quit_impl" ref="a785e09dce370a1c5260885ced9efb4a6" args="()" -->
551
<div class="memitem">
552
<div class="memproto">
553
<table class="memname">
555
<td class="memname">virtual void Gtk::Main::quit_impl </td>
557
<td class="paramname"></td><td>)</td>
558
<td><code> [protected, virtual]</code></td>
566
<a class="anchor" id="aaa2e4e282834cbe2d789fe34c447a0dd"></a><!-- doxytag: member="Gtk::Main::run" ref="aaa2e4e282834cbe2d789fe34c447a0dd" args="(Window &window)" -->
567
<div class="memitem">
568
<div class="memproto">
569
<table class="memname">
571
<td class="memname">static void Gtk::Main::run </td>
573
<td class="paramtype"><a class="el" href="classGtk_1_1Window.html">Window</a>& </td>
574
<td class="paramname"><em>window</em></td><td>)</td>
575
<td><code> [static]</code></td>
581
<p>Returns from the main loop when the window is closed. </p>
582
<p>When using this override, you should not use <a class="el" href="classGtk_1_1Main.html#a8719a8ac37ff6bb66048ca8967dbd782" title="Makes the innermost invocation of the main loop return when it regains control.">Gtk::Main::quit()</a> to close the application, but just call <a class="elRef" href="../../../libsigc++-2.0/reference/html/group__hide.html#gaf28d43958b26c67e314f726540463c44">hide()</a> on your <a class="el" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled by the window manag...">Window</a> class.</p>
583
<dl><dt><b>Parameters:</b></dt><dd>
584
<table class="params">
585
<tr><td class="paramname">window</td><td>The window to show. This method will return when the window is hidden. </td></tr>
592
<a class="anchor" id="a6a8904c35952006d13cb07c1d0c16c10"></a><!-- doxytag: member="Gtk::Main::run" ref="a6a8904c35952006d13cb07c1d0c16c10" args="()" -->
593
<div class="memitem">
594
<div class="memproto">
595
<table class="memname">
597
<td class="memname">static void Gtk::Main::run </td>
599
<td class="paramname"></td><td>)</td>
600
<td><code> [static]</code></td>
606
<p>Start the event loop. </p>
607
<p>This begins the event loop which handles events. No events propagate until this has been called. It may be called recursively to popup dialogs </p>
611
<a class="anchor" id="a2642c570bde971015f97b97cce743f80"></a><!-- doxytag: member="Gtk::Main::run_impl" ref="a2642c570bde971015f97b97cce743f80" args="()" -->
612
<div class="memitem">
613
<div class="memproto">
614
<table class="memname">
616
<td class="memname">virtual void Gtk::Main::run_impl </td>
618
<td class="paramname"></td><td>)</td>
619
<td><code> [protected, virtual]</code></td>
627
<a class="anchor" id="ab4c316c0789dfb4ab7926e062196c4e5"></a><!-- doxytag: member="Gtk::Main::signal_key_snooper" ref="ab4c316c0789dfb4ab7926e062196c4e5" args="()" -->
628
<div class="memitem">
629
<div class="memproto">
630
<table class="memname">
632
<td class="memname">static KeySnooperSig& Gtk::Main::signal_key_snooper </td>
634
<td class="paramname"></td><td>)</td>
635
<td><code> [static]</code></td>
641
<p>KeySnooper signal Allows you to channel keypresses to a signal handler without registering with the widget. </p>
642
<dl class="return"><dt><b>Returns:</b></dt><dd>KeySnooperSig A Signal to which you can connect a sigc::slot< int, Widget *, GdkEventKey * ></dd></dl>
643
<p>It is the responsibility of the snooper to pass the keypress to the widget, however, care must be taken that the keypress is not passed twice. </p>
647
<a class="anchor" id="ac1b6ae5b79cb84158f3caf3e9382492d"></a><!-- doxytag: member="Gtk::Main::signal_quit" ref="ac1b6ae5b79cb84158f3caf3e9382492d" args="()" -->
648
<div class="memitem">
649
<div class="memproto">
650
<table class="memname">
652
<td class="memname">static QuitSig& Gtk::Main::signal_quit </td>
654
<td class="paramname"></td><td>)</td>
655
<td><code> [static]</code></td>
661
<p>Quit signal You can connect signal handlers to invoke actions when <a class="el" href="classGtk_1_1Main.html#a8719a8ac37ff6bb66048ca8967dbd782" title="Makes the innermost invocation of the main loop return when it regains control.">Gtk::Main::quit()</a> has been called. </p>
662
<p>Note that main loops can be nested by calling <a class="el" href="classGtk_1_1Main.html#a6a8904c35952006d13cb07c1d0c16c10" title="Start the event loop.">Gtk::Main::run()</a> recursively, therefore receiving this signal doesn't necessarily mean the application is about to be terminated. If you want to receive a signal only when the last main loop quits, call connect() with <code>main_level = 1</code>. </p>
663
<div class="fragment"><pre class="fragment"> <span class="keywordtype">bool</span> thisclass::mymethod() { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
664
<a class="code" href="classGtk_1_1Main.html#ac1b6ae5b79cb84158f3caf3e9382492d" title="Quit signal You can connect signal handlers to invoke actions when Gtk::Main::quit() has been called...">Gtk::Main::signal_quit</a>().connect(<a class="codeRef" href="../../../libsigc++-2.0/reference/html/group__mem__fun.html#ga7d9ea809173f48bf5c76cf1989591602">sigc::mem_fun</a>(<span class="keyword">this</span>, &thisclass::mymethod));
665
</pre></div> <dl class="return"><dt><b>Returns:</b></dt><dd>bool - <code>false</code> means callback is removed, <code>true</code> means it'll be called again the next the main loop quits.</dd></dl>
666
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000061">Deprecated:</a></b></dt><dd>This was removed in gtkmm-3.0 because it is not useful. </dd></dl>
670
<a class="anchor" id="aec1562f7b2a23858472aa94d23b66173"></a><!-- doxytag: member="Gtk::Main::signal_run" ref="aec1562f7b2a23858472aa94d23b66173" args="()" -->
671
<div class="memitem">
672
<div class="memproto">
673
<table class="memname">
675
<td class="memname">static RunSig& Gtk::Main::signal_run </td>
677
<td class="paramname"></td><td>)</td>
678
<td><code> [static]</code></td>
685
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
689
<hr/><h2>Member Data Documentation</h2>
690
<a class="anchor" id="a97582880bbb0ac12e957861a7ed165a3"></a><!-- doxytag: member="Gtk::Main::signal_key_snooper_" ref="a97582880bbb0ac12e957861a7ed165a3" args="" -->
691
<div class="memitem">
692
<div class="memproto">
693
<table class="memname">
695
<td class="memname">KeySnooperSig <a class="el" href="classGtk_1_1Main.html#a97582880bbb0ac12e957861a7ed165a3">Gtk::Main::signal_key_snooper_</a><code> [static, protected]</code></td>
703
<a class="anchor" id="aee8ba380608053d85a98847eaeb564da"></a><!-- doxytag: member="Gtk::Main::signal_quit_" ref="aee8ba380608053d85a98847eaeb564da" args="" -->
704
<div class="memitem">
705
<div class="memproto">
706
<table class="memname">
708
<td class="memname">QuitSig <a class="el" href="classGtk_1_1Main.html#aee8ba380608053d85a98847eaeb564da">Gtk::Main::signal_quit_</a><code> [static, protected]</code></td>
716
<a class="anchor" id="a459e2ec96368ff1c28f351496c3200d6"></a><!-- doxytag: member="Gtk::Main::signal_run_" ref="a459e2ec96368ff1c28f351496c3200d6" args="" -->
717
<div class="memitem">
718
<div class="memproto">
719
<table class="memname">
721
<td class="memname">RunSig <a class="el" href="classGtk_1_1Main.html#a459e2ec96368ff1c28f351496c3200d6">Gtk::Main::signal_run_</a><code> [static, protected]</code></td>
729
<hr/>The documentation for this class was generated from the following file:<ul>
730
<li>gtkmm/main.h</li>
733
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:46 for gtkmm by 
734
<a href="http://www.doxygen.org/index.html">
735
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1Main.html
