summaryrefslogtreecommitdiff
path: root/docs/reference/gdk/tmpl/gdkdisplay.sgml
blob: 5f1d7891eb340bb26cfa05da115370880ba02d28 (plain)
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
<!-- ##### SECTION Title ##### -->
GdkDisplay

<!-- ##### SECTION Short_Description ##### -->
Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s

<!-- ##### SECTION Long_Description ##### -->
<para>
#GdkDisplay objects purpose are two fold:
<itemizedlist>
<listitem><para>To grab/ungrab keyboard focus and mouse pointer</para></listitem>
<listitem><para>To manage and provide information about the #GdkScreen(s) 
		available for this #GdkDisplay
	  </para></listitem>
</itemizedlist>
</para>
<para>
  #GdkDisplay objects are the GDK representation of the X Display which can be 
  described as <emphasis>a workstation consisting of a keyboard a pointing
  device (such as a mouse) and one or more screens</emphasis>. 
  It is used to open and keep track of various #GdkScreen objects currently 
  instanciated by the application. It is also used to grab and release the keyboard 
  and the mouse pointer.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GdkDisplay ##### -->
<para>
The <structname>GdkDisplay</structname> struct is the GDK representation
of an X display. All its fields are private and should not be accessed directly. 
</para>

@Since: 2.2

<!-- ##### SIGNAL GdkDisplay::closed ##### -->
<para>

</para>

@gdkdisplay: the object which received the signal.
@arg1: 

<!-- ##### FUNCTION gdk_display_open ##### -->
<para>

</para>

@display_name: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_default ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gdk_display_get_name ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_n_screens ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_screen ##### -->
<para>

</para>

@display: 
@screen_num: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_default_screen ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_pointer_ungrab ##### -->
<para>

</para>

@display: 
@time_: 


<!-- ##### FUNCTION gdk_display_keyboard_ungrab ##### -->
<para>

</para>

@display: 
@time_: 


<!-- ##### FUNCTION gdk_display_pointer_is_grabbed ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_beep ##### -->
<para>

</para>

@display: 


<!-- ##### FUNCTION gdk_display_sync ##### -->
<para>

</para>

@display: 


<!-- ##### FUNCTION gdk_display_flush ##### -->
<para>

</para>

@display: 


<!-- ##### FUNCTION gdk_display_close ##### -->
<para>

</para>

@display: 


<!-- ##### FUNCTION gdk_display_list_devices ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_event ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_peek_event ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_put_event ##### -->
<para>

</para>

@display: 
@event: 


<!-- ##### FUNCTION gdk_display_add_client_message_filter ##### -->
<para>

</para>

@display: 
@message_type: 
@func: 
@data: 


<!-- ##### FUNCTION gdk_display_set_double_click_time ##### -->
<para>

</para>

@display: 
@msec: 


<!-- ##### FUNCTION gdk_display_set_double_click_distance ##### -->
<para>

</para>

@display: 
@distance: 


<!-- ##### FUNCTION gdk_display_get_pointer ##### -->
<para>

</para>

@display: 
@screen: 
@x: 
@y: 
@mask: 


<!-- ##### FUNCTION gdk_display_get_window_at_pointer ##### -->
<para>

</para>

@display: 
@win_x: 
@win_y: 
@Returns: 


<!-- ##### STRUCT GdkDisplayPointerHooks ##### -->
<para>
A table of pointers to functions for getting quantities related to 
the current pointer position. Each #GdkDisplay has a table of this type,
which can be set using gdk_display_set_pointer_hooks().
</para>
<para>
This is only useful for such low-level tools as an event recorder. 
Applications should never have any reason to use this facility
</para>

@get_pointer: Obtains the current pointer position and modifier state.
  The position is given in coordinates relative to the window containing 
  the pointer, which is returned in @window.
@window_get_pointer: Obtains the window underneath the mouse pointer.
  Current pointer position and modifier state are returned in @x, @y and 
  @mask. The position is given in coordinates relative to @window.
@window_at_pointer: Obtains the window underneath the mouse pointer, 
  returning the location of that window in @win_x, @win_y. Returns %NULL 
  if the window under the mouse pointer is not known to GDK (for example, 
  belongs to another application).
@Since: 2.2

<!-- ##### FUNCTION gdk_display_set_pointer_hooks ##### -->
<para>

</para>

@display: 
@new_hooks: 
@Returns: 


<!-- ##### FUNCTION gdk_display_supports_cursor_color ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_supports_cursor_alpha ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_default_cursor_size ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_get_maximal_cursor_size ##### -->
<para>

</para>

@display: 
@width: 
@height: 


<!-- ##### FUNCTION gdk_display_get_default_group ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_supports_selection_notification ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_request_selection_notification ##### -->
<para>

</para>

@display: 
@selection: 
@Returns: 


<!-- ##### FUNCTION gdk_display_supports_clipboard_persistence ##### -->
<para>

</para>

@display: 
@Returns: 


<!-- ##### FUNCTION gdk_display_store_clipboard ##### -->
<para>

</para>

@display: 
@clipboard_window: 
@time_: 
@targets: 
@n_targets: