1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * gparamspecs.h: GLib default param specs
21 #ifndef __G_PARAMSPECS_H__
22 #define __G_PARAMSPECS_H__
25 #include <gobject/gvalue.h>
26 #include <gobject/genums.h>
27 #include <gobject/gboxed.h>
28 #include <gobject/gobject.h>
32 /* --- type macros --- */
33 #define G_IS_PARAM_SPEC_CHAR(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CHAR))
34 #define G_PARAM_SPEC_CHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CHAR, GParamSpecChar))
35 #define G_IS_PARAM_SPEC_UCHAR(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UCHAR))
36 #define G_PARAM_SPEC_UCHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UCHAR, GParamSpecUChar))
37 #define G_IS_PARAM_SPEC_BOOLEAN(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOOLEAN))
38 #define G_PARAM_SPEC_BOOLEAN(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOOLEAN, GParamSpecBoolean))
39 #define G_IS_PARAM_SPEC_INT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_INT))
40 #define G_PARAM_SPEC_INT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT, GParamSpecInt))
41 #define G_IS_PARAM_SPEC_UINT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UINT))
42 #define G_PARAM_SPEC_UINT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT, GParamSpecUInt))
43 #define G_IS_PARAM_SPEC_LONG(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_LONG))
44 #define G_PARAM_SPEC_LONG(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_LONG, GParamSpecLong))
45 #define G_IS_PARAM_SPEC_ULONG(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ULONG))
46 #define G_PARAM_SPEC_ULONG(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ULONG, GParamSpecULong))
47 #define G_IS_PARAM_SPEC_ENUM(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ENUM))
48 #define G_PARAM_SPEC_ENUM(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ENUM, GParamSpecEnum))
49 #define G_IS_PARAM_SPEC_FLAGS(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLAGS))
50 #define G_PARAM_SPEC_FLAGS(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLAGS, GParamSpecFlags))
51 #define G_IS_PARAM_SPEC_FLOAT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLOAT))
52 #define G_PARAM_SPEC_FLOAT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLOAT, GParamSpecFloat))
53 #define G_IS_PARAM_SPEC_DOUBLE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_DOUBLE))
54 #define G_PARAM_SPEC_DOUBLE(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_DOUBLE, GParamSpecDouble))
55 #define G_IS_PARAM_SPEC_STRING(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_STRING))
56 #define G_PARAM_SPEC_STRING(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_STRING, GParamSpecString))
57 #define G_IS_PARAM_SPEC_PARAM(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_PARAM))
58 #define G_PARAM_SPEC_PARAM(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_PARAM, GParamSpecParam))
59 #define G_IS_PARAM_SPEC_BOXED(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOXED))
60 #define G_PARAM_SPEC_BOXED(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOXED, GParamSpecBoxed))
61 #define G_IS_PARAM_SPEC_POINTER(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_POINTER))
62 #define G_PARAM_SPEC_POINTER(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_POINTER, GParamSpecPointer))
63 #define G_IS_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_VALUE_ARRAY))
64 #define G_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_VALUE_ARRAY, GParamSpecValueArray))
65 #define G_IS_PARAM_SPEC_CLOSURE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CLOSURE))
66 #define G_PARAM_SPEC_CLOSURE(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CLOSURE, GParamSpecClosure))
67 #define G_IS_PARAM_SPEC_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_OBJECT))
68 #define G_PARAM_SPEC_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OBJECT, GParamSpecObject))
71 /* --- typedefs & structures --- */
72 typedef struct _GParamSpecChar GParamSpecChar;
73 typedef struct _GParamSpecUChar GParamSpecUChar;
74 typedef struct _GParamSpecBoolean GParamSpecBoolean;
75 typedef struct _GParamSpecInt GParamSpecInt;
76 typedef struct _GParamSpecUInt GParamSpecUInt;
77 typedef struct _GParamSpecLong GParamSpecLong;
78 typedef struct _GParamSpecULong GParamSpecULong;
79 typedef struct _GParamSpecEnum GParamSpecEnum;
80 typedef struct _GParamSpecFlags GParamSpecFlags;
81 typedef struct _GParamSpecFloat GParamSpecFloat;
82 typedef struct _GParamSpecDouble GParamSpecDouble;
83 typedef struct _GParamSpecString GParamSpecString;
84 typedef struct _GParamSpecParam GParamSpecParam;
85 typedef struct _GParamSpecBoxed GParamSpecBoxed;
86 typedef struct _GParamSpecPointer GParamSpecPointer;
87 typedef struct _GParamSpecValueArray GParamSpecValueArray;
88 typedef struct _GParamSpecClosure GParamSpecClosure;
89 typedef struct _GParamSpecObject GParamSpecObject;
90 struct _GParamSpecChar
92 GParamSpec parent_instance;
98 struct _GParamSpecUChar
100 GParamSpec parent_instance;
104 guint8 default_value;
106 struct _GParamSpecBoolean
108 GParamSpec parent_instance;
110 gboolean default_value;
112 struct _GParamSpecInt
114 GParamSpec parent_instance;
120 struct _GParamSpecUInt
122 GParamSpec parent_instance;
128 struct _GParamSpecLong
130 GParamSpec parent_instance;
136 struct _GParamSpecULong
138 GParamSpec parent_instance;
142 gulong default_value;
144 struct _GParamSpecEnum
146 GParamSpec parent_instance;
148 GEnumClass *enum_class;
151 struct _GParamSpecFlags
153 GParamSpec parent_instance;
155 GFlagsClass *flags_class;
156 gulong default_value;
158 struct _GParamSpecFloat
160 GParamSpec parent_instance;
164 gfloat default_value;
167 struct _GParamSpecDouble
169 GParamSpec parent_instance;
173 gdouble default_value;
176 struct _GParamSpecString
178 GParamSpec parent_instance;
180 gchar *default_value;
184 guint null_fold_if_empty : 1;
185 guint ensure_non_null : 1;
187 struct _GParamSpecParam
189 GParamSpec parent_instance;
191 struct _GParamSpecBoxed
193 GParamSpec parent_instance;
195 struct _GParamSpecPointer
197 GParamSpec parent_instance;
199 struct _GParamSpecValueArray
201 GParamSpec parent_instance;
202 GParamSpec *element_spec;
203 guint fixed_n_elements;
205 struct _GParamSpecClosure
207 GParamSpec parent_instance;
209 struct _GParamSpecObject
211 GParamSpec parent_instance;
215 /* --- GParamSpec prototypes --- */
216 GParamSpec* g_param_spec_char (const gchar *name,
223 GParamSpec* g_param_spec_uchar (const gchar *name,
228 guint8 default_value,
230 GParamSpec* g_param_spec_boolean (const gchar *name,
233 gboolean default_value,
235 GParamSpec* g_param_spec_int (const gchar *name,
242 GParamSpec* g_param_spec_uint (const gchar *name,
249 GParamSpec* g_param_spec_long (const gchar *name,
256 GParamSpec* g_param_spec_ulong (const gchar *name,
261 gulong default_value,
263 GParamSpec* g_param_spec_enum (const gchar *name,
269 GParamSpec* g_param_spec_flags (const gchar *name,
275 GParamSpec* g_param_spec_float (const gchar *name,
280 gfloat default_value,
282 GParamSpec* g_param_spec_double (const gchar *name,
287 gdouble default_value,
289 GParamSpec* g_param_spec_string (const gchar *name,
292 const gchar *default_value,
294 GParamSpec* g_param_spec_stringc (const gchar *name,
297 const gchar *default_value,
299 GParamSpec* g_param_spec_param (const gchar *name,
304 GParamSpec* g_param_spec_boxed (const gchar *name,
309 GParamSpec* g_param_spec_pointer (const gchar *name,
313 GParamSpec* g_param_spec_value_array (const gchar *name,
316 GParamSpec *element_spec,
318 GParamSpec* g_param_spec_closure (const gchar *name,
322 GParamSpec* g_param_spec_object (const gchar *name,
331 #endif /* __G_PARAMSPECS_H__ */