1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1997, 1998, 1999, 2000 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/gobject.h>
32 #endif /* __cplusplus */
35 /* --- type macros --- */
36 #define G_IS_PARAM_SPEC_CHAR(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CHAR))
37 #define G_PARAM_SPEC_CHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CHAR, GParamSpecChar))
38 #define G_IS_PARAM_SPEC_UCHAR(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UCHAR))
39 #define G_PARAM_SPEC_UCHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UCHAR, GParamSpecUChar))
40 #define G_IS_PARAM_SPEC_BOOLEAN(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOOLEAN))
41 #define G_PARAM_SPEC_BOOLEAN(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOOLEAN, GParamSpecBoolean))
42 #define G_IS_PARAM_SPEC_INT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_INT))
43 #define G_PARAM_SPEC_INT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT, GParamSpecInt))
44 #define G_IS_PARAM_SPEC_UINT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UINT))
45 #define G_PARAM_SPEC_UINT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT, GParamSpecUInt))
46 #define G_IS_PARAM_SPEC_LONG(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_LONG))
47 #define G_PARAM_SPEC_LONG(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_LONG, GParamSpecLong))
48 #define G_IS_PARAM_SPEC_ULONG(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ULONG))
49 #define G_PARAM_SPEC_ULONG(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ULONG, GParamSpecULong))
50 #define G_IS_PARAM_SPEC_ENUM(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ENUM))
51 #define G_PARAM_SPEC_ENUM(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ENUM, GParamSpecEnum))
52 #define G_IS_PARAM_SPEC_FLAGS(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLAGS))
53 #define G_PARAM_SPEC_FLAGS(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLAGS, GParamSpecFlags))
54 #define G_IS_PARAM_SPEC_FLOAT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLOAT))
55 #define G_PARAM_SPEC_FLOAT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLOAT, GParamSpecFloat))
56 #define G_IS_PARAM_SPEC_DOUBLE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_DOUBLE))
57 #define G_PARAM_SPEC_DOUBLE(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_DOUBLE, GParamSpecDouble))
58 #define G_IS_PARAM_SPEC_STRING(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_STRING))
59 #define G_PARAM_SPEC_STRING(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_STRING, GParamSpecString))
60 #define G_IS_PARAM_SPEC_PARAM(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_PARAM))
61 #define G_PARAM_SPEC_PARAM(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_PARAM, GParamSpecParam))
62 #define G_IS_PARAM_SPEC_POINTER(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_POINTER))
63 #define G_PARAM_SPEC_POINTER(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_POINTER, GParamSpecPointer))
64 #define G_IS_PARAM_SPEC_CCALLBACK(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CCALLBACK))
65 #define G_PARAM_SPEC_CCALLBACK(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CCALLBACK, GParamSpecCCallback))
66 #define G_IS_PARAM_SPEC_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_OBJECT))
67 #define G_PARAM_SPEC_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OBJECT, GParamSpecObject))
70 /* --- typedefs & structures --- */
71 typedef struct _GParamSpecChar GParamSpecChar;
72 typedef struct _GParamSpecUChar GParamSpecUChar;
73 typedef struct _GParamSpecBoolean GParamSpecBoolean;
74 typedef struct _GParamSpecInt GParamSpecInt;
75 typedef struct _GParamSpecUInt GParamSpecUInt;
76 typedef struct _GParamSpecLong GParamSpecLong;
77 typedef struct _GParamSpecULong GParamSpecULong;
78 typedef struct _GParamSpecEnum GParamSpecEnum;
79 typedef struct _GParamSpecFlags GParamSpecFlags;
80 typedef struct _GParamSpecFloat GParamSpecFloat;
81 typedef struct _GParamSpecDouble GParamSpecDouble;
82 typedef struct _GParamSpecString GParamSpecString;
83 typedef struct _GParamSpecParam GParamSpecParam;
84 typedef struct _GParamSpecPointer GParamSpecPointer;
85 typedef struct _GParamSpecCCallback GParamSpecCCallback;
86 typedef struct _GParamSpecObject GParamSpecObject;
87 struct _GParamSpecChar
89 GParamSpec parent_instance;
95 struct _GParamSpecUChar
97 GParamSpec parent_instance;
101 guint8 default_value;
103 struct _GParamSpecBoolean
105 GParamSpec parent_instance;
107 gboolean default_value;
109 struct _GParamSpecInt
111 GParamSpec parent_instance;
117 struct _GParamSpecUInt
119 GParamSpec parent_instance;
125 struct _GParamSpecLong
127 GParamSpec parent_instance;
133 struct _GParamSpecULong
135 GParamSpec parent_instance;
139 gulong default_value;
141 struct _GParamSpecEnum
143 GParamSpec parent_instance;
145 GEnumClass *enum_class;
148 struct _GParamSpecFlags
150 GParamSpec parent_instance;
152 GFlagsClass *flags_class;
153 gulong default_value;
155 struct _GParamSpecFloat
157 GParamSpec parent_instance;
161 gfloat default_value;
164 struct _GParamSpecDouble
166 GParamSpec parent_instance;
170 gdouble default_value;
173 struct _GParamSpecString
175 GParamSpec parent_instance;
177 gchar *default_value;
181 guint null_fold_if_empty : 1;
182 guint ensure_non_null : 1;
184 struct _GParamSpecParam
186 GParamSpec parent_instance;
190 struct _GParamSpecPointer
192 GParamSpec parent_instance;
194 struct _GParamSpecCCallback
196 GParamSpec parent_instance;
198 struct _GParamSpecObject
200 GParamSpec parent_instance;
206 /* --- GParamSpec prototypes --- */
207 GParamSpec* g_param_spec_char (const gchar *name,
214 GParamSpec* g_param_spec_uchar (const gchar *name,
219 guint8 default_value,
221 GParamSpec* g_param_spec_boolean (const gchar *name,
224 gboolean default_value,
226 GParamSpec* g_param_spec_int (const gchar *name,
233 GParamSpec* g_param_spec_uint (const gchar *name,
240 GParamSpec* g_param_spec_long (const gchar *name,
247 GParamSpec* g_param_spec_ulong (const gchar *name,
252 gulong default_value,
254 GParamSpec* g_param_spec_enum (const gchar *name,
260 GParamSpec* g_param_spec_flags (const gchar *name,
266 GParamSpec* g_param_spec_float (const gchar *name,
271 gfloat default_value,
273 GParamSpec* g_param_spec_double (const gchar *name,
278 gdouble default_value,
280 GParamSpec* g_param_spec_string (const gchar *name,
283 const gchar *default_value,
285 GParamSpec* g_param_spec_string_c (const gchar *name,
288 const gchar *default_value,
290 GParamSpec* g_param_spec_param (const gchar *name,
295 GParamSpec* g_param_spec_pointer (const gchar *name,
299 GParamSpec* g_param_spec_ccallback (const gchar *name,
303 GParamSpec* g_param_spec_object (const gchar *name,
312 #endif /* __cplusplus */
314 #endif /* __G_PARAMSPECS_H__ */