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
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>General</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GDK Reference Manual">
<link rel="up" href="reference.html" title="API Reference">
<link rel="prev" href="reference.html" title="API Reference">
<link rel="next" href="multihead.html" title="Multi-head Support Overview">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="reference.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GDK Reference Manual</th>
<td><a accesskey="n" href="multihead.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gdk-General.synopsis" class="shortcut">Top</a>
|
<a href="#gdk-General.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="General">
<a name="gdk-General"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdk-General.top_of_page"></a>General</span></h2>
<p>General — Library initialization and miscellaneous functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gdk-General.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gdk/gdk.h>
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-init" title="gdk_init ()">gdk_init</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gdk-General.html#gdk-init-check" title="gdk_init_check ()">gdk_init_check</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-parse-args" title="gdk_parse_args ()">gdk_parse_args</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="gdk-General.html#gdk-get-display-arg-name" title="gdk_get_display_arg_name ()">gdk_get_display_arg_name</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="gdk-General.html#gdk-set-locale" title="gdk_set_locale ()">gdk_set_locale</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-set-sm-client-id" title="gdk_set_sm_client_id ()">gdk_set_sm_client_id</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sm_client_id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-exit" title="gdk_exit ()">gdk_exit</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> error_code</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-notify-startup-complete" title="gdk_notify_startup_complete ()">gdk_notify_startup_complete</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-notify-startup-complete-with-id" title="gdk_notify_startup_complete_with_id ()">gdk_notify_startup_complete_with_id</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *startup_id</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gdk-General.html#gdk-get-program-class" title="gdk_get_program_class ()">gdk_get_program_class</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-set-program-class" title="gdk_set_program_class ()">gdk_set_program_class</a> (<em class="parameter"><code>const <span class="type">char</span> *program_class</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="gdk-General.html#gdk-get-display" title="gdk_get_display ()">gdk_get_display</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-flush" title="gdk_flush ()">gdk_flush</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gdk-General.html#gdk-screen-width" title="gdk_screen_width ()">gdk_screen_width</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gdk-General.html#gdk-screen-height" title="gdk_screen_height ()">gdk_screen_height</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gdk-General.html#gdk-screen-width-mm" title="gdk_screen_width_mm ()">gdk_screen_width_mm</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gdk-General.html#gdk-screen-height-mm" title="gdk_screen_height_mm ()">gdk_screen_height_mm</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="gdk-General.html#GdkGrabStatus" title="enum GdkGrabStatus"><span class="returnvalue">GdkGrabStatus</span></a> <a class="link" href="gdk-General.html#gdk-pointer-grab" title="gdk_pointer_grab ()">gdk_pointer_grab</a> (<em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> owner_events</code></em>,
<em class="parameter"><code><a class="link" href="gdk-Events.html#GdkEventMask" title="enum GdkEventMask"><span class="type">GdkEventMask</span></a> event_mask</code></em>,
<em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *confine_to</code></em>,
<em class="parameter"><code><a class="link" href="gdk-Cursors.html#GdkCursor" title="GdkCursor"><span class="type">GdkCursor</span></a> *cursor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);
enum <a class="link" href="gdk-General.html#GdkGrabStatus" title="enum GdkGrabStatus">GdkGrabStatus</a>;
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-pointer-ungrab" title="gdk_pointer_ungrab ()">gdk_pointer_ungrab</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gdk-General.html#gdk-pointer-is-grabbed" title="gdk_pointer_is_grabbed ()">gdk_pointer_is_grabbed</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-set-double-click-time" title="gdk_set_double_click_time ()">gdk_set_double_click_time</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msec</code></em>);
<a class="link" href="gdk-General.html#GdkGrabStatus" title="enum GdkGrabStatus"><span class="returnvalue">GdkGrabStatus</span></a> <a class="link" href="gdk-General.html#gdk-keyboard-grab" title="gdk_keyboard_grab ()">gdk_keyboard_grab</a> (<em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> owner_events</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-keyboard-ungrab" title="gdk_keyboard_ungrab ()">gdk_keyboard_ungrab</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-beep" title="gdk_beep ()">gdk_beep</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gdk-General.html#gdk-get-use-xshm" title="gdk_get_use_xshm ()">gdk_get_use_xshm</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-set-use-xshm" title="gdk_set_use_xshm ()">gdk_set_use_xshm</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_xshm</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gdk-General.html#gdk-error-trap-push" title="gdk_error_trap_push ()">gdk_error_trap_push</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gdk-General.html#gdk-error-trap-pop" title="gdk_error_trap_pop ()">gdk_error_trap_pop</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
#define <a class="link" href="gdk-General.html#GDK-WINDOWING-X11:CAPS" title="GDK_WINDOWING_X11">GDK_WINDOWING_X11</a>
#define <a class="link" href="gdk-General.html#GDK-WINDOWING-WIN32:CAPS" title="GDK_WINDOWING_WIN32">GDK_WINDOWING_WIN32</a>
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gdk-General.description"></a><h2>Description</h2>
<p>
This section describes the GDK initialization functions and miscellaneous
utility functions.
</p>
</div>
<div class="refsect1" title="Details">
<a name="gdk-General.details"></a><h2>Details</h2>
<div class="refsect2" title="gdk_init ()">
<a name="gdk-init"></a><h3>gdk_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_init (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);</pre>
<p>
Initializes the GDK library and connects to the X server.
If initialization fails, a warning message is output and the application
terminates with a call to <code class="literal">exit(1)</code>.
</p>
<p>
Any arguments used by GDK are removed from the array and <em class="parameter"><code>argc</code></em> and <em class="parameter"><code>argv</code></em> are
updated accordingly.
</p>
<p>
GTK+ initializes GDK in <a href="http://library.gnome.org/devel/gtk/unstable/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a> and so this function is not usually needed
by GTK+ applications.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>. <acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>. </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc. <acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym> length=argc. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_init_check ()">
<a name="gdk-init-check"></a><h3>gdk_init_check ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gdk_init_check (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);</pre>
<p>
Initialize the library for use.
</p>
<p>
Arguments:
"argc" is the number of arguments.
"argv" is an array of strings.
</p>
<p>
Results:
"argc" and "argv" are modified to reflect any arguments
which were not handled. (Such arguments should either
be handled by the application or dismissed). If initialization
fails, returns FALSE, otherwise TRUE.
</p>
<p>
Side effects:
The library is initialized.
</p>
<p>
--------------------------------------------------------------
</p>
<p>
Initializes the GDK library and connects to the X server, returning <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on
success.
</p>
<p>
Any arguments used by GDK are removed from the array and <em class="parameter"><code>argc</code></em> and <em class="parameter"><code>argv</code></em> are
updated accordingly.
</p>
<p>
GTK+ initializes GDK in <a href="http://library.gnome.org/devel/gtk/unstable/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a> and so this function is not usually needed
by GTK+ applications.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>. <acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>. </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc. <acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym> length=argc. </td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if initialization succeeded.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_parse_args ()">
<a name="gdk-parse-args"></a><h3>gdk_parse_args ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_parse_args (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);</pre>
<p>
Parse command line arguments, and store for future
use by calls to <a class="link" href="GdkDisplay.html#gdk-display-open" title="gdk_display_open ()"><code class="function">gdk_display_open()</code></a>.
</p>
<p>
Any arguments used by GDK are removed from the array and <em class="parameter"><code>argc</code></em> and <em class="parameter"><code>argv</code></em> are
updated accordingly.
</p>
<p>
You shouldn't call this function explicitely if you are using
<a href="http://library.gnome.org/devel/gtk/unstable/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a>, <a href="http://library.gnome.org/devel/gtk/unstable/gtk-General.html#gtk-init-check"><code class="function">gtk_init_check()</code></a>, <a class="link" href="gdk-General.html#gdk-init" title="gdk_init ()"><code class="function">gdk_init()</code></a>, or <a class="link" href="gdk-General.html#gdk-init-check" title="gdk_init_check ()"><code class="function">gdk_init_check()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>the number of command line arguments.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>the array of command line arguments.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2" title="gdk_get_display_arg_name ()">
<a name="gdk-get-display-arg-name"></a><h3>gdk_get_display_arg_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* gdk_get_display_arg_name (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the display name specified in the command line arguments passed
to <a class="link" href="gdk-General.html#gdk-init" title="gdk_init ()"><code class="function">gdk_init()</code></a> or <a class="link" href="gdk-General.html#gdk-parse-args" title="gdk_parse_args ()"><code class="function">gdk_parse_args()</code></a>, if any.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the display name, if specified explicitely, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
this string is owned by GTK+ and must not be modified or freed.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2" title="gdk_set_locale ()">
<a name="gdk-set-locale"></a><h3>gdk_set_locale ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* gdk_set_locale (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initializes the support for internationalization by calling the <code class="function"><a href="/usr/share/gtk-doc/html/glib/glib-running.html#setlocale"><code class="function">setlocale()</code></a></code>
system call. This function is called by <a href="http://library.gnome.org/devel/gtk/unstable/gtk-General.html#gtk-set-locale"><code class="function">gtk_set_locale()</code></a> and so GTK+
applications should use that instead.
</p>
<p>
The locale to use is determined by the <code class="envar">LANG</code> environment variable,
so to run an application in a certain locale you can do something like this:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">export LANG</span><span class="symbol">=</span><span class="string">"fr"</span>
<span class="symbol">...</span><span class="normal"> run application </span><span class="symbol">...</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
If the locale is not supported by X then it is reset to the standard "C"
locale.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the resulting locale.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_set_sm_client_id ()">
<a name="gdk-set-sm-client-id"></a><h3>gdk_set_sm_client_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_set_sm_client_id (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sm_client_id</code></em>);</pre>
<p>
Sets the <code class="literal">SM_CLIENT_ID</code> property on the application's leader window so that
the window manager can save the application's state using the X11R6 ICCCM
session management protocol.
</p>
<p>
See the X Session Management Library documentation for more information on
session management and the Inter-Client Communication Conventions Manual
(ICCCM) for information on the <code class="literal">WM_CLIENT_LEADER</code> property.
(Both documents are part of the X Window System distribution.)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>sm_client_id</code></em> :</span></p></td>
<td>the client id assigned by the session manager when the
connection was opened, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to remove the property.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_exit ()">
<a name="gdk-exit"></a><h3>gdk_exit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_exit (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> error_code</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gdk_exit</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Exits the application using the <code class="function"><code class="function">exit()</code></code> system call.
</p>
<p>
This routine is provided mainly for backwards compatibility, since it used to
perform tasks necessary to exit the application cleanly. Those tasks are now
performed in a function which is automatically called on exit (via the use
of <a href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-atexit"><code class="function">g_atexit()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>error_code</code></em> :</span></p></td>
<td>the error code to pass to the <code class="function"><code class="function">exit()</code></code> call.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_notify_startup_complete ()">
<a name="gdk-notify-startup-complete"></a><h3>gdk_notify_startup_complete ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_notify_startup_complete (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Indicates to the GUI environment that the application has finished
loading. If the applications opens windows, this function is
normally called after opening the application's initial set of
windows.
</p>
<p>
GTK+ will call this function automatically after opening the first
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"><span class="type">GtkWindow</span></a> unless <a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html#gtk-window-set-auto-startup-notification"><code class="function">gtk_window_set_auto_startup_notification()</code></a> is called
to disable that feature.
</p>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2" title="gdk_notify_startup_complete_with_id ()">
<a name="gdk-notify-startup-complete-with-id"></a><h3>gdk_notify_startup_complete_with_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_notify_startup_complete_with_id (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *startup_id</code></em>);</pre>
<p>
Indicates to the GUI environment that the application has finished
loading, using a given identifier.
</p>
<p>
GTK+ will call this function automatically for <a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"><span class="type">GtkWindow</span></a> with custom
startup-notification identifier unless
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html#gtk-window-set-auto-startup-notification"><code class="function">gtk_window_set_auto_startup_notification()</code></a> is called to disable
that feature.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>startup_id</code></em> :</span></p></td>
<td>a startup-notification identifier, for which notification
process should be completed
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2" title="gdk_get_program_class ()">
<a name="gdk-get-program-class"></a><h3>gdk_get_program_class ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gdk_get_program_class (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the program class. Unless the program class has explicitly
been set with <a class="link" href="gdk-General.html#gdk-set-program-class" title="gdk_set_program_class ()"><code class="function">gdk_set_program_class()</code></a> or with the <code class="option">--class</code>
commandline option, the default value is the program name (determined
with <a href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-get-prgname"><code class="function">g_get_prgname()</code></a>) with the first character converted to uppercase.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the program class.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_set_program_class ()">
<a name="gdk-set-program-class"></a><h3>gdk_set_program_class ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_set_program_class (<em class="parameter"><code>const <span class="type">char</span> *program_class</code></em>);</pre>
<p>
Sets the program class. The X11 backend uses the program class to set
the class name part of the <code class="literal">WM_CLASS</code> property on
toplevel windows; see the ICCCM.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>program_class</code></em> :</span></p></td>
<td>a string.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_get_display ()">
<a name="gdk-get-display"></a><h3>gdk_get_display ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* gdk_get_display (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the name of the display, which usually comes from the <code class="envar">DISPLAY</code>
environment variable or the <code class="option">--display</code> command line option.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the name of the display.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_flush ()">
<a name="gdk-flush"></a><h3>gdk_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_flush (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Flushes the X output buffer and waits until all requests have been processed
by the server. This is rarely needed by applications. It's main use is for
trapping X errors with <a class="link" href="gdk-General.html#gdk-error-trap-push" title="gdk_error_trap_push ()"><code class="function">gdk_error_trap_push()</code></a> and <a class="link" href="gdk-General.html#gdk-error-trap-pop" title="gdk_error_trap_pop ()"><code class="function">gdk_error_trap_pop()</code></a>.
</p>
</div>
<hr>
<div class="refsect2" title="gdk_screen_width ()">
<a name="gdk-screen-width"></a><h3>gdk_screen_width ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gdk_screen_width (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the width of the default screen in pixels.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the width of the default screen in pixels.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_screen_height ()">
<a name="gdk-screen-height"></a><h3>gdk_screen_height ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gdk_screen_height (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the height of the default screen in pixels.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the height of the default screen in pixels.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_screen_width_mm ()">
<a name="gdk-screen-width-mm"></a><h3>gdk_screen_width_mm ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gdk_screen_width_mm (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the width of the default screen in millimeters.
Note that on many X servers this value will not be correct.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the width of the default screen in millimeters,
though it is not always correct.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_screen_height_mm ()">
<a name="gdk-screen-height-mm"></a><h3>gdk_screen_height_mm ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gdk_screen_height_mm (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the height of the default screen in millimeters.
Note that on many X servers this value will not be correct.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the height of the default screen in millimeters,
though it is not always correct.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_pointer_grab ()">
<a name="gdk-pointer-grab"></a><h3>gdk_pointer_grab ()</h3>
<pre class="programlisting"><a class="link" href="gdk-General.html#GdkGrabStatus" title="enum GdkGrabStatus"><span class="returnvalue">GdkGrabStatus</span></a> gdk_pointer_grab (<em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> owner_events</code></em>,
<em class="parameter"><code><a class="link" href="gdk-Events.html#GdkEventMask" title="enum GdkEventMask"><span class="type">GdkEventMask</span></a> event_mask</code></em>,
<em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *confine_to</code></em>,
<em class="parameter"><code><a class="link" href="gdk-Cursors.html#GdkCursor" title="GdkCursor"><span class="type">GdkCursor</span></a> *cursor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);</pre>
<p>
Grabs the pointer (usually a mouse) so that all events are passed to this
application until the pointer is ungrabbed with <a class="link" href="gdk-General.html#gdk-pointer-ungrab" title="gdk_pointer_ungrab ()"><code class="function">gdk_pointer_ungrab()</code></a>, or
the grab window becomes unviewable.
This overrides any previous pointer grab by this client.
</p>
<p>
Pointer grabs are used for operations which need complete control over mouse
events, even if the mouse leaves the application.
For example in GTK+ it is used for Drag and Drop, for dragging the handle in
the <a href="http://library.gnome.org/devel/gtk/unstable/GtkHPaned.html"><span class="type">GtkHPaned</span></a> and <a href="http://library.gnome.org/devel/gtk/unstable/GtkVPaned.html"><span class="type">GtkVPaned</span></a> widgets, and for resizing columns in <a href="http://library.gnome.org/devel/gtk/unstable/GtkCList.html"><span class="type">GtkCList</span></a>
widgets.
</p>
<p>
Note that if the event mask of an X window has selected both button press and
button release events, then a button press event will cause an automatic
pointer grab until the button is released.
X does this automatically since most applications expect to receive button
press and release events in pairs.
It is equivalent to a pointer grab on the window with <em class="parameter"><code>owner_events</code></em> set to
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</p>
<p>
If you set up anything at the time you take the grab that needs to be cleaned
up when the grab ends, you should handle the <a class="link" href="gdk-Event-Structures.html#GdkEventGrabBroken" title="GdkEventGrabBroken"><span class="type">GdkEventGrabBroken</span></a> events that
are emitted when the grab ends unvoluntarily.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> which will own the grab (the grab window).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>owner_events</code></em> :</span></p></td>
<td>if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> then all pointer events are reported with respect to
<em class="parameter"><code>window</code></em> and are only reported if selected by <em class="parameter"><code>event_mask</code></em>. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then pointer
events for this application are reported as normal, but pointer events outside
this application are reported with respect to <em class="parameter"><code>window</code></em> and only if selected by
<em class="parameter"><code>event_mask</code></em>. In either mode, unreported events are discarded.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event_mask</code></em> :</span></p></td>
<td>specifies the event mask, which is used in accordance with
<em class="parameter"><code>owner_events</code></em>. Note that only pointer events (i.e. button and motion events)
may be selected.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>confine_to</code></em> :</span></p></td>
<td>If non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the pointer will be confined to this
window during the grab. If the pointer is outside <em class="parameter"><code>confine_to</code></em>, it will
automatically be moved to the closest edge of <em class="parameter"><code>confine_to</code></em> and enter
and leave events will be generated as necessary.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cursor</code></em> :</span></p></td>
<td>the cursor to display while the grab is active. If this is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then
the normal cursors are used for <em class="parameter"><code>window</code></em> and its descendants, and the cursor
for <em class="parameter"><code>window</code></em> is used for all other windows.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_</code></em> :</span></p></td>
<td>the timestamp of the event which led to this pointer grab. This usually
comes from a <a class="link" href="gdk-Event-Structures.html#GdkEventButton" title="GdkEventButton"><span class="type">GdkEventButton</span></a> struct, though <a class="link" href="gdk-Events.html#GDK-CURRENT-TIME:CAPS" title="GDK_CURRENT_TIME"><code class="literal">GDK_CURRENT_TIME</code></a> can be used if
the time isn't known.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="gdk-General.html#GDK-GRAB-SUCCESS:CAPS"><code class="literal">GDK_GRAB_SUCCESS</code></a> if the grab was successful.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum GdkGrabStatus">
<a name="GdkGrabStatus"></a><h3>enum GdkGrabStatus</h3>
<pre class="programlisting">typedef enum
{
GDK_GRAB_SUCCESS = 0,
GDK_GRAB_ALREADY_GRABBED = 1,
GDK_GRAB_INVALID_TIME = 2,
GDK_GRAB_NOT_VIEWABLE = 3,
GDK_GRAB_FROZEN = 4
} GdkGrabStatus;
</pre>
<p>
Returned by <a class="link" href="gdk-General.html#gdk-pointer-grab" title="gdk_pointer_grab ()"><code class="function">gdk_pointer_grab()</code></a> and <a class="link" href="gdk-General.html#gdk-keyboard-grab" title="gdk_keyboard_grab ()"><code class="function">gdk_keyboard_grab()</code></a> to indicate
success or the reason for the failure of the grab attempt.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDK-GRAB-SUCCESS:CAPS"></a><span class="term"><code class="literal">GDK_GRAB_SUCCESS</code></span></p></td>
<td>the resource was successfully grabbed.
</td>
</tr>
<tr>
<td><p><a name="GDK-GRAB-ALREADY-GRABBED:CAPS"></a><span class="term"><code class="literal">GDK_GRAB_ALREADY_GRABBED</code></span></p></td>
<td>the resource is actively grabbed by another client.
</td>
</tr>
<tr>
<td><p><a name="GDK-GRAB-INVALID-TIME:CAPS"></a><span class="term"><code class="literal">GDK_GRAB_INVALID_TIME</code></span></p></td>
<td>the resource was grabbed more recently than the
specified time.
</td>
</tr>
<tr>
<td><p><a name="GDK-GRAB-NOT-VIEWABLE:CAPS"></a><span class="term"><code class="literal">GDK_GRAB_NOT_VIEWABLE</code></span></p></td>
<td>the grab window or the <em class="parameter"><code>confine_to</code></em> window are not
viewable.
</td>
</tr>
<tr>
<td><p><a name="GDK-GRAB-FROZEN:CAPS"></a><span class="term"><code class="literal">GDK_GRAB_FROZEN</code></span></p></td>
<td>the resource is frozen by an active grab of another client.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_pointer_ungrab ()">
<a name="gdk-pointer-ungrab"></a><h3>gdk_pointer_ungrab ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_pointer_ungrab (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);</pre>
<p>
Ungrabs the pointer on the default display, if it is grabbed by this
application.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>time_</code></em> :</span></p></td>
<td>a timestamp from a <a class="link" href="gdk-Event-Structures.html#GdkEvent" title="union GdkEvent"><span class="type">GdkEvent</span></a>, or <a class="link" href="gdk-Events.html#GDK-CURRENT-TIME:CAPS" title="GDK_CURRENT_TIME"><code class="literal">GDK_CURRENT_TIME</code></a> if no
timestamp is available.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_pointer_is_grabbed ()">
<a name="gdk-pointer-is-grabbed"></a><h3>gdk_pointer_is_grabbed ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gdk_pointer_is_grabbed (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the pointer on the default display is currently
grabbed by this application.
</p>
<p>
Note that this does not take the inmplicit pointer grab on button
presses into account.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the pointer is currently grabbed by this application.*
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_set_double_click_time ()">
<a name="gdk-set-double-click-time"></a><h3>gdk_set_double_click_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_set_double_click_time (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msec</code></em>);</pre>
<p>
Set the double click time for the default display. See
<a class="link" href="GdkDisplay.html#gdk-display-set-double-click-time" title="gdk_display_set_double_click_time ()"><code class="function">gdk_display_set_double_click_time()</code></a>.
See also <a class="link" href="GdkDisplay.html#gdk-display-set-double-click-distance" title="gdk_display_set_double_click_distance ()"><code class="function">gdk_display_set_double_click_distance()</code></a>.
Applications should <span class="emphasis"><em>not</em></span> set this, it is a
global user-configured setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>msec</code></em> :</span></p></td>
<td>double click time in milliseconds (thousandths of a second)
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_keyboard_grab ()">
<a name="gdk-keyboard-grab"></a><h3>gdk_keyboard_grab ()</h3>
<pre class="programlisting"><a class="link" href="gdk-General.html#GdkGrabStatus" title="enum GdkGrabStatus"><span class="returnvalue">GdkGrabStatus</span></a> gdk_keyboard_grab (<em class="parameter"><code><a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> owner_events</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);</pre>
<p>
Grabs the keyboard so that all events are passed to this
application until the keyboard is ungrabbed with <a class="link" href="gdk-General.html#gdk-keyboard-ungrab" title="gdk_keyboard_ungrab ()"><code class="function">gdk_keyboard_ungrab()</code></a>.
This overrides any previous keyboard grab by this client.
</p>
<p>
If you set up anything at the time you take the grab that needs to be cleaned
up when the grab ends, you should handle the <a class="link" href="gdk-Event-Structures.html#GdkEventGrabBroken" title="GdkEventGrabBroken"><span class="type">GdkEventGrabBroken</span></a> events that
are emitted when the grab ends unvoluntarily.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a class="link" href="gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> which will own the grab (the grab window).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>owner_events</code></em> :</span></p></td>
<td>if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> then all keyboard events are reported with respect to
<em class="parameter"><code>window</code></em>. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then keyboard events for this application are reported as
normal, but keyboard events outside this application are reported with respect
to <em class="parameter"><code>window</code></em>. Both key press and key release events are always reported,
independant of the event mask set by the application.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_</code></em> :</span></p></td>
<td>a timestamp from a <a class="link" href="gdk-Event-Structures.html#GdkEvent" title="union GdkEvent"><span class="type">GdkEvent</span></a>, or <a class="link" href="gdk-Events.html#GDK-CURRENT-TIME:CAPS" title="GDK_CURRENT_TIME"><code class="literal">GDK_CURRENT_TIME</code></a> if no timestamp is
available.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="gdk-General.html#GDK-GRAB-SUCCESS:CAPS"><code class="literal">GDK_GRAB_SUCCESS</code></a> if the grab was successful.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_keyboard_ungrab ()">
<a name="gdk-keyboard-ungrab"></a><h3>gdk_keyboard_ungrab ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_keyboard_ungrab (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);</pre>
<p>
Ungrabs the keyboard on the default display, if it is grabbed by this
application.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>time_</code></em> :</span></p></td>
<td>a timestamp from a <a class="link" href="gdk-Event-Structures.html#GdkEvent" title="union GdkEvent"><span class="type">GdkEvent</span></a>, or <a class="link" href="gdk-Events.html#GDK-CURRENT-TIME:CAPS" title="GDK_CURRENT_TIME"><code class="literal">GDK_CURRENT_TIME</code></a> if no
timestamp is available.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_beep ()">
<a name="gdk-beep"></a><h3>gdk_beep ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_beep (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Emits a short beep on the default display.
</p>
</div>
<hr>
<div class="refsect2" title="gdk_get_use_xshm ()">
<a name="gdk-get-use-xshm"></a><h3>gdk_get_use_xshm ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gdk_get_use_xshm (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gdk_get_use_xshm</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if GDK will attempt to use the MIT-SHM shared memory extension.
</p>
<p>
The shared memory extension is used for <a class="link" href="gdk-Images.html#GdkImage" title="GdkImage"><span class="type">GdkImage</span></a>, and consequently for
<a class="link" href="gdk-GdkRGB.html" title="GdkRGB">GdkRGB</a>.
It enables much faster drawing by communicating with the X server through
SYSV shared memory calls. However, it can only be used if the X client and
server are on the same machine and the server supports it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if use of the MIT shared memory extension will be attempted.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_set_use_xshm ()">
<a name="gdk-set-use-xshm"></a><h3>gdk_set_use_xshm ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_set_use_xshm (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_xshm</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gdk_set_use_xshm</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets whether the use of the MIT shared memory extension should be attempted.
This function is mainly for internal use. It is only safe for an application
to set this to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, since if it is set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and the server does not
support the extension it may cause warning messages to be output.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>use_xshm</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if use of the MIT shared memory extension should be attempted.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdk_error_trap_push ()">
<a name="gdk-error-trap-push"></a><h3>gdk_error_trap_push ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdk_error_trap_push (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function allows X errors to be trapped instead of the normal behavior
of exiting the application. It should only be used if it is not possible to
avoid the X error in any other way.
</p>
<div class="example">
<a name="id419847"></a><p class="title"><b>Example 1. Trapping an X error</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="gdk-General.html#gdk-error-trap-push">gdk_error_trap_push</a></span><span class="normal"> </span><span class="symbol">();</span>
<span class="comment">/* ... Call the X function which may cause an error here ... */</span>
<span class="comment">/* Flush the X queue to catch errors now. */</span>
<span class="function"><a href="gdk-General.html#gdk-flush">gdk_flush</a></span><span class="normal"> </span><span class="symbol">();</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="gdk-General.html#gdk-error-trap-pop">gdk_error_trap_pop</a></span><span class="normal"> </span><span class="symbol">())</span>
<span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="comment">/* ... Handle the error here ... */</span>
<span class="normal"> </span><span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break">
</div>
<hr>
<div class="refsect2" title="gdk_error_trap_pop ()">
<a name="gdk-error-trap-pop"></a><h3>gdk_error_trap_pop ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gdk_error_trap_pop (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Removes the X error trap installed with <a class="link" href="gdk-General.html#gdk-error-trap-push" title="gdk_error_trap_push ()"><code class="function">gdk_error_trap_push()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the X error code, or 0 if no error occurred.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GDK_WINDOWING_X11">
<a name="GDK-WINDOWING-X11:CAPS"></a><h3>GDK_WINDOWING_X11</h3>
<pre class="programlisting">#define GDK_WINDOWING_X11
</pre>
<p>
This macro is defined if GDK is configured to use the X backend.
</p>
</div>
<hr>
<div class="refsect2" title="GDK_WINDOWING_WIN32">
<a name="GDK-WINDOWING-WIN32:CAPS"></a><h3>GDK_WINDOWING_WIN32</h3>
<pre class="programlisting">#define GDK_WINDOWING_WIN32
</pre>
<p>
This macro is defined if GDK is configured to use the Win32 backend.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
