gobject/gparamspecs.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  *
  19  * gparamspecs.h: GLib default param specs
  20  */
  21 #ifndef __G_PARAMSPECS_H__
  22 #define __G_PARAMSPECS_H__
  23
  24
  25 #include        <gobject/gvalue.h>
  26 #include        <gobject/genums.h>
  27 #include        <gobject/gboxed.h>
  28 #include        <gobject/gobject.h>
  29
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35
  36 /* --- type macros --- */
  37 #define G_IS_PARAM_SPEC_CHAR(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CHAR))
  38 #define G_PARAM_SPEC_CHAR(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CHAR, GParamSpecChar))
  39 #define G_IS_PARAM_SPEC_UCHAR(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UCHAR))
  40 #define G_PARAM_SPEC_UCHAR(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UCHAR, GParamSpecUChar))
  41 #define G_IS_PARAM_SPEC_BOOLEAN(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOOLEAN))
  42 #define G_PARAM_SPEC_BOOLEAN(pspec)        (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOOLEAN, GParamSpecBoolean))
  43 #define G_IS_PARAM_SPEC_INT(pspec)         (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_INT))
  44 #define G_PARAM_SPEC_INT(pspec)            (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT, GParamSpecInt))
  45 #define G_IS_PARAM_SPEC_UINT(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UINT))
  46 #define G_PARAM_SPEC_UINT(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT, GParamSpecUInt))
  47 #define G_IS_PARAM_SPEC_LONG(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_LONG))
  48 #define G_PARAM_SPEC_LONG(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_LONG, GParamSpecLong))
  49 #define G_IS_PARAM_SPEC_ULONG(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ULONG))
  50 #define G_PARAM_SPEC_ULONG(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ULONG, GParamSpecULong))
  51 #define G_IS_PARAM_SPEC_ENUM(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ENUM))
  52 #define G_PARAM_SPEC_ENUM(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ENUM, GParamSpecEnum))
  53 #define G_IS_PARAM_SPEC_FLAGS(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLAGS))
  54 #define G_PARAM_SPEC_FLAGS(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLAGS, GParamSpecFlags))
  55 #define G_IS_PARAM_SPEC_FLOAT(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLOAT))
  56 #define G_PARAM_SPEC_FLOAT(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLOAT, GParamSpecFloat))
  57 #define G_IS_PARAM_SPEC_DOUBLE(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_DOUBLE))
  58 #define G_PARAM_SPEC_DOUBLE(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_DOUBLE, GParamSpecDouble))
  59 #define G_IS_PARAM_SPEC_STRING(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_STRING))
  60 #define G_PARAM_SPEC_STRING(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_STRING, GParamSpecString))
  61 #define G_IS_PARAM_SPEC_PARAM(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_PARAM))
  62 #define G_PARAM_SPEC_PARAM(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_PARAM, GParamSpecParam))
  63 #define G_IS_PARAM_SPEC_BOXED(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOXED))
  64 #define G_PARAM_SPEC_BOXED(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOXED, GParamSpecBoxed))
  65 #define G_IS_PARAM_SPEC_POINTER(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_POINTER))
  66 #define G_PARAM_SPEC_POINTER(pspec)        (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_POINTER, GParamSpecPointer))
  67 #define G_IS_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_VALUE_ARRAY))
  68 #define G_PARAM_SPEC_VALUE_ARRAY(pspec)    (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_VALUE_ARRAY, GParamSpecValueArray))
  69 #define G_IS_PARAM_SPEC_CLOSURE(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CLOSURE))
  70 #define G_PARAM_SPEC_CLOSURE(pspec)        (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CLOSURE, GParamSpecClosure))
  71 #define G_IS_PARAM_SPEC_OBJECT(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_OBJECT))
  72 #define G_PARAM_SPEC_OBJECT(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OBJECT, GParamSpecObject))
  73
  74
  75 /* --- typedefs & structures --- */
  76 typedef struct _GParamSpecChar       GParamSpecChar;
  77 typedef struct _GParamSpecUChar      GParamSpecUChar;
  78 typedef struct _GParamSpecBoolean    GParamSpecBoolean;
  79 typedef struct _GParamSpecInt        GParamSpecInt;
  80 typedef struct _GParamSpecUInt       GParamSpecUInt;
  81 typedef struct _GParamSpecLong       GParamSpecLong;
  82 typedef struct _GParamSpecULong      GParamSpecULong;
  83 typedef struct _GParamSpecEnum       GParamSpecEnum;
  84 typedef struct _GParamSpecFlags      GParamSpecFlags;
  85 typedef struct _GParamSpecFloat      GParamSpecFloat;
  86 typedef struct _GParamSpecDouble     GParamSpecDouble;
  87 typedef struct _GParamSpecString     GParamSpecString;
  88 typedef struct _GParamSpecParam      GParamSpecParam;
  89 typedef struct _GParamSpecBoxed      GParamSpecBoxed;
  90 typedef struct _GParamSpecPointer    GParamSpecPointer;
  91 typedef struct _GParamSpecValueArray GParamSpecValueArray;
  92 typedef struct _GParamSpecClosure    GParamSpecClosure;
  93 typedef struct _GParamSpecObject     GParamSpecObject;
  94 struct _GParamSpecChar
  95 {
  96   GParamSpec    parent_instance;
  97
  98   gint8         minimum;
  99   gint8         maximum;
 100   gint8         default_value;
 101 };
 102 struct _GParamSpecUChar
 103 {
 104   GParamSpec    parent_instance;
 105
 106   guint8        minimum;
 107   guint8        maximum;
 108   guint8        default_value;
 109 };
 110 struct _GParamSpecBoolean
 111 {
 112   GParamSpec    parent_instance;
 113
 114   gboolean      default_value;
 115 };
 116 struct _GParamSpecInt
 117 {
 118   GParamSpec    parent_instance;
 119
 120   gint          minimum;
 121   gint          maximum;
 122   gint          default_value;
 123 };
 124 struct _GParamSpecUInt
 125 {
 126   GParamSpec    parent_instance;
 127
 128   guint         minimum;
 129   guint         maximum;
 130   guint         default_value;
 131 };
 132 struct _GParamSpecLong
 133 {
 134   GParamSpec    parent_instance;
 135
 136   glong         minimum;
 137   glong         maximum;
 138   glong         default_value;
 139 };
 140 struct _GParamSpecULong
 141 {
 142   GParamSpec    parent_instance;
 143
 144   gulong        minimum;
 145   gulong        maximum;
 146   gulong        default_value;
 147 };
 148 struct _GParamSpecEnum
 149 {
 150   GParamSpec    parent_instance;
 151
 152   GEnumClass   *enum_class;
 153   glong         default_value;
 154 };
 155 struct _GParamSpecFlags
 156 {
 157   GParamSpec    parent_instance;
 158
 159   GFlagsClass  *flags_class;
 160   gulong        default_value;
 161 };
 162 struct _GParamSpecFloat
 163 {
 164   GParamSpec    parent_instance;
 165
 166   gfloat        minimum;
 167   gfloat        maximum;
 168   gfloat        default_value;
 169   gfloat        epsilon;
 170 };
 171 struct _GParamSpecDouble
 172 {
 173   GParamSpec    parent_instance;
 174
 175   gdouble       minimum;
 176   gdouble       maximum;
 177   gdouble       default_value;
 178   gdouble       epsilon;
 179 };
 180 struct _GParamSpecString
 181 {
 182   GParamSpec    parent_instance;
 183
 184   gchar        *default_value;
 185   gchar        *cset_first;
 186   gchar        *cset_nth;
 187   gchar         substitutor;
 188   guint         null_fold_if_empty : 1;
 189   guint         ensure_non_null : 1;
 190 };
 191 struct _GParamSpecParam
 192 {
 193   GParamSpec    parent_instance;
 194 };
 195 struct _GParamSpecBoxed
 196 {
 197   GParamSpec    parent_instance;
 198 };
 199 struct _GParamSpecPointer
 200 {
 201   GParamSpec    parent_instance;
 202 };
 203 struct _GParamSpecValueArray
 204 {
 205   GParamSpec    parent_instance;
 206   GParamSpec   *element_spec;
 207   guint         fixed_n_elements;
 208 };
 209 struct _GParamSpecClosure
 210 {
 211   GParamSpec    parent_instance;
 212 };
 213 struct _GParamSpecObject
 214 {
 215   GParamSpec    parent_instance;
 216 };
 217
 218
 219 /* --- GParamSpec prototypes --- */
 220 GParamSpec*     g_param_spec_char        (const gchar    *name,
 221                                           const gchar    *nick,
 222                                           const gchar    *blurb,
 223                                           gint8           minimum,
 224                                           gint8           maximum,
 225                                           gint8           default_value,
 226                                           GParamFlags     flags);
 227 GParamSpec*     g_param_spec_uchar       (const gchar    *name,
 228                                           const gchar    *nick,
 229                                           const gchar    *blurb,
 230                                           guint8          minimum,
 231                                           guint8          maximum,
 232                                           guint8          default_value,
 233                                           GParamFlags     flags);
 234 GParamSpec*     g_param_spec_boolean     (const gchar    *name,
 235                                           const gchar    *nick,
 236                                           const gchar    *blurb,
 237                                           gboolean        default_value,
 238                                           GParamFlags     flags);
 239 GParamSpec*     g_param_spec_int         (const gchar    *name,
 240                                           const gchar    *nick,
 241                                           const gchar    *blurb,
 242                                           gint            minimum,
 243                                           gint            maximum,
 244                                           gint            default_value,
 245                                           GParamFlags     flags);
 246 GParamSpec*     g_param_spec_uint        (const gchar    *name,
 247                                           const gchar    *nick,
 248                                           const gchar    *blurb,
 249                                           guint           minimum,
 250                                           guint           maximum,
 251                                           guint           default_value,
 252                                           GParamFlags     flags);
 253 GParamSpec*     g_param_spec_long        (const gchar    *name,
 254                                           const gchar    *nick,
 255                                           const gchar    *blurb,
 256                                           glong           minimum,
 257                                           glong           maximum,
 258                                           glong           default_value,
 259                                           GParamFlags     flags);
 260 GParamSpec*     g_param_spec_ulong       (const gchar    *name,
 261                                           const gchar    *nick,
 262                                           const gchar    *blurb,
 263                                           gulong          minimum,
 264                                           gulong          maximum,
 265                                           gulong          default_value,
 266                                           GParamFlags     flags);
 267 GParamSpec*     g_param_spec_enum        (const gchar    *name,
 268                                           const gchar    *nick,
 269                                           const gchar    *blurb,
 270                                           GType           enum_type,
 271                                           gint            default_value,
 272                                           GParamFlags     flags);
 273 GParamSpec*     g_param_spec_flags       (const gchar    *name,
 274                                           const gchar    *nick,
 275                                           const gchar    *blurb,
 276                                           GType           flags_type,
 277                                           guint           default_value,
 278                                           GParamFlags     flags);
 279 GParamSpec*     g_param_spec_float       (const gchar    *name,
 280                                           const gchar    *nick,
 281                                           const gchar    *blurb,
 282                                           gfloat          minimum,
 283                                           gfloat          maximum,
 284                                           gfloat          default_value,
 285                                           GParamFlags     flags);
 286 GParamSpec*     g_param_spec_double      (const gchar    *name,
 287                                           const gchar    *nick,
 288                                           const gchar    *blurb,
 289                                           gdouble         minimum,
 290                                           gdouble         maximum,
 291                                           gdouble         default_value,
 292                                           GParamFlags     flags);
 293 GParamSpec*     g_param_spec_string      (const gchar    *name,
 294                                           const gchar    *nick,
 295                                           const gchar    *blurb,
 296                                           const gchar    *default_value,
 297                                           GParamFlags     flags);
 298 GParamSpec*     g_param_spec_string_c    (const gchar    *name,
 299                                           const gchar    *nick,
 300                                           const gchar    *blurb,
 301                                           const gchar    *default_value,
 302                                           GParamFlags     flags);
 303 GParamSpec*     g_param_spec_param       (const gchar    *name,
 304                                           const gchar    *nick,
 305                                           const gchar    *blurb,
 306                                           GType           param_type,
 307                                           GParamFlags     flags);
 308 GParamSpec*     g_param_spec_boxed       (const gchar    *name,
 309                                           const gchar    *nick,
 310                                           const gchar    *blurb,
 311                                           GType           boxed_type,
 312                                           GParamFlags     flags);
 313 GParamSpec*     g_param_spec_pointer     (const gchar    *name,
 314                                           const gchar    *nick,
 315                                           const gchar    *blurb,
 316                                           GParamFlags     flags);
 317 GParamSpec*     g_param_spec_value_array (const gchar    *name,
 318                                           const gchar    *nick,
 319                                           const gchar    *blurb,
 320                                           GParamSpec     *element_spec,
 321                                           GParamFlags     flags);
 322 GParamSpec*     g_param_spec_closure     (const gchar    *name,
 323                                           const gchar    *nick,
 324                                           const gchar    *blurb,
 325                                           GParamFlags     flags);
 326 GParamSpec*     g_param_spec_object      (const gchar    *name,
 327                                           const gchar    *nick,
 328                                           const gchar    *blurb,
 329                                           GType           object_type,
 330                                           GParamFlags     flags);
 331
 332
 333 #ifdef __cplusplus
 334 }
 335 #endif /* __cplusplus */
 336
 337 #endif /* __G_PARAMSPECS_H__ */