1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1></h1>The initialization, main event loop and event namespace.
<a href="#_details">More...</a>
<p>
<h2>Classes</h2>
<ul>
<li>class <a class="el" href="classGFC_1_1Main_1_1QuitSignal.html">GFC::Main::QuitSignal</a>
<dl class="el"><dd class="mdescRight">Quit signal class. <a href="classGFC_1_1Main_1_1QuitSignal.html#_details">More...</a><br></dl><li>class <a class="el" href="classGFC_1_1Main_1_1KeySnooperSignal.html">GFC::Main::KeySnooperSignal</a>
<dl class="el"><dd class="mdescRight">KeySnooper signal class. <a href="classGFC_1_1Main_1_1KeySnooperSignal.html#_details">More...</a><br></dl></ul>
<h2>Initializers</h2>
<ul>
<li>void <a class="el" href="namespaceGFC_1_1Main.html#a2">init</a> (int *argc, char ***argv)
<dl class="el"><dd class="mdescRight">Initialize the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> library. <a href="#a2"></a><br></dl><li>bool <a class="el" href="namespaceGFC_1_1Main.html#a3">init_check</a> (int *argc, char ***argv)
<dl class="el"><dd class="mdescRight">Initialize the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> library. <a href="#a3"></a><br></dl><li>void <a class="el" href="namespaceGFC_1_1Main.html#a4">init_add</a> (const sigc::slot< bool > &callback)
<dl class="el"><dd class="mdescRight">Register a slot to be called when the mainloop is started. <a href="#a4"></a><br></dl></ul>
<h2>Accessors</h2>
<ul>
<li>PangoLanguage * <a class="el" href="namespaceGFC_1_1Main.html#a5">default_language</a> ()
<dl class="el"><dd class="mdescRight">Get the default language currently in effect. <a href="#a5"></a><br></dl><li>bool <a class="el" href="namespaceGFC_1_1Main.html#a6">events_pending</a> ()
<dl class="el"><dd class="mdescRight">Checks if any events are pending. <a href="#a6"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1Event.html">Gdk::Event</a> > <a class="el" href="namespaceGFC_1_1Main.html#a7">get_current_event</a> ()
<dl class="el"><dd class="mdescRight">Obtains a copy of the event currently being processed by GTK+. <a href="#a7"></a><br></dl><li>unsigned int <a class="el" href="namespaceGFC_1_1Main.html#a8">get_current_event_time</a> ()
<dl class="el"><dd class="mdescRight">If there is a current event and it has a timestamp, return that timestamp, otherwise return GDK_CURRENT_TIME. <a href="#a8"></a><br></dl><li>bool <a class="el" href="namespaceGFC_1_1Main.html#a9">get_current_event_state</a> (<a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> *state)
<dl class="el"><dd class="mdescRight">If there is a current event and it has a state field, place that state field in <em>state</em> and return true, otherwise return false. <a href="#a9"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Gtk::Widget</a> > <a class="el" href="namespaceGFC_1_1Main.html#a10">get_event_widget</a> (<a class="el" href="classGFC_1_1Gdk_1_1Event.html">Gdk::Event</a> &event)
<dl class="el"><dd class="mdescRight">Get the widget that originally received the <em>event</em>. <a href="#a10"></a><br></dl></ul>
<h2>Main Event Loop</h2>
<ul>
<li>void <a class="el" href="namespaceGFC_1_1Main.html#a11">run</a> ()
<dl class="el"><dd class="mdescRight">Runs the main loop until <a class="el" href="namespaceGFC_1_1Main.html#a13">quit()</a> is called. <a href="#a11"></a><br></dl><li>int <a class="el" href="namespaceGFC_1_1Main.html#a12">level</a> ()
<dl class="el"><dd class="mdescRight">Asks for the current nesting level of the main loop. <a href="#a12"></a><br></dl><li><a class="anchor" name="a13" doxytag="GFC::Main::quit" ></a>
void <a class="el" href="namespaceGFC_1_1Main.html#a13">quit</a> ()
<dl class="el"><dd class="mdescRight">Makes the innermost invocation of the main loop return when it regains control. <br></dl><li>bool <a class="el" href="namespaceGFC_1_1Main.html#a14">iterate</a> (bool blocking=true)
<dl class="el"><dd class="mdescRight">Runs a single iteration of the mainloop. <a href="#a14"></a><br></dl><li>void <a class="el" href="namespaceGFC_1_1Main.html#a15">grab_add</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Gtk::Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Makes <em>widget</em> the current grabbed widget. <a href="#a15"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Gtk::Widget</a> > <a class="el" href="namespaceGFC_1_1Main.html#a16">grab_get_current</a> ()
<dl class="el"><dd class="mdescRight">Queries the current grab. <a href="#a16"></a><br></dl><li>void <a class="el" href="namespaceGFC_1_1Main.html#a17">grab_remove</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Gtk::Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Removes the grab from the given widget. <a href="#a17"></a><br></dl></ul>
<h2>Signals</h2>
<ul>
<li><a class="anchor" name="a0" doxytag="GFC::Main::quit_signal" ></a>
<a class="el" href="classGFC_1_1Main_1_1QuitSignal.html">QuitSignal</a> <a class="el" href="namespaceGFC_1_1Main.html#a0">quit_signal</a>
<dl class="el"><dd class="mdescRight">A namespace instance of the <a class="el" href="classGFC_1_1Main_1_1QuitSignal.html">QuitSignal</a> for connecting slots to be invoked at the termination of the current mainloop. <br></dl><li><a class="anchor" name="a1" doxytag="GFC::Main::key_snooper_signal" ></a>
<a class="el" href="classGFC_1_1Main_1_1KeySnooperSignal.html">KeySnooperSignal</a> <a class="el" href="namespaceGFC_1_1Main.html#a1">key_snooper_signal</a>
<dl class="el"><dd class="mdescRight">A namespace instance of the <a class="el" href="classGFC_1_1Main_1_1KeySnooperSignal.html">KeySnooperSignal</a> for connecting slots that will receive keypress events. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The initialization, main event loop and event namespace.
<p>
Provides a set of methods and signals for handling program initialization and custom event loop processing.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a5" doxytag="GFC::Main::default_language" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> PangoLanguage* default_language </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the default language currently in effect.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The ISO language code for the default language currently in effect.</dd></dl>
<br>
Note that this can change over the life of an application. The default language is derived from the current locale. It determines, for example, whether <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> uses the right-to-left or left-to-right text direction. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="GFC::Main::events_pending" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool events_pending </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Checks if any events are pending.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if any events are pending, <em>false</em> otherwise.</dd></dl>
<br>
This can be used to update the GUI and invoke timeouts etc. while doing some time intensive computation.<p>
<b>Example:</b> Updating the GUI during a long computation. <div class="fragment"><pre> <span class="comment">// computation going on</span>
...
<span class="keywordflow">while</span> (<a class="code" href="namespaceGFC_1_1Main.html#a6">events_pending</a>())
<a class="code" href="namespaceGFC_1_1Main.html#a14">iterate</a>();
...
<span class="comment">// computation continued</span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="GFC::Main::get_current_event" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1Event.html">Gdk::Event</a>> get_current_event </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains a copy of the event currently being processed by GTK+.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A copy of the current event, or null if there is no current event.</dd></dl>
<br>
For example, if you get a "clicked" signal from <a class="el" href="classGFC_1_1Gtk_1_1Button.html">Gtk::Button</a>, the current event will be the <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html">Gdk::EventButton</a> that triggered the "clicked" signal. If there is no current event, the function returns null. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="GFC::Main::get_current_event_state" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool get_current_event_state </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>state</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If there is a current event and it has a state field, place that state field in <em>state</em> and return true, otherwise return false.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>state</em> </td><td>The location to store the state of the current event. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if there was a current event and it had a state field. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="GFC::Main::get_current_event_time" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int get_current_event_time </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If there is a current event and it has a timestamp, return that timestamp, otherwise return GDK_CURRENT_TIME.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The timestamp from the current event, or GDK_CURRENT_TIME. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a10" doxytag="GFC::Main::get_event_widget" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Gtk::Widget</a>> get_event_widget </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">Gdk::Event & </td>
<td class="mdname1" valign="top" nowrap> <em>event</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the widget that originally received the <em>event</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>event</em> </td><td>A reference to a <a class="el" href="classGFC_1_1Gdk_1_1Event.html">Gdk::Event</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The widget that originally received event, or null.</dd></dl>
<br>
If <em>event</em> is null or the event was not associated with any widget, returns null, otherwise returns the widget that received the event originally. The widget is returned as a smart pointer because there is the possiblity that the widget was wrapped for the first time and needs to be unreferenced. </td>
</tr>
</table>
<a class="anchor" name="a15" doxytag="GFC::Main::grab_add" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void grab_add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">Gtk::Widget & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Makes <em>widget</em> the current grabbed widget.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>The widget that grabs keyboard and pointer events.</td></tr>
</table>
</dl>
<br>
This means that interaction with other widgets in the same application is blocked and mouse as well as keyboard events are delivered to this widget. </td>
</tr>
</table>
<a class="anchor" name="a16" doxytag="GFC::Main::grab_get_current" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Gtk::Widget</a>> grab_get_current </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Queries the current grab.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The widget which currently has the grab or null if no grab is active. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a17" doxytag="GFC::Main::grab_remove" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void grab_remove </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">Gtk::Widget & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Removes the grab from the given widget.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>The widget which gives up the grab. You have to pair calls to <a class="el" href="namespaceGFC_1_1Main.html#a15">grab_add()</a> and <a class="el" href="namespaceGFC_1_1Main.html#a17">grab_remove()</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="GFC::Main::init" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void init </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>char *** </td>
<td class="mdname" nowrap> <em>argv</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initialize the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> library.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>argc</em> </td><td>Address of the argc parameter of your main function. Changed if any arguments were handled. </td></tr>
<tr><td></td><td valign=top><em>argv</em> </td><td>Address of the argv parameter of main(). Any parameters understood by <a class="el" href="namespaceGFC_1_1Main.html#a2">init()</a> are stripped before returning.</td></tr>
</table>
</dl>
<br>
Call this method before using any other <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> methods in your GUI applications. It will initialize everything needed to operate the toolkit and parses some standard command line options. argc and argv are adjusted accordingly so your own code will never see those standard arguments. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="GFC::Main::init_add" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void init_add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const sigc::slot< bool > & </td>
<td class="mdname1" valign="top" nowrap> <em>callback</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Register a slot to be called when the mainloop is started.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>callback</em> </td><td>A slot to invoke when main() is called next.</td></tr>
</table>
</dl>
<br>
The callback slot should return false to remove it from the list of slots to call, otherwise it might get called again. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="GFC::Main::init_check" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool init_check </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>char *** </td>
<td class="mdname" nowrap> <em>argv</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initialize the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> library.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>argc</em> </td><td>A reference to the argc of the main() function. </td></tr>
<tr><td></td><td valign=top><em>argv</em> </td><td>A reference to the argv of the main() function. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the GUI has been successfully initialized, <em>false</em> otherwise.</dd></dl>
<br>
This method does the same work as <a class="el" href="namespaceGFC_1_1Main.html#a2">init()</a> with only a single change: It does not terminate the program if the GUI can't be initialized. Instead it returns <em>false</em> on failure. This way the application can fall back to some other means of communication with the user - for example a command line interface. </td>
</tr>
</table>
<a class="anchor" name="a14" doxytag="GFC::Main::iterate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool iterate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>blocking</em> = <code>true</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Runs a single iteration of the mainloop.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>blocking</em> </td><td>Set <em>true</em> if you want to block if no events are pending. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if <a class="el" href="namespaceGFC_1_1Main.html#a13">quit()</a> has been called for the innermost mainloop.</dd></dl>
<br>
If <em>blocking</em> is true and no events are waiting to be processed <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> will block until the next event is noticed. If <em>blocking</em> is false and no events are available return. </td>
</tr>
</table>
<a class="anchor" name="a12" doxytag="GFC::Main::level" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int level </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Asks for the current nesting level of the main loop.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The nesting level of the current invocation of the main loop.</dd></dl>
<br>
This can be useful when connecting a slot to the <em>quit_signal</em>. </td>
</tr>
</table>
<a class="anchor" name="a11" doxytag="GFC::Main::run" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void run </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Runs the main loop until <a class="el" href="namespaceGFC_1_1Main.html#a13">quit()</a> is called.
<p>
You can nest calls to <a class="el" href="namespaceGFC_1_1Main.html#a11">run()</a>. In that case <a class="el" href="namespaceGFC_1_1Main.html#a13">quit()</a> will make the innermost invocation of the main loop return. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:45 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
