Added documentation skeleton and merged skeleton with exisiting docs
[cl-gtk2.git] / doc / gdk.objects.texi
1 @menu
2 @c * display::
3 * display-manager::
4 * drag-context::
5 * drawable::
6 * gdk-colormap::
7 * gdk-window::
8 * graphics-context::
9 * keymap::
10 * pango-layout::
11 * pixbuf::
12 * pixbuf-animation::
13 * pixmap::
14 @c * screen::
15 * visual::
16 @end menu
17
18 @c @node display
19 @c @section display
20 @c @Class display
21 @c Superclass: @ref{g-object}
22
23 @c Slots:
24 @c @itemize
25 @c @item @anchor{slot.display.name}name. Type: @code{string}. Accessor: @anchor{fn.display-name}@code{display-name}. Read-only.
26 @c @item @anchor{slot.display.n-screens}n-screens. Type: @code{integer}. Accessor: @anchor{fn.display-n-screens}@code{display-n-screens}. Read-only.
27 @c @item @anchor{slot.display.default-screen}default-screen. Type: @ref{screen}. Accessor: @anchor{fn.display-default-screen}@code{display-default-screen}. Read-only.
28 @c @end itemize
29
30
31 @c Signals:
32 @c @itemize
33 @c @item @anchor{signal.display.closed}"closed". Signature: (instance @ref{display}), (arg-1 @code{boolean}) @result{} void. Options: run-last.
34 @c @end itemize
35
36
37
38
39 @node display-manager
40 @section display-manager
41 @Class display-manager
42 Superclass: @ref{g-object}
43
44 Slots:
45 @itemize
46 @item @anchor{slot.display-manager.default-display}default-display. Type: @ref{display}. Accessor: @anchor{fn.display-manager-default-display}@code{display-manager-default-display}.
47 @end itemize
48
49
50 Signals:
51 @itemize
52 @item @anchor{signal.display-manager.display-opened}"display-opened". Signature: (instance @ref{display-manager}), (arg-1 @ref{display}) @result{} void. Options: run-last.
53 @end itemize
54
55
56
57
58 @node drag-context
59 @section drag-context
60 @Class drag-context
61 Superclass: @ref{g-object}
62
63 Slots:
64 @itemize
65 @end itemize
66
67
68 Signals:
69 @itemize
70 @end itemize
71
72
73
74
75 @node drawable
76 @section drawable
77 @Class drawable
78 Superclass: @ref{g-object}
79
80 Subclasses: @ref{gdk-window} @ref{pixmap}
81
82 Slots:
83 @itemize
84 @end itemize
85
86
87 Signals:
88 @itemize
89 @end itemize
90
91
92
93
94 @node gdk-colormap
95 @section gdk-colormap
96 @Class gdk-colormap
97 Superclass: @ref{g-object}
98
99 Slots:
100 @itemize
101 @end itemize
102
103
104 Signals:
105 @itemize
106 @end itemize
107
108
109
110
111 @node gdk-window
112 @section gdk-window
113 @Class gdk-window
114 Superclass: @ref{drawable}
115
116 Slots:
117 @itemize
118 @end itemize
119
120
121 Signals:
122 @itemize
123 @end itemize
124
125
126
127
128 @node graphics-context
129 @section graphics-context
130 @Class graphics-context
131 Superclass: @ref{g-object}
132
133 Slots:
134 @itemize
135 @end itemize
136
137
138 Signals:
139 @itemize
140 @end itemize
141
142
143
144
145 @node keymap
146 @section keymap
147 @Class keymap
148 Superclass: @ref{g-object}
149
150 Slots:
151 @itemize
152 @end itemize
153
154
155 Signals:
156 @itemize
157 @end itemize
158
159
160
161
162 @node pango-layout
163 @section pango-layout
164 @Class pango-layout
165 Superclass: @ref{g-object}
166
167 Slots:
168 @itemize
169 @end itemize
170
171
172 Signals:
173 @itemize
174 @end itemize
175
176
177
178
179 @node pixbuf
180 @section pixbuf
181 @Class pixbuf
182 Superclass: @ref{g-object}
183
184 Slots:
185 @itemize
186 @item @anchor{slot.pixbuf.colorspace}colorspace. Type: @ref{colorspace}. Accessor: @anchor{fn.pixbuf-colorspace}@code{pixbuf-colorspace}.
187 @item @anchor{slot.pixbuf.n-channels}n-channels. Type: @code{integer}. Accessor: @anchor{fn.pixbuf-n-channels}@code{pixbuf-n-channels}.
188 @item @anchor{slot.pixbuf.has-alpha}has-alpha. Type: @code{boolean}. Accessor: @anchor{fn.pixbuf-has-alpha}@code{pixbuf-has-alpha}.
189 @item @anchor{slot.pixbuf.bits-per-sample}bits-per-sample. Type: @code{integer}. Accessor: @anchor{fn.pixbuf-bits-per-sample}@code{pixbuf-bits-per-sample}.
190 @item @anchor{slot.pixbuf.width}width. Type: @code{integer}. Accessor: @anchor{fn.pixbuf-width}@code{pixbuf-width}.
191 @item @anchor{slot.pixbuf.height}height. Type: @code{integer}. Accessor: @anchor{fn.pixbuf-height}@code{pixbuf-height}.
192 @item @anchor{slot.pixbuf.rowstride}rowstride. Type: @code{integer}. Accessor: @anchor{fn.pixbuf-rowstride}@code{pixbuf-rowstride}.
193 @item @anchor{slot.pixbuf.pixels}pixels. Type: gpointer. Accessor: @anchor{fn.pixbuf-pixels}@code{pixbuf-pixels}.
194 @end itemize
195
196
197 Signals:
198 @itemize
199 @end itemize
200
201
202
203
204 @node pixbuf-animation
205 @section pixbuf-animation
206 @Class pixbuf-animation
207 Superclass: @ref{g-object}
208
209 Slots:
210 @itemize
211 @end itemize
212
213
214 Signals:
215 @itemize
216 @end itemize
217
218
219
220
221 @node pixmap
222 @section pixmap
223 @Class pixmap
224 Superclass: @ref{drawable}
225
226 Slots:
227 @itemize
228 @end itemize
229
230
231 Signals:
232 @itemize
233 @end itemize
234
235
236
237
238 @c @node screen
239 @c @section screen
240 @c @Class screen
241 @c Superclass: @ref{g-object}
242
243 @c Slots:
244 @c @itemize
245 @c @item @anchor{slot.screen.font-options}font-options. Type: gpointer. Accessor: @anchor{fn.screen-font-options}@code{screen-font-options}.
246 @c @item @anchor{slot.screen.resolution}resolution. Type: @code{double-float}. Accessor: @anchor{fn.screen-resolution}@code{screen-resolution}.
247 @c @item @anchor{slot.screen.default-colormap}default-colormap. Type: @ref{colormap}. Accessor: @anchor{fn.screen-default-colormap}@code{screen-default-colormap}.
248 @c @item @anchor{slot.screen.system-colormap}system-colormap. Type: @ref{colormap}. Accessor: @anchor{fn.screen-system-colormap}@code{screen-system-colormap}. Read-only.
249 @c @item @anchor{slot.screen.system-visual}system-visual. Type: @ref{visual}. Accessor: @anchor{fn.screen-system-visual}@code{screen-system-visual}. Read-only.
250 @c @item @anchor{slot.screen.rgb-colormap}rgb-colormap. Type: @ref{colormap}. Accessor: @anchor{fn.screen-rgb-colormap}@code{screen-rgb-colormap}. Read-only.
251 @c @item @anchor{slot.screen.rgb-visual}rgb-visual. Type: @ref{visual}. Accessor: @anchor{fn.screen-rgb-visual}@code{screen-rgb-visual}. Read-only.
252 @c @item @anchor{slot.screen.rgba-colormap}rgba-colormap. Type: @ref{colormap}. Accessor: @anchor{fn.screen-rgba-colormap}@code{screen-rgba-colormap}. Read-only.
253 @c @item @anchor{slot.screen.rgba-visual}rgba-visual. Type: @ref{visual}. Accessor: @anchor{fn.screen-rgba-visual}@code{screen-rgba-visual}. Read-only.
254 @c @item @anchor{slot.screen.composited-p}composited-p. Type: @code{boolean}. Accessor: @anchor{fn.screen-composited-p}@code{screen-composited-p}. Read-only.
255 @c @item @anchor{slot.screen.root-window}root-window. Type: @ref{gdk-window}. Accessor: @anchor{fn.screen-root-window}@code{screen-root-window}. Read-only.
256 @c @item @anchor{slot.screen.display}display. Type: @ref{display}. Accessor: @anchor{fn.screen-display}@code{screen-display}. Read-only.
257 @c @item @anchor{slot.screen.number}number. Type: @code{integer}. Accessor: @anchor{fn.screen-number}@code{screen-number}. Read-only.
258 @c @item @anchor{slot.screen.width}width. Type: @code{integer}. Accessor: @anchor{fn.screen-width}@code{screen-width}. Read-only.
259 @c @item @anchor{slot.screen.height}height. Type: @code{integer}. Accessor: @anchor{fn.screen-height}@code{screen-height}. Read-only.
260 @c @item @anchor{slot.screen.width-mm}width-mm. Type: @code{integer}. Accessor: @anchor{fn.screen-width-mm}@code{screen-width-mm}. Read-only.
261 @c @item @anchor{slot.screen.height-mm}height-mm. Type: @code{integer}. Accessor: @anchor{fn.screen-height-mm}@code{screen-height-mm}. Read-only.
262 @c @item @anchor{slot.screen.visuals}visuals. Type: list of @ref{visual}. Accessor: @anchor{fn.screen-visuals}@code{screen-visuals}. Read-only.
263 @c @item @anchor{slot.screen.toplevel-windows}toplevel-windows. Type: list of @ref{gdk-window}. Accessor: @anchor{fn.screen-toplevel-windows}@code{screen-toplevel-windows}. Read-only.
264 @c @item @anchor{slot.screen.display-name}display-name. Type: @code{string}. Accessor: @anchor{fn.screen-display-name}@code{screen-display-name}. Read-only.
265 @c @item @anchor{slot.screen.n-monitors}n-monitors. Type: @code{integer}. Accessor: @anchor{fn.screen-n-monitors}@code{screen-n-monitors}. Read-only.
266 @c @item @anchor{slot.screen.active-window}active-window. Type: @ref{gdk-window}. Accessor: @anchor{fn.screen-active-window}@code{screen-active-window}. Read-only.
267 @c @item @anchor{slot.screen.window-stack}window-stack. Type: list of @ref{gdk-window}. Accessor: @anchor{fn.screen-window-stack}@code{screen-window-stack}. Read-only.
268 @c @end itemize
269
270
271 @c Signals:
272 @c @itemize
273 @c @item @anchor{signal.screen.size-changed}"size-changed". Signature: (instance @ref{screen}) @result{} void. Options: run-last.
274 @c @item @anchor{signal.screen.composited-changed}"composited-changed". Signature: (instance @ref{screen}) @result{} void. Options: run-last.
275 @c @item @anchor{signal.screen.monitors-changed}"monitors-changed". Signature: (instance @ref{screen}) @result{} void. Options: run-last.
276 @c @end itemize
277
278
279
280
281 @node visual
282 @section visual
283 @Class visual
284 Superclass: @ref{g-object}
285
286 Slots:
287 @itemize
288 @end itemize
289
290
291 Signals:
292 @itemize
293 @end itemize
294
295
296
297