Generate references by introspection
[cl-gtk2.git] / doc / gdk.ref.texi
1 @menu
2 * gdk Classes::
3 * gdk Enums::
4 * gdk Flags::
5 @end menu
6
7 @node gdk Classes
8 @section gdk Classes
9
10 @menu
11 * display::
12 * display-manager::
13 * drag-context::
14 * drawable::
15 * gdk-window::
16 * graphics-context::
17 * keymap::
18 * pango-layout::
19 * pixbuf::
20 * pixbuf-animation::
21 * pixmap::
22 * screen::
23 @end menu
24
25 Reference of classes in package GDK
26
27 @node display
28 @subsection display
29 @Class display
30
31 Superclasses: @ref{g-object}
32
33 Slots:
34 None
35
36 Signals:
37 @itemize
38 @item closed. (@code{boolean}) -> @code{null}  [run-last]
39
40 @end itemize
41
42 @node display-manager
43 @subsection display-manager
44 @Class display-manager
45
46 Superclasses: @ref{g-object}
47
48 Slots:
49 @itemize
50 @item default-display. Type: @ref{display} (flags: readable writable)
51
52
53
54 @end itemize
55 Signals:
56 @itemize
57 @item display-opened. (@ref{display}) -> @code{null}  [run-last]
58
59 @end itemize
60
61 @node drag-context
62 @subsection drag-context
63 @Class drag-context
64
65 Superclasses: @ref{g-object}
66
67 Slots:
68 None
69
70 Signals:
71 None
72
73
74 @node drawable
75 @subsection drawable
76 @Class drawable
77
78 Superclasses: @ref{g-object}
79
80 Slots:
81 None
82
83 Signals:
84 None
85
86
87 @node gdk-window
88 @subsection gdk-window
89 @Class gdk-window
90
91 Superclasses: @ref{drawable}
92
93 Slots:
94 None
95
96 Signals:
97 None
98
99
100 @node graphics-context
101 @subsection graphics-context
102 @Class graphics-context
103
104 Superclasses: @ref{g-object}
105
106 Slots:
107 None
108
109 Signals:
110 None
111
112
113 @node keymap
114 @subsection keymap
115 @Class keymap
116
117 Superclasses: @ref{g-object}
118
119 Slots:
120 None
121
122 Signals:
123 None
124
125
126 @node pango-layout
127 @subsection pango-layout
128 @Class pango-layout
129
130 Superclasses: @ref{g-object}
131
132 Slots:
133 None
134
135 Signals:
136 None
137
138
139 @node pixbuf
140 @subsection pixbuf
141 @Class pixbuf
142
143 Superclasses: @ref{g-object}
144
145 Slots:
146 @itemize
147 @item bits-per-sample. Type: @code{integer} (flags: readable writable constructor-only)
148
149
150
151 @item colorspace. Type: @ref{colorspace} (flags: readable writable constructor-only)
152
153
154
155 @item has-alpha. Type: @code{boolean} (flags: readable writable constructor-only)
156
157
158
159 @item height. Type: @code{integer} (flags: readable writable constructor-only)
160
161
162
163 @item n-channels. Type: @code{integer} (flags: readable writable constructor-only)
164
165
166
167 @item pixels. Type: @code{foreign-pointer} (flags: readable writable constructor-only)
168
169
170
171 @item rowstride. Type: @code{integer} (flags: readable writable constructor-only)
172
173
174
175 @item width. Type: @code{integer} (flags: readable writable constructor-only)
176
177
178
179 @end itemize
180 Signals:
181 None
182
183
184 @node pixbuf-animation
185 @subsection pixbuf-animation
186 @Class pixbuf-animation
187
188 Superclasses: @ref{g-object}
189
190 Slots:
191 None
192
193 Signals:
194 None
195
196
197 @node pixmap
198 @subsection pixmap
199 @Class pixmap
200
201 Superclasses: @ref{drawable}
202
203 Slots:
204 None
205
206 Signals:
207 None
208
209
210 @node screen
211 @subsection screen
212 @Class screen
213
214 Superclasses: @ref{g-object}
215
216 Slots:
217 @itemize
218 @item font-options. Type: @code{foreign-pointer} (flags: readable writable)
219
220
221
222 @item resolution. Type: @code{double-float} (flags: readable writable)
223
224
225
226 @end itemize
227 Signals:
228 @itemize
229 @item composited-changed. () -> @code{null}  [run-last]
230
231 @item monitors-changed. () -> @code{null}  [run-last]
232
233 @item size-changed. () -> @code{null}  [run-last]
234
235 @end itemize
236
237 @node gdk Enums
238 @section gdk Enums
239
240 @menu
241 * colorspace::
242 * event-type::
243 * font-type::
244 * gdk-extension-mode::
245 * gdk-window-type-hint::
246 * grab-status::
247 * gravity::
248 * owner-change::
249 * property-state::
250 * scroll-direction::
251 * setting-action::
252 * visibility-state::
253 * window-edge::
254 @end menu
255
256 Reference of enums in package GDK
257
258 @node colorspace
259 @subsection colorspace
260 @Enum colorspace
261 Values:
262 @itemize
263 @item :rgb
264 @end itemize
265
266
267 @node event-type
268 @subsection event-type
269 @Enum event-type
270 Values:
271 @itemize
272 @item :nothing
273 @item :delete
274 @item :destroy
275 @item :expose
276 @item :motion-notify
277 @item :button-press
278 @item :2button-press
279 @item :3button-press
280 @item :button-release
281 @item :key-press
282 @item :key-release
283 @item :enter-notify
284 @item :leave-notify
285 @item :focus-change
286 @item :configure
287 @item :map
288 @item :unmap
289 @item :property-notify
290 @item :selection-clear
291 @item :selection-request
292 @item :selection-notify
293 @item :proximity-in
294 @item :proximity-out
295 @item :drag-enter
296 @item :drag-leave
297 @item :drag-motion
298 @item :drag-status
299 @item :drop-start
300 @item :drop-finished
301 @item :client-event
302 @item :visibility-notify
303 @item :no-expose
304 @item :scroll
305 @item :window-state
306 @item :setting
307 @item :owner-change
308 @item :grab-broken
309 @item :damage
310 @end itemize
311
312
313 @node font-type
314 @subsection font-type
315 @Enum font-type
316 Values:
317 @itemize
318 @item :font
319 @item :fontset
320 @end itemize
321
322
323 @node gdk-extension-mode
324 @subsection gdk-extension-mode
325 @Enum gdk-extension-mode
326 Values:
327 @itemize
328 @item :none
329 @item :all
330 @item :cursor
331 @end itemize
332
333
334 @node gdk-window-type-hint
335 @subsection gdk-window-type-hint
336 @Enum gdk-window-type-hint
337 Values:
338 @itemize
339 @item :normal
340 @item :dialog
341 @item :menu
342 @item :toolbar
343 @item :splashscreen
344 @item :utility
345 @item :dock
346 @item :desktop
347 @item :dropdown-menu
348 @item :popup-menu
349 @item :tooltip
350 @item :notification
351 @item :combo
352 @item :dnd
353 @end itemize
354
355
356 @node grab-status
357 @subsection grab-status
358 @Enum grab-status
359 Values:
360 @itemize
361 @item :success
362 @item :already-grabbed
363 @item :invalid-time
364 @item :not-viewable
365 @item :frozen
366 @end itemize
367
368
369 @node gravity
370 @subsection gravity
371 @Enum gravity
372 Values:
373 @itemize
374 @item :north-west
375 @item :north
376 @item :north-east
377 @item :west
378 @item :center
379 @item :east
380 @item :south-west
381 @item :south
382 @item :south-east
383 @item :static
384 @end itemize
385
386
387 @node owner-change
388 @subsection owner-change
389 @Enum owner-change
390 Values:
391 @itemize
392 @item :new-owner
393 @item :destroy
394 @item :close
395 @end itemize
396
397
398 @node property-state
399 @subsection property-state
400 @Enum property-state
401 Values:
402 @itemize
403 @item :new-value
404 @item :delete
405 @end itemize
406
407
408 @node scroll-direction
409 @subsection scroll-direction
410 @Enum scroll-direction
411 Values:
412 @itemize
413 @item :up
414 @item :down
415 @item :left
416 @item :right
417 @end itemize
418
419
420 @node setting-action
421 @subsection setting-action
422 @Enum setting-action
423 Values:
424 @itemize
425 @item :new
426 @item :changed
427 @item :deleted
428 @end itemize
429
430
431 @node visibility-state
432 @subsection visibility-state
433 @Enum visibility-state
434 Values:
435 @itemize
436 @item :unobscured
437 @item :partial
438 @item :fully-obscured
439 @end itemize
440
441
442 @node window-edge
443 @subsection window-edge
444 @Enum window-edge
445 Values:
446 @itemize
447 @item :north-west
448 @item :north
449 @item :north-east
450 @item :west
451 @item :east
452 @item :south-west
453 @item :south
454 @item :south-east
455 @end itemize
456
457
458 @node gdk Flags
459 @section gdk Flags
460
461 @menu
462 * event-mask::
463 * window-hints::
464 * window-state::
465 @end menu
466
467 Reference of flags in package GDK
468
469 @node event-mask
470 @subsection event-mask
471 @Flags event-mask
472 Values:
473 @itemize
474 @item :exposure-mask
475 @item :pointer-motion-mask
476 @item :pointer-motion-hint-mask
477 @item :button-motion-mask
478 @item :button1-motion-mask
479 @item :button2-motion-mask
480 @item :button3-motion-mask
481 @item :button-press-mask
482 @item :button-release-mask
483 @item :key-press-mask
484 @item :key-release-mask
485 @item :enter-notify-mask
486 @item :leave-notify-mask
487 @item :focus-change-mask
488 @item :structure-mask
489 @item :property-change-mask
490 @item :visibility-notify-mask
491 @item :proximity-in-mask
492 @item :proximity-out-mask
493 @item :substructure-mask
494 @item :scroll-mask
495 @item :all-events-mask
496 @end itemize
497
498
499 @node window-hints
500 @subsection window-hints
501 @Flags window-hints
502 Values:
503 @itemize
504 @item :pos
505 @item :min-size
506 @item :max-size
507 @item :base-size
508 @item :aspect
509 @item :resize-inc
510 @item :win-gravity
511 @item :user-pos
512 @item :user-size
513 @end itemize
514
515
516 @node window-state
517 @subsection window-state
518 @Flags window-state
519 Values:
520 @itemize
521 @item :withdrawn
522 @item :iconified
523 @item :maximized
524 @item :sticky
525 @item :fullscreen
526 @item :above
527 @item :below
528 @end itemize
529
530