|
sl@0
|
1 |
/* GObject - GLib Type, Object, Parameter and Signal Library
|
|
sl@0
|
2 |
* Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
|
|
sl@0
|
3 |
* Portions copyright (c) 2006-2009 Nokia Corporation. All rights reserved.
|
|
sl@0
|
4 |
* This library is free software; you can redistribute it and/or
|
|
sl@0
|
5 |
* modify it under the terms of the GNU Lesser General Public
|
|
sl@0
|
6 |
* License as published by the Free Software Foundation; either
|
|
sl@0
|
7 |
* version 2 of the License, or (at your option) any later version.
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* This library is distributed in the hope that it will be useful,
|
|
sl@0
|
10 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
sl@0
|
11 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
sl@0
|
12 |
* Lesser General Public License for more details.
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* You should have received a copy of the GNU Lesser General
|
|
sl@0
|
15 |
* Public License along with this library; if not, write to the
|
|
sl@0
|
16 |
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
sl@0
|
17 |
* Boston, MA 02111-1307, USA.
|
|
sl@0
|
18 |
*
|
|
sl@0
|
19 |
* gparam.h: GParamSpec base class implementation
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
|
|
sl@0
|
22 |
#error "Only <glib-object.h> can be included directly."
|
|
sl@0
|
23 |
#endif
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#ifndef __G_PARAM_H__
|
|
sl@0
|
26 |
#define __G_PARAM_H__
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#include <gobject/gvalue.h>
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
G_BEGIN_DECLS
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
/* --- standard type macros --- */
|
|
sl@0
|
33 |
/**
|
|
sl@0
|
34 |
* G_TYPE_IS_PARAM:
|
|
sl@0
|
35 |
* @type: a #GType ID
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* Checks whether @type "is a" %G_TYPE_PARAM.
|
|
sl@0
|
38 |
*/
|
|
sl@0
|
39 |
#define G_TYPE_IS_PARAM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)
|
|
sl@0
|
40 |
/**
|
|
sl@0
|
41 |
* G_PARAM_SPEC:
|
|
sl@0
|
42 |
* @pspec: a valid #GParamSpec
|
|
sl@0
|
43 |
*
|
|
sl@0
|
44 |
* Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into
|
|
sl@0
|
45 |
* a #GParamSpec object.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
#define G_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))
|
|
sl@0
|
48 |
/**
|
|
sl@0
|
49 |
* G_IS_PARAM_SPEC:
|
|
sl@0
|
50 |
* @pspec: a #GParamSpec
|
|
sl@0
|
51 |
*
|
|
sl@0
|
52 |
* Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM
|
|
sl@0
|
53 |
* or derived.
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
#define G_IS_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))
|
|
sl@0
|
56 |
/**
|
|
sl@0
|
57 |
* G_PARAM_SPEC_CLASS:
|
|
sl@0
|
58 |
* @pclass: a valid #GParamSpecClass
|
|
sl@0
|
59 |
*
|
|
sl@0
|
60 |
* Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure.
|
|
sl@0
|
61 |
*/
|
|
sl@0
|
62 |
#define G_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_CAST ((pclass), G_TYPE_PARAM, GParamSpecClass))
|
|
sl@0
|
63 |
/**
|
|
sl@0
|
64 |
* G_IS_PARAM_SPEC_CLASS:
|
|
sl@0
|
65 |
* @pclass: a #GParamSpecClass
|
|
sl@0
|
66 |
*
|
|
sl@0
|
67 |
* Checks whether @pclass "is a" valid #GParamSpecClass structure of type
|
|
sl@0
|
68 |
* %G_TYPE_PARAM or derived.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
#define G_IS_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_TYPE ((pclass), G_TYPE_PARAM))
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
* G_PARAM_SPEC_GET_CLASS:
|
|
sl@0
|
73 |
* @pspec: a valid #GParamSpec
|
|
sl@0
|
74 |
*
|
|
sl@0
|
75 |
* Retrieves the #GParamSpecClass of a #GParamSpec.
|
|
sl@0
|
76 |
*/
|
|
sl@0
|
77 |
#define G_PARAM_SPEC_GET_CLASS(pspec) (G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
/* --- convenience macros --- */
|
|
sl@0
|
81 |
/**
|
|
sl@0
|
82 |
* G_PARAM_SPEC_TYPE:
|
|
sl@0
|
83 |
* @pspec: a valid #GParamSpec
|
|
sl@0
|
84 |
*
|
|
sl@0
|
85 |
* Retrieves the #GType of this @pspec.
|
|
sl@0
|
86 |
*/
|
|
sl@0
|
87 |
#define G_PARAM_SPEC_TYPE(pspec) (G_TYPE_FROM_INSTANCE (pspec))
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
* G_PARAM_SPEC_TYPE_NAME:
|
|
sl@0
|
90 |
* @pspec: a valid #GParamSpec
|
|
sl@0
|
91 |
*
|
|
sl@0
|
92 |
* Retrieves the #GType name of this @pspec.
|
|
sl@0
|
93 |
*/
|
|
sl@0
|
94 |
#define G_PARAM_SPEC_TYPE_NAME(pspec) (g_type_name (G_PARAM_SPEC_TYPE (pspec)))
|
|
sl@0
|
95 |
/**
|
|
sl@0
|
96 |
* G_PARAM_SPEC_VALUE_TYPE:
|
|
sl@0
|
97 |
* @pspec: a valid #GParamSpec
|
|
sl@0
|
98 |
*
|
|
sl@0
|
99 |
* Retrieves the #GType to initialize a #GValue for this parameter.
|
|
sl@0
|
100 |
*/
|
|
sl@0
|
101 |
#define G_PARAM_SPEC_VALUE_TYPE(pspec) (G_PARAM_SPEC (pspec)->value_type)
|
|
sl@0
|
102 |
/**
|
|
sl@0
|
103 |
* G_VALUE_HOLDS_PARAM:
|
|
sl@0
|
104 |
* @value: a valid #GValue structure
|
|
sl@0
|
105 |
*
|
|
sl@0
|
106 |
* Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM.
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* Returns: %TRUE on success.
|
|
sl@0
|
109 |
*/
|
|
sl@0
|
110 |
#define G_VALUE_HOLDS_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
/* --- flags --- */
|
|
sl@0
|
114 |
/**
|
|
sl@0
|
115 |
* GParamFlags:
|
|
sl@0
|
116 |
* @G_PARAM_READABLE: the parameter is readable
|
|
sl@0
|
117 |
* @G_PARAM_WRITABLE: the parameter is writable
|
|
sl@0
|
118 |
* @G_PARAM_CONSTRUCT: the parameter will be set upon object construction
|
|
sl@0
|
119 |
* @G_PARAM_CONSTRUCT_ONLY: the parameter will only be set upon object construction
|
|
sl@0
|
120 |
* @G_PARAM_LAX_VALIDATION: upon parameter conversion (see g_param_value_convert())
|
|
sl@0
|
121 |
* strict validation is not required
|
|
sl@0
|
122 |
* @G_PARAM_STATIC_NAME: the string used as name when constructing the
|
|
sl@0
|
123 |
* parameter is guaranteed to remain valid and
|
|
sl@0
|
124 |
* unmodified for the lifetime of the parameter.
|
|
sl@0
|
125 |
* Since 2.8
|
|
sl@0
|
126 |
* @G_PARAM_STATIC_NICK: the string used as nick when constructing the
|
|
sl@0
|
127 |
* parameter is guaranteed to remain valid and
|
|
sl@0
|
128 |
* unmmodified for the lifetime of the parameter.
|
|
sl@0
|
129 |
* Since 2.8
|
|
sl@0
|
130 |
* @G_PARAM_STATIC_BLURB: the string used as blurb when constructing the
|
|
sl@0
|
131 |
* parameter is guaranteed to remain valid and
|
|
sl@0
|
132 |
* unmodified for the lifetime of the parameter.
|
|
sl@0
|
133 |
* Since 2.8
|
|
sl@0
|
134 |
* @G_PARAM_PRIVATE: internal
|
|
sl@0
|
135 |
*
|
|
sl@0
|
136 |
* Through the #GParamFlags flag values, certain aspects of parameters
|
|
sl@0
|
137 |
* can be configured.
|
|
sl@0
|
138 |
*/
|
|
sl@0
|
139 |
typedef enum
|
|
sl@0
|
140 |
{
|
|
sl@0
|
141 |
G_PARAM_READABLE = 1 << 0,
|
|
sl@0
|
142 |
G_PARAM_WRITABLE = 1 << 1,
|
|
sl@0
|
143 |
G_PARAM_CONSTRUCT = 1 << 2,
|
|
sl@0
|
144 |
G_PARAM_CONSTRUCT_ONLY = 1 << 3,
|
|
sl@0
|
145 |
G_PARAM_LAX_VALIDATION = 1 << 4,
|
|
sl@0
|
146 |
G_PARAM_STATIC_NAME = 1 << 5,
|
|
sl@0
|
147 |
#ifndef G_DISABLE_DEPRECATED
|
|
sl@0
|
148 |
G_PARAM_PRIVATE = G_PARAM_STATIC_NAME,
|
|
sl@0
|
149 |
#endif
|
|
sl@0
|
150 |
G_PARAM_STATIC_NICK = 1 << 6,
|
|
sl@0
|
151 |
G_PARAM_STATIC_BLURB = 1 << 7
|
|
sl@0
|
152 |
} GParamFlags;
|
|
sl@0
|
153 |
/**
|
|
sl@0
|
154 |
* G_PARAM_READWRITE:
|
|
sl@0
|
155 |
*
|
|
sl@0
|
156 |
* #GParamFlags value alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE.
|
|
sl@0
|
157 |
*/
|
|
sl@0
|
158 |
#define G_PARAM_READWRITE (G_PARAM_READABLE | G_PARAM_WRITABLE)
|
|
sl@0
|
159 |
/**
|
|
sl@0
|
160 |
* G_PARAM_STATIC_STRINGS:
|
|
sl@0
|
161 |
*
|
|
sl@0
|
162 |
* #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB.
|
|
sl@0
|
163 |
*
|
|
sl@0
|
164 |
* Since 2.13.0
|
|
sl@0
|
165 |
*/
|
|
sl@0
|
166 |
#define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
|
|
sl@0
|
167 |
/* bits in the range 0xffffff00 are reserved for 3rd party usage */
|
|
sl@0
|
168 |
/**
|
|
sl@0
|
169 |
* G_PARAM_MASK:
|
|
sl@0
|
170 |
*
|
|
sl@0
|
171 |
* Mask containing the bits of #GParamSpec.flags which are reserved for GLib.
|
|
sl@0
|
172 |
*/
|
|
sl@0
|
173 |
#define G_PARAM_MASK (0x000000ff)
|
|
sl@0
|
174 |
/**
|
|
sl@0
|
175 |
* G_PARAM_USER_SHIFT:
|
|
sl@0
|
176 |
*
|
|
sl@0
|
177 |
* Minimum shift count to be used for user defined flags, to be stored in
|
|
sl@0
|
178 |
* #GParamSpec.flags.
|
|
sl@0
|
179 |
*/
|
|
sl@0
|
180 |
#define G_PARAM_USER_SHIFT (8)
|
|
sl@0
|
181 |
|
|
sl@0
|
182 |
|
|
sl@0
|
183 |
/* --- typedefs & structures --- */
|
|
sl@0
|
184 |
typedef struct _GParamSpec GParamSpec;
|
|
sl@0
|
185 |
typedef struct _GParamSpecClass GParamSpecClass;
|
|
sl@0
|
186 |
typedef struct _GParameter GParameter;
|
|
sl@0
|
187 |
typedef struct _GParamSpecPool GParamSpecPool;
|
|
sl@0
|
188 |
/**
|
|
sl@0
|
189 |
* GParamSpec:
|
|
sl@0
|
190 |
* @g_type_instance: private #GTypeInstance portion
|
|
sl@0
|
191 |
* @name: name of this parameter
|
|
sl@0
|
192 |
* @flags: #GParamFlags flags for this parameter
|
|
sl@0
|
193 |
* @value_type: the #GValue type for this parameter
|
|
sl@0
|
194 |
* @owner_type: #GType type that uses (introduces) this paremeter
|
|
sl@0
|
195 |
*
|
|
sl@0
|
196 |
* All other fields of the <structname>GParamSpec</structname> struct are private and
|
|
sl@0
|
197 |
* should not be used directly.
|
|
sl@0
|
198 |
*/
|
|
sl@0
|
199 |
struct _GParamSpec
|
|
sl@0
|
200 |
{
|
|
sl@0
|
201 |
GTypeInstance g_type_instance;
|
|
sl@0
|
202 |
|
|
sl@0
|
203 |
gchar *name;
|
|
sl@0
|
204 |
GParamFlags flags;
|
|
sl@0
|
205 |
GType value_type;
|
|
sl@0
|
206 |
GType owner_type; /* class or interface using this property */
|
|
sl@0
|
207 |
|
|
sl@0
|
208 |
/*< private >*/
|
|
sl@0
|
209 |
gchar *_nick;
|
|
sl@0
|
210 |
gchar *_blurb;
|
|
sl@0
|
211 |
GData *qdata;
|
|
sl@0
|
212 |
guint ref_count;
|
|
sl@0
|
213 |
guint param_id; /* sort-criteria */
|
|
sl@0
|
214 |
};
|
|
sl@0
|
215 |
/**
|
|
sl@0
|
216 |
* GParamSpecClass:
|
|
sl@0
|
217 |
* @g_type_class: the parent class
|
|
sl@0
|
218 |
* @value_type: the #GValue type for this parameter
|
|
sl@0
|
219 |
* @finalize: The instance finalization function (optional), should chain
|
|
sl@0
|
220 |
* up to the finalize method of the parent class.
|
|
sl@0
|
221 |
* @value_set_default: Resets a @value to the default value for this type
|
|
sl@0
|
222 |
* (recommended, the default is g_value_reset()), see
|
|
sl@0
|
223 |
* g_param_value_set_default().
|
|
sl@0
|
224 |
* @value_validate: Ensures that the contents of @value comply with the
|
|
sl@0
|
225 |
* specifications set out by this type (optional), see
|
|
sl@0
|
226 |
* g_param_value_set_validate().
|
|
sl@0
|
227 |
* @values_cmp: Compares @value1 with @value2 according to this type
|
|
sl@0
|
228 |
* (recommended, the default is memcmp()), see g_param_values_cmp().
|
|
sl@0
|
229 |
*
|
|
sl@0
|
230 |
* The class structure for the <structname>GParamSpec</structname> type.
|
|
sl@0
|
231 |
* Normally, <structname>GParamSpec</structname> classes are filled by
|
|
sl@0
|
232 |
* g_param_type_register_static().
|
|
sl@0
|
233 |
*/
|
|
sl@0
|
234 |
struct _GParamSpecClass
|
|
sl@0
|
235 |
{
|
|
sl@0
|
236 |
GTypeClass g_type_class;
|
|
sl@0
|
237 |
|
|
sl@0
|
238 |
GType value_type;
|
|
sl@0
|
239 |
|
|
sl@0
|
240 |
void (*finalize) (GParamSpec *pspec);
|
|
sl@0
|
241 |
|
|
sl@0
|
242 |
/* GParam methods */
|
|
sl@0
|
243 |
void (*value_set_default) (GParamSpec *pspec,
|
|
sl@0
|
244 |
GValue *value);
|
|
sl@0
|
245 |
gboolean (*value_validate) (GParamSpec *pspec,
|
|
sl@0
|
246 |
GValue *value);
|
|
sl@0
|
247 |
gint (*values_cmp) (GParamSpec *pspec,
|
|
sl@0
|
248 |
const GValue *value1,
|
|
sl@0
|
249 |
const GValue *value2);
|
|
sl@0
|
250 |
/*< private >*/
|
|
sl@0
|
251 |
gpointer dummy[4];
|
|
sl@0
|
252 |
};
|
|
sl@0
|
253 |
/**
|
|
sl@0
|
254 |
* GParameter:
|
|
sl@0
|
255 |
* @name: the parameter name
|
|
sl@0
|
256 |
* @value: the parameter value
|
|
sl@0
|
257 |
*
|
|
sl@0
|
258 |
* The <structname>GParameter</structname> struct is an auxiliary structure used
|
|
sl@0
|
259 |
* to hand parameter name/value pairs to g_object_newv().
|
|
sl@0
|
260 |
*/
|
|
sl@0
|
261 |
struct _GParameter /* auxillary structure for _setv() variants */
|
|
sl@0
|
262 |
{
|
|
sl@0
|
263 |
const gchar *name;
|
|
sl@0
|
264 |
GValue value;
|
|
sl@0
|
265 |
};
|
|
sl@0
|
266 |
|
|
sl@0
|
267 |
|
|
sl@0
|
268 |
/* --- prototypes --- */
|
|
sl@0
|
269 |
IMPORT_C GParamSpec* g_param_spec_ref (GParamSpec *pspec);
|
|
sl@0
|
270 |
IMPORT_C void g_param_spec_unref (GParamSpec *pspec);
|
|
sl@0
|
271 |
IMPORT_C void g_param_spec_sink (GParamSpec *pspec);
|
|
sl@0
|
272 |
IMPORT_C GParamSpec* g_param_spec_ref_sink (GParamSpec *pspec);
|
|
sl@0
|
273 |
IMPORT_C gpointer g_param_spec_get_qdata (GParamSpec *pspec,
|
|
sl@0
|
274 |
GQuark quark);
|
|
sl@0
|
275 |
IMPORT_C void g_param_spec_set_qdata (GParamSpec *pspec,
|
|
sl@0
|
276 |
GQuark quark,
|
|
sl@0
|
277 |
gpointer data);
|
|
sl@0
|
278 |
IMPORT_C void g_param_spec_set_qdata_full (GParamSpec *pspec,
|
|
sl@0
|
279 |
GQuark quark,
|
|
sl@0
|
280 |
gpointer data,
|
|
sl@0
|
281 |
GDestroyNotify destroy);
|
|
sl@0
|
282 |
IMPORT_C gpointer g_param_spec_steal_qdata (GParamSpec *pspec,
|
|
sl@0
|
283 |
GQuark quark);
|
|
sl@0
|
284 |
IMPORT_C GParamSpec* g_param_spec_get_redirect_target (GParamSpec *pspec);
|
|
sl@0
|
285 |
|
|
sl@0
|
286 |
IMPORT_C void g_param_value_set_default (GParamSpec *pspec,
|
|
sl@0
|
287 |
GValue *value);
|
|
sl@0
|
288 |
IMPORT_C gboolean g_param_value_defaults (GParamSpec *pspec,
|
|
sl@0
|
289 |
GValue *value);
|
|
sl@0
|
290 |
IMPORT_C gboolean g_param_value_validate (GParamSpec *pspec,
|
|
sl@0
|
291 |
GValue *value);
|
|
sl@0
|
292 |
IMPORT_C gboolean g_param_value_convert (GParamSpec *pspec,
|
|
sl@0
|
293 |
const GValue *src_value,
|
|
sl@0
|
294 |
GValue *dest_value,
|
|
sl@0
|
295 |
gboolean strict_validation);
|
|
sl@0
|
296 |
IMPORT_C gint g_param_values_cmp (GParamSpec *pspec,
|
|
sl@0
|
297 |
const GValue *value1,
|
|
sl@0
|
298 |
const GValue *value2);
|
|
sl@0
|
299 |
IMPORT_C G_CONST_RETURN gchar* g_param_spec_get_name (GParamSpec *pspec);
|
|
sl@0
|
300 |
IMPORT_C G_CONST_RETURN gchar* g_param_spec_get_nick (GParamSpec *pspec);
|
|
sl@0
|
301 |
IMPORT_C G_CONST_RETURN gchar* g_param_spec_get_blurb (GParamSpec *pspec);
|
|
sl@0
|
302 |
IMPORT_C void g_value_set_param (GValue *value,
|
|
sl@0
|
303 |
GParamSpec *param);
|
|
sl@0
|
304 |
IMPORT_C GParamSpec* g_value_get_param (const GValue *value);
|
|
sl@0
|
305 |
IMPORT_C GParamSpec* g_value_dup_param (const GValue *value);
|
|
sl@0
|
306 |
|
|
sl@0
|
307 |
|
|
sl@0
|
308 |
IMPORT_C void g_value_take_param (GValue *value,
|
|
sl@0
|
309 |
GParamSpec *param);
|
|
sl@0
|
310 |
#ifndef G_DISABLE_DEPRECATED
|
|
sl@0
|
311 |
IMPORT_C void g_value_set_param_take_ownership (GValue *value,
|
|
sl@0
|
312 |
GParamSpec *param);
|
|
sl@0
|
313 |
#endif
|
|
sl@0
|
314 |
|
|
sl@0
|
315 |
/* --- convenience functions --- */
|
|
sl@0
|
316 |
typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo;
|
|
sl@0
|
317 |
/**
|
|
sl@0
|
318 |
* GParamSpecTypeInfo:
|
|
sl@0
|
319 |
* @instance_size: Size of the instance (object) structure.
|
|
sl@0
|
320 |
* @n_preallocs: Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the <link linkend="glib-Memory-Slices">slice allocator</link> now.
|
|
sl@0
|
321 |
* @instance_init: Location of the instance initialization function (optional).
|
|
sl@0
|
322 |
* @value_type: The #GType of values conforming to this #GParamSpec
|
|
sl@0
|
323 |
* @finalize: The instance finalization function (optional).
|
|
sl@0
|
324 |
* @value_set_default: Resets a @value to the default value for @pspec
|
|
sl@0
|
325 |
* (recommended, the default is g_value_reset()), see
|
|
sl@0
|
326 |
* g_param_value_set_default().
|
|
sl@0
|
327 |
* @value_validate: Ensures that the contents of @value comply with the
|
|
sl@0
|
328 |
* specifications set out by @pspec (optional), see
|
|
sl@0
|
329 |
* g_param_value_set_validate().
|
|
sl@0
|
330 |
* @values_cmp: Compares @value1 with @value2 according to @pspec
|
|
sl@0
|
331 |
* (recommended, the default is memcmp()), see g_param_values_cmp().
|
|
sl@0
|
332 |
*
|
|
sl@0
|
333 |
* This structure is used to provide the type system with the information
|
|
sl@0
|
334 |
* required to initialize and destruct (finalize) a parameter's class and
|
|
sl@0
|
335 |
* instances thereof.
|
|
sl@0
|
336 |
* The initialized structure is passed to the g_param_type_register_static()
|
|
sl@0
|
337 |
* The type system will perform a deep copy of this structure, so its memory
|
|
sl@0
|
338 |
* does not need to be persistent across invocation of
|
|
sl@0
|
339 |
* g_param_type_register_static().
|
|
sl@0
|
340 |
*/
|
|
sl@0
|
341 |
struct _GParamSpecTypeInfo
|
|
sl@0
|
342 |
{
|
|
sl@0
|
343 |
/* type system portion */
|
|
sl@0
|
344 |
guint16 instance_size; /* obligatory */
|
|
sl@0
|
345 |
guint16 n_preallocs; /* optional */
|
|
sl@0
|
346 |
void (*instance_init) (GParamSpec *pspec); /* optional */
|
|
sl@0
|
347 |
|
|
sl@0
|
348 |
/* class portion */
|
|
sl@0
|
349 |
GType value_type; /* obligatory */
|
|
sl@0
|
350 |
void (*finalize) (GParamSpec *pspec); /* optional */
|
|
sl@0
|
351 |
void (*value_set_default) (GParamSpec *pspec, /* recommended */
|
|
sl@0
|
352 |
GValue *value);
|
|
sl@0
|
353 |
gboolean (*value_validate) (GParamSpec *pspec, /* optional */
|
|
sl@0
|
354 |
GValue *value);
|
|
sl@0
|
355 |
gint (*values_cmp) (GParamSpec *pspec, /* recommended */
|
|
sl@0
|
356 |
const GValue *value1,
|
|
sl@0
|
357 |
const GValue *value2);
|
|
sl@0
|
358 |
};
|
|
sl@0
|
359 |
IMPORT_C GType g_param_type_register_static (const gchar *name,
|
|
sl@0
|
360 |
const GParamSpecTypeInfo *pspec_info);
|
|
sl@0
|
361 |
|
|
sl@0
|
362 |
/* For registering builting types */
|
|
sl@0
|
363 |
GType _g_param_type_register_static_constant (const gchar *name,
|
|
sl@0
|
364 |
const GParamSpecTypeInfo *pspec_info,
|
|
sl@0
|
365 |
GType opt_type);
|
|
sl@0
|
366 |
|
|
sl@0
|
367 |
|
|
sl@0
|
368 |
/* --- protected --- */
|
|
sl@0
|
369 |
IMPORT_C gpointer g_param_spec_internal (GType param_type,
|
|
sl@0
|
370 |
const gchar *name,
|
|
sl@0
|
371 |
const gchar *nick,
|
|
sl@0
|
372 |
const gchar *blurb,
|
|
sl@0
|
373 |
GParamFlags flags);
|
|
sl@0
|
374 |
IMPORT_C GParamSpecPool* g_param_spec_pool_new (gboolean type_prefixing);
|
|
sl@0
|
375 |
IMPORT_C void g_param_spec_pool_insert (GParamSpecPool *pool,
|
|
sl@0
|
376 |
GParamSpec *pspec,
|
|
sl@0
|
377 |
GType owner_type);
|
|
sl@0
|
378 |
IMPORT_C void g_param_spec_pool_remove (GParamSpecPool *pool,
|
|
sl@0
|
379 |
GParamSpec *pspec);
|
|
sl@0
|
380 |
IMPORT_C GParamSpec* g_param_spec_pool_lookup (GParamSpecPool *pool,
|
|
sl@0
|
381 |
const gchar *param_name,
|
|
sl@0
|
382 |
GType owner_type,
|
|
sl@0
|
383 |
gboolean walk_ancestors);
|
|
sl@0
|
384 |
IMPORT_C GList* g_param_spec_pool_list_owned (GParamSpecPool *pool,
|
|
sl@0
|
385 |
GType owner_type);
|
|
sl@0
|
386 |
IMPORT_C GParamSpec** g_param_spec_pool_list (GParamSpecPool *pool,
|
|
sl@0
|
387 |
GType owner_type,
|
|
sl@0
|
388 |
guint *n_pspecs_p);
|
|
sl@0
|
389 |
|
|
sl@0
|
390 |
|
|
sl@0
|
391 |
|
|
sl@0
|
392 |
/* contracts:
|
|
sl@0
|
393 |
*
|
|
sl@0
|
394 |
* gboolean value_validate (GParamSpec *pspec,
|
|
sl@0
|
395 |
* GValue *value):
|
|
sl@0
|
396 |
* modify value contents in the least destructive way, so
|
|
sl@0
|
397 |
* that it complies with pspec's requirements (i.e.
|
|
sl@0
|
398 |
* according to minimum/maximum ranges etc...). return
|
|
sl@0
|
399 |
* whether modification was necessary.
|
|
sl@0
|
400 |
*
|
|
sl@0
|
401 |
* gint values_cmp (GParamSpec *pspec,
|
|
sl@0
|
402 |
* const GValue *value1,
|
|
sl@0
|
403 |
* const GValue *value2):
|
|
sl@0
|
404 |
* return value1 - value2, i.e. (-1) if value1 < value2,
|
|
sl@0
|
405 |
* (+1) if value1 > value2, and (0) otherwise (equality)
|
|
sl@0
|
406 |
*/
|
|
sl@0
|
407 |
|
|
sl@0
|
408 |
G_END_DECLS
|
|
sl@0
|
409 |
|
|
sl@0
|
410 |
#endif /* __G_PARAM_H__ */
|