tarball import: glib-2.25.8.tar.bz2
[mirror-ossqm-glib2.git] / docs / reference / gobject / tmpl / gparamspec.sgml
blob4a781067945b8ee296efcbc7ed333524e2b14ad2
1 <!-- ##### SECTION Title ##### -->
2 GParamSpec
4 <!-- ##### SECTION Short_Description ##### -->
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
10 </para>
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
15 </para>
17 <!-- ##### SECTION Stability_Level ##### -->
20 <!-- ##### SECTION Image ##### -->
23 <!-- ##### MACRO G_TYPE_IS_PARAM ##### -->
24 <para>
26 </para>
28 @type:
31 <!-- ##### MACRO G_PARAM_SPEC ##### -->
32 <para>
34 </para>
36 @pspec:
39 <!-- ##### MACRO G_IS_PARAM_SPEC ##### -->
40 <para>
42 </para>
44 @pspec:
47 <!-- ##### MACRO G_PARAM_SPEC_CLASS ##### -->
48 <para>
50 </para>
52 @pclass:
55 <!-- ##### MACRO G_IS_PARAM_SPEC_CLASS ##### -->
56 <para>
58 </para>
60 @pclass:
63 <!-- ##### MACRO G_PARAM_SPEC_GET_CLASS ##### -->
64 <para>
66 </para>
68 @pspec:
71 <!-- ##### MACRO G_PARAM_SPEC_TYPE ##### -->
72 <para>
74 </para>
76 @pspec:
79 <!-- ##### MACRO G_PARAM_SPEC_TYPE_NAME ##### -->
80 <para>
82 </para>
84 @pspec:
87 <!-- ##### MACRO G_PARAM_SPEC_VALUE_TYPE ##### -->
88 <para>
90 </para>
92 @pspec:
95 <!-- ##### STRUCT GParamSpec ##### -->
96 <para>
98 </para>
100 @g_type_instance:
101 @name:
102 @flags:
103 @value_type:
104 @owner_type:
106 <!-- ##### STRUCT GParamSpecClass ##### -->
107 <para>
109 </para>
111 @g_type_class:
112 @value_type:
113 @finalize:
114 @value_set_default:
115 @value_validate:
116 @values_cmp:
118 <!-- ##### ENUM GParamFlags ##### -->
119 <para>
121 </para>
123 @G_PARAM_READABLE:
124 @G_PARAM_WRITABLE:
125 @G_PARAM_CONSTRUCT:
126 @G_PARAM_CONSTRUCT_ONLY:
127 @G_PARAM_LAX_VALIDATION:
128 @G_PARAM_STATIC_NAME:
129 @G_PARAM_PRIVATE:
130 @G_PARAM_STATIC_NICK:
131 @G_PARAM_STATIC_BLURB:
133 <!-- ##### MACRO G_PARAM_READWRITE ##### -->
134 <para>
136 </para>
140 <!-- ##### MACRO G_PARAM_STATIC_STRINGS ##### -->
141 <para>
143 </para>
147 <!-- ##### MACRO G_PARAM_MASK ##### -->
148 <para>
150 </para>
154 <!-- ##### MACRO G_PARAM_USER_SHIFT ##### -->
155 <para>
157 </para>
161 <!-- ##### FUNCTION g_param_spec_ref ##### -->
162 <para>
164 </para>
166 @pspec:
167 @Returns:
170 <!-- ##### FUNCTION g_param_spec_unref ##### -->
171 <para>
173 </para>
175 @pspec:
178 <!-- ##### FUNCTION g_param_spec_sink ##### -->
179 <para>
181 </para>
183 @pspec:
186 <!-- ##### FUNCTION g_param_spec_ref_sink ##### -->
187 <para>
189 </para>
191 @pspec:
192 @Returns:
195 <!-- ##### FUNCTION g_param_value_set_default ##### -->
196 <para>
198 </para>
200 @pspec:
201 @value:
204 <!-- ##### FUNCTION g_param_value_defaults ##### -->
205 <para>
207 </para>
209 @pspec:
210 @value:
211 @Returns:
214 <!-- ##### FUNCTION g_param_value_validate ##### -->
215 <para>
217 </para>
219 @pspec:
220 @value:
221 @Returns:
224 <!-- ##### FUNCTION g_param_value_convert ##### -->
225 <para>
227 </para>
229 @pspec:
230 @src_value:
231 @dest_value:
232 @strict_validation:
233 @Returns:
236 <!-- ##### FUNCTION g_param_values_cmp ##### -->
237 <para>
239 </para>
241 @pspec:
242 @value1:
243 @value2:
244 @Returns:
247 <!-- ##### FUNCTION g_param_spec_get_name ##### -->
248 <para>
250 </para>
252 @pspec:
253 @Returns:
256 <!-- ##### FUNCTION g_param_spec_get_nick ##### -->
257 <para>
259 </para>
261 @pspec:
262 @Returns:
265 <!-- ##### FUNCTION g_param_spec_get_blurb ##### -->
266 <para>
268 </para>
270 @pspec:
271 @Returns:
274 <!-- ##### FUNCTION g_param_spec_get_qdata ##### -->
275 <para>
277 </para>
279 @pspec:
280 @quark:
281 @Returns:
284 <!-- ##### FUNCTION g_param_spec_set_qdata ##### -->
285 <para>
287 </para>
289 @pspec:
290 @quark:
291 @data:
294 <!-- ##### FUNCTION g_param_spec_set_qdata_full ##### -->
295 <para>
297 </para>
299 @pspec:
300 @quark:
301 @data:
302 @destroy:
305 <!-- ##### FUNCTION g_param_spec_steal_qdata ##### -->
306 <para>
308 </para>
310 @pspec:
311 @quark:
312 @Returns:
315 <!-- ##### FUNCTION g_param_spec_get_redirect_target ##### -->
316 <para>
318 </para>
320 @pspec:
321 @Returns:
324 <!-- ##### FUNCTION g_param_spec_internal ##### -->
325 <para>
327 </para>
329 @param_type:
330 @name:
331 @nick:
332 @blurb:
333 @flags:
334 @Returns:
337 <!-- ##### STRUCT GParamSpecTypeInfo ##### -->
338 <para>
340 </para>
342 @instance_size:
343 @n_preallocs:
344 @instance_init:
345 @value_type:
346 @finalize:
347 @value_set_default:
348 @value_validate:
349 @values_cmp:
351 <!-- ##### FUNCTION g_param_type_register_static ##### -->
352 <para>
354 </para>
356 @name:
357 @pspec_info:
358 @Returns:
361 <!-- ##### STRUCT GParamSpecPool ##### -->
362 <para>
364 </para>
367 <!-- ##### FUNCTION g_param_spec_pool_new ##### -->
368 <para>
370 </para>
372 @type_prefixing:
373 @Returns:
376 <!-- ##### FUNCTION g_param_spec_pool_insert ##### -->
377 <para>
379 </para>
381 @pool:
382 @pspec:
383 @owner_type:
386 <!-- ##### FUNCTION g_param_spec_pool_remove ##### -->
387 <para>
389 </para>
391 @pool:
392 @pspec:
395 <!-- ##### FUNCTION g_param_spec_pool_lookup ##### -->
396 <para>
398 </para>
400 @pool:
401 @param_name:
402 @owner_type:
403 @walk_ancestors:
404 @Returns:
407 <!-- ##### FUNCTION g_param_spec_pool_list ##### -->
408 <para>
410 </para>
412 @pool:
413 @owner_type:
414 @n_pspecs_p:
415 @Returns:
418 <!-- ##### FUNCTION g_param_spec_pool_list_owned ##### -->
419 <para>
421 </para>
423 @pool:
424 @owner_type:
425 @Returns: