added some function documentations.
[platform/upstream/glib.git] / docs / reference / gobject / tmpl / objects.sgml
1 <!-- ##### SECTION Title ##### -->
2 The Base Object Type
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### STRUCT GObject ##### -->
18 <para>
19
20 </para>
21
22 @g_type_instance: 
23
24 <!-- ##### STRUCT GObjectClass ##### -->
25 <para>
26
27 </para>
28
29
30 <!-- ##### STRUCT GObjectConstructParam ##### -->
31 <para>
32
33 </para>
34
35 @pspec: 
36 @value: 
37 @trailer: 
38
39 <!-- ##### USER_FUNCTION GObjectGetPropertyFunc ##### -->
40 <para>
41
42 </para>
43
44 @object: 
45 @property_id: 
46 @value: 
47 @pspec: 
48 @trailer: 
49
50
51 <!-- ##### USER_FUNCTION GObjectSetPropertyFunc ##### -->
52 <para>
53
54 </para>
55
56 @object: 
57 @property_id: 
58 @value: 
59 @pspec: 
60 @trailer: 
61
62
63 <!-- ##### MACRO G_OBJECT ##### -->
64 <para>
65
66 </para>
67
68 @object: 
69
70
71 <!-- ##### MACRO G_OBJECT_GET_CLASS ##### -->
72 <para>
73
74 </para>
75
76 @object: 
77
78
79 <!-- ##### MACRO G_OBJECT_TYPE ##### -->
80 <para>
81
82 </para>
83
84 @object: 
85
86
87 <!-- ##### MACRO G_OBJECT_TYPE_NAME ##### -->
88 <para>
89
90 </para>
91
92 @object: 
93
94
95 <!-- ##### MACRO G_OBJECT_CLASS_TYPE ##### -->
96 <para>
97
98 </para>
99
100 @class: 
101
102
103 <!-- ##### MACRO G_OBJECT_CLASS_NAME ##### -->
104 <para>
105
106 </para>
107
108 @class: 
109
110
111 <!-- ##### MACRO G_IS_VALUE_OBJECT ##### -->
112 <para>
113
114 </para>
115
116 @value: 
117
118
119 <!-- ##### MACRO G_TYPE_IS_OBJECT ##### -->
120 <para>
121
122 </para>
123
124 @type: 
125
126
127 <!-- ##### MACRO G_IS_OBJECT ##### -->
128 <para>
129
130 </para>
131
132 @object: 
133
134
135 <!-- ##### MACRO G_OBJECT_CLASS ##### -->
136 <para>
137
138 </para>
139
140 @class: 
141
142
143 <!-- ##### MACRO G_IS_OBJECT_CLASS ##### -->
144 <para>
145
146 </para>
147
148 @class: 
149
150
151 <!-- ##### USER_FUNCTION GObjectFinalizeFunc ##### -->
152 <para>
153
154 </para>
155
156 @object: 
157
158
159 <!-- ##### FUNCTION g_object_class_install_property ##### -->
160 <para>
161
162 </para>
163
164 @oclass: 
165 @property_id: 
166 @pspec: 
167
168
169 <!-- ##### FUNCTION g_object_class_find_property ##### -->
170 <para>
171
172 </para>
173
174 @oclass: 
175 @property_name: 
176 @Returns: 
177
178
179 <!-- ##### FUNCTION g_object_new ##### -->
180 <para>
181
182 </para>
183
184 @object_type: 
185 @first_property_name: 
186 @Varargs: 
187 @Returns: 
188 <!-- # Unused Parameters # -->
189 @first_param_name: 
190
191
192 <!-- ##### FUNCTION g_object_new_valist ##### -->
193 <para>
194
195 </para>
196
197 @object_type: 
198 @first_property_name: 
199 @var_args: 
200 @Returns: 
201 <!-- # Unused Parameters # -->
202 @first_param_name: 
203
204
205 <!-- ##### FUNCTION g_object_set ##### -->
206 <para>
207
208 </para>
209
210 @object: 
211 @first_property_name: 
212 @Varargs: 
213 <!-- # Unused Parameters # -->
214 @first_param_name: 
215
216
217 <!-- ##### FUNCTION g_object_get ##### -->
218 <para>
219
220 </para>
221
222 @object: 
223 @first_property_name: 
224 @Varargs: 
225 <!-- # Unused Parameters # -->
226 @first_param_name: 
227
228
229 <!-- ##### FUNCTION g_object_set_valist ##### -->
230 <para>
231
232 </para>
233
234 @object: 
235 @first_property_name: 
236 @var_args: 
237 <!-- # Unused Parameters # -->
238 @first_param_name: 
239
240
241 <!-- ##### FUNCTION g_object_get_valist ##### -->
242 <para>
243
244 </para>
245
246 @object: 
247 @first_property_name: 
248 @var_args: 
249 <!-- # Unused Parameters # -->
250 @first_param_name: 
251
252
253 <!-- ##### FUNCTION g_object_set_property ##### -->
254 <para>
255
256 </para>
257
258 @object: 
259 @property_name: 
260 @value: 
261
262
263 <!-- ##### FUNCTION g_object_get_property ##### -->
264 <para>
265
266 </para>
267
268 @object: 
269 @property_name: 
270 @value: 
271
272
273 <!-- ##### FUNCTION g_object_freeze_notify ##### -->
274 <para>
275
276 </para>
277
278 @object: 
279
280
281 <!-- ##### FUNCTION g_object_notify ##### -->
282 <para>
283
284 </para>
285
286 @object: 
287 @property_name: 
288
289
290 <!-- ##### FUNCTION g_object_thaw_notify ##### -->
291 <para>
292
293 </para>
294
295 @object: 
296
297
298 <!-- ##### FUNCTION g_object_ref ##### -->
299 <para>
300
301 </para>
302
303 @object: 
304 @Returns: 
305
306
307 <!-- ##### FUNCTION g_object_unref ##### -->
308 <para>
309
310 </para>
311
312 @object: 
313
314
315 <!-- ##### FUNCTION g_object_get_qdata ##### -->
316 <para>
317
318 </para>
319
320 @object: 
321 @quark: 
322 @Returns: 
323
324
325 <!-- ##### FUNCTION g_object_set_qdata ##### -->
326 <para>
327
328 </para>
329
330 @object: 
331 @quark: 
332 @data: 
333
334
335 <!-- ##### FUNCTION g_object_set_qdata_full ##### -->
336 <para>
337
338 </para>
339
340 @object: 
341 @quark: 
342 @data: 
343 @destroy: 
344
345
346 <!-- ##### FUNCTION g_object_steal_qdata ##### -->
347 <para>
348
349 </para>
350
351 @object: 
352 @quark: 
353 @Returns: 
354
355
356 <!-- ##### FUNCTION g_object_get_data ##### -->
357 <para>
358
359 </para>
360
361 @object: 
362 @key: 
363 @Returns: 
364
365
366 <!-- ##### FUNCTION g_object_set_data ##### -->
367 <para>
368
369 </para>
370
371 @object: 
372 @key: 
373 @data: 
374
375
376 <!-- ##### FUNCTION g_object_set_data_full ##### -->
377 <para>
378
379 </para>
380
381 @object: 
382 @key: 
383 @data: 
384 @destroy: 
385
386
387 <!-- ##### FUNCTION g_object_steal_data ##### -->
388 <para>
389
390 </para>
391
392 @object: 
393 @key: 
394 @Returns: 
395
396
397 <!-- ##### FUNCTION g_value_set_object ##### -->
398 <para>
399
400 </para>
401
402 @value: 
403 @v_object: 
404
405
406 <!-- ##### FUNCTION g_value_get_object ##### -->
407 <para>
408
409 </para>
410
411 @value: 
412 @Returns: 
413
414
415 <!-- ##### FUNCTION g_value_dup_object ##### -->
416 <para>
417
418 </para>
419
420 @value: 
421 @Returns: 
422
423
424 <!-- ##### FUNCTION g_object_watch_closure ##### -->
425 <para>
426
427 </para>
428
429 @object: 
430 @closure: 
431
432
433 <!-- ##### MACRO G_OBJECT_WARN_INVALID_PROPERTY_ID ##### -->
434 <para>
435
436 </para>
437
438 @object: 
439 @property_id: 
440 @pspec: 
441
442