Parameters and Values

Parameters and Values — Standard Parameter and Value Types

Synopsis

#include <glib-object.h>

#define             G_IS_PARAM_SPEC_BOOLEAN             (pspec)
#define             G_PARAM_SPEC_BOOLEAN                (pspec)
#define             G_VALUE_HOLDS_BOOLEAN               (value)
#define             G_TYPE_PARAM_BOOLEAN
struct              GParamSpecBoolean;
GParamSpec *        g_param_spec_boolean                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gboolean default_value,
                                                         GParamFlags flags);
void                g_value_set_boolean                 (GValue *value,
                                                         gboolean v_boolean);
gboolean            g_value_get_boolean                 (const GValue *value);

#define             G_IS_PARAM_SPEC_CHAR                (pspec)
#define             G_PARAM_SPEC_CHAR                   (pspec)
#define             G_VALUE_HOLDS_CHAR                  (value)
#define             G_TYPE_PARAM_CHAR
struct              GParamSpecChar;
GParamSpec *        g_param_spec_char                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint8 minimum,
                                                         gint8 maximum,
                                                         gint8 default_value,
                                                         GParamFlags flags);
void                g_value_set_char                    (GValue *value,
                                                         gchar v_char);
gchar               g_value_get_char                    (const GValue *value);

#define             G_IS_PARAM_SPEC_UCHAR               (pspec)
#define             G_PARAM_SPEC_UCHAR                  (pspec)
#define             G_VALUE_HOLDS_UCHAR                 (value)
#define             G_TYPE_PARAM_UCHAR
struct              GParamSpecUChar;
GParamSpec *        g_param_spec_uchar                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint8 minimum,
                                                         guint8 maximum,
                                                         guint8 default_value,
                                                         GParamFlags flags);
void                g_value_set_uchar                   (GValue *value,
                                                         guchar v_uchar);
guchar              g_value_get_uchar                   (const GValue *value);

#define             G_IS_PARAM_SPEC_INT                 (pspec)
#define             G_PARAM_SPEC_INT                    (pspec)
#define             G_VALUE_HOLDS_INT                   (value)
#define             G_TYPE_PARAM_INT
struct              GParamSpecInt;
GParamSpec *        g_param_spec_int                    (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint minimum,
                                                         gint maximum,
                                                         gint default_value,
                                                         GParamFlags flags);
void                g_value_set_int                     (GValue *value,
                                                         gint v_int);
gint                g_value_get_int                     (const GValue *value);

#define             G_IS_PARAM_SPEC_UINT                (pspec)
#define             G_PARAM_SPEC_UINT                   (pspec)
#define             G_VALUE_HOLDS_UINT                  (value)
#define             G_TYPE_PARAM_UINT
struct              GParamSpecUInt;
GParamSpec *        g_param_spec_uint                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint minimum,
                                                         guint maximum,
                                                         guint default_value,
                                                         GParamFlags flags);
void                g_value_set_uint                    (GValue *value,
                                                         guint v_uint);
guint               g_value_get_uint                    (const GValue *value);

#define             G_IS_PARAM_SPEC_LONG                (pspec)
#define             G_PARAM_SPEC_LONG                   (pspec)
#define             G_VALUE_HOLDS_LONG                  (value)
#define             G_TYPE_PARAM_LONG
struct              GParamSpecLong;
GParamSpec *        g_param_spec_long                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         glong minimum,
                                                         glong maximum,
                                                         glong default_value,
                                                         GParamFlags flags);
void                g_value_set_long                    (GValue *value,
                                                         glong v_long);
glong               g_value_get_long                    (const GValue *value);

#define             G_IS_PARAM_SPEC_ULONG               (pspec)
#define             G_PARAM_SPEC_ULONG                  (pspec)
#define             G_VALUE_HOLDS_ULONG                 (value)
#define             G_TYPE_PARAM_ULONG
struct              GParamSpecULong;
GParamSpec *        g_param_spec_ulong                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gulong minimum,
                                                         gulong maximum,
                                                         gulong default_value,
                                                         GParamFlags flags);
void                g_value_set_ulong                   (GValue *value,
                                                         gulong v_ulong);
gulong              g_value_get_ulong                   (const GValue *value);

#define             G_IS_PARAM_SPEC_INT64               (pspec)
#define             G_PARAM_SPEC_INT64                  (pspec)
#define             G_VALUE_HOLDS_INT64                 (value)
#define             G_TYPE_PARAM_INT64
struct              GParamSpecInt64;
GParamSpec *        g_param_spec_int64                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint64 minimum,
                                                         gint64 maximum,
                                                         gint64 default_value,
                                                         GParamFlags flags);
void                g_value_set_int64                   (GValue *value,
                                                         gint64 v_int64);
gint64              g_value_get_int64                   (const GValue *value);

#define             G_IS_PARAM_SPEC_UINT64              (pspec)
#define             G_PARAM_SPEC_UINT64                 (pspec)
#define             G_VALUE_HOLDS_UINT64                (value)
#define             G_TYPE_PARAM_UINT64
struct              GParamSpecUInt64;
GParamSpec *        g_param_spec_uint64                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint64 minimum,
                                                         guint64 maximum,
                                                         guint64 default_value,
                                                         GParamFlags flags);
void                g_value_set_uint64                  (GValue *value,
                                                         guint64 v_uint64);
guint64             g_value_get_uint64                  (const GValue *value);

#define             G_IS_PARAM_SPEC_FLOAT               (pspec)
#define             G_PARAM_SPEC_FLOAT                  (pspec)
#define             G_VALUE_HOLDS_FLOAT                 (value)
#define             G_TYPE_PARAM_FLOAT
struct              GParamSpecFloat;
GParamSpec *        g_param_spec_float                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gfloat minimum,
                                                         gfloat maximum,
                                                         gfloat default_value,
                                                         GParamFlags flags);
void                g_value_set_float                   (GValue *value,
                                                         gfloat v_float);
gfloat              g_value_get_float                   (const GValue *value);

#define             G_IS_PARAM_SPEC_DOUBLE              (pspec)
#define             G_PARAM_SPEC_DOUBLE                 (pspec)
#define             G_VALUE_HOLDS_DOUBLE                (value)
#define             G_TYPE_PARAM_DOUBLE
struct              GParamSpecDouble;
GParamSpec *        g_param_spec_double                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gdouble minimum,
                                                         gdouble maximum,
                                                         gdouble default_value,
                                                         GParamFlags flags);
void                g_value_set_double                  (GValue *value,
                                                         gdouble v_double);
gdouble             g_value_get_double                  (const GValue *value);

#define             G_IS_PARAM_SPEC_ENUM                (pspec)
#define             G_PARAM_SPEC_ENUM                   (pspec)
#define             G_VALUE_HOLDS_ENUM                  (value)
#define             G_TYPE_PARAM_ENUM
struct              GParamSpecEnum;
GParamSpec *        g_param_spec_enum                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType enum_type,
                                                         gint default_value,
                                                         GParamFlags flags);
void                g_value_set_enum                    (GValue *value,
                                                         gint v_enum);
gint                g_value_get_enum                    (const GValue *value);

#define             G_IS_PARAM_SPEC_FLAGS               (pspec)
#define             G_PARAM_SPEC_FLAGS                  (pspec)
#define             G_VALUE_HOLDS_FLAGS                 (value)
#define             G_TYPE_PARAM_FLAGS
struct              GParamSpecFlags;
GParamSpec *        g_param_spec_flags                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType flags_type,
                                                         guint default_value,
                                                         GParamFlags flags);
void                g_value_set_flags                   (GValue *value,
                                                         guint v_flags);
guint               g_value_get_flags                   (const GValue *value);

#define             G_IS_PARAM_SPEC_STRING              (pspec)
#define             G_PARAM_SPEC_STRING                 (pspec)
#define             G_VALUE_HOLDS_STRING                (value)
#define             G_TYPE_PARAM_STRING
struct              GParamSpecString;
typedef             gchararray;
GParamSpec *        g_param_spec_string                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         const gchar *default_value,
                                                         GParamFlags flags);
void                g_value_set_string                  (GValue *value,
                                                         const gchar *v_string);
void                g_value_set_static_string           (GValue *value,
                                                         const gchar *v_string);
void                g_value_take_string                 (GValue *value,
                                                         gchar *v_string);
void                g_value_set_string_take_ownership   (GValue *value,
                                                         gchar *v_string);
const gchar *       g_value_get_string                  (const GValue *value);
gchar *             g_value_dup_string                  (const GValue *value);

#define             G_IS_PARAM_SPEC_PARAM               (pspec)
#define             G_PARAM_SPEC_PARAM                  (pspec)
#define             G_VALUE_HOLDS_PARAM                 (value)
#define             G_TYPE_PARAM_PARAM
struct              GParamSpecParam;
GParamSpec *        g_param_spec_param                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType param_type,
                                                         GParamFlags flags);
void                g_value_set_param                   (GValue *value,
                                                         GParamSpec *param);
void                g_value_take_param                  (GValue *value,
                                                         GParamSpec *param);
void                g_value_set_param_take_ownership    (GValue *value,
                                                         GParamSpec *param);
GParamSpec *        g_value_get_param                   (const GValue *value);
GParamSpec *        g_value_dup_param                   (const GValue *value);

#define             G_IS_PARAM_SPEC_BOXED               (pspec)
#define             G_PARAM_SPEC_BOXED                  (pspec)
#define             G_VALUE_HOLDS_BOXED                 (value)
#define             G_TYPE_PARAM_BOXED
struct              GParamSpecBoxed;
GParamSpec *        g_param_spec_boxed                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType boxed_type,
                                                         GParamFlags flags);
void                g_value_set_boxed                   (GValue *value,
                                                         gconstpointer v_boxed);
void                g_value_set_static_boxed            (GValue *value,
                                                         gconstpointer v_boxed);
void                g_value_take_boxed                  (GValue *value,
                                                         gconstpointer v_boxed);
void                g_value_set_boxed_take_ownership    (GValue *value,
                                                         gconstpointer v_boxed);
gpointer            g_value_get_boxed                   (const GValue *value);
gpointer            g_value_dup_boxed                   (const GValue *value);

#define             G_IS_PARAM_SPEC_POINTER             (pspec)
#define             G_PARAM_SPEC_POINTER                (pspec)
#define             G_VALUE_HOLDS_POINTER               (value)
#define             G_TYPE_PARAM_POINTER
struct              GParamSpecPointer;
GParamSpec *        g_param_spec_pointer                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GParamFlags flags);
void                g_value_set_pointer                 (GValue *value,
                                                         gpointer v_pointer);
gpointer            g_value_get_pointer                 (const GValue *value);

#define             G_IS_PARAM_SPEC_OBJECT              (pspec)
#define             G_PARAM_SPEC_OBJECT                 (pspec)
#define             G_VALUE_HOLDS_OBJECT                (value)
#define             G_TYPE_PARAM_OBJECT
struct              GParamSpecObject;
GParamSpec *        g_param_spec_object                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType object_type,
                                                         GParamFlags flags);
void                g_value_set_object                  (GValue *value,
                                                         gpointer v_object);
void                g_value_take_object                 (GValue *value,
                                                         gpointer v_object);
void                g_value_set_object_take_ownership   (GValue *value,
                                                         gpointer v_object);
gpointer            g_value_get_object                  (const GValue *value);
gpointer            g_value_dup_object                  (const GValue *value);

#define             G_IS_PARAM_SPEC_UNICHAR             (pspec)
#define             G_PARAM_SPEC_UNICHAR                (pspec)
#define             G_TYPE_PARAM_UNICHAR
struct              GParamSpecUnichar;
GParamSpec *        g_param_spec_unichar                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gunichar default_value,
                                                         GParamFlags flags);

#define             G_IS_PARAM_SPEC_VALUE_ARRAY         (pspec)
#define             G_PARAM_SPEC_VALUE_ARRAY            (pspec)
#define             G_TYPE_PARAM_VALUE_ARRAY
struct              GParamSpecValueArray;
GParamSpec *        g_param_spec_value_array            (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GParamSpec *element_spec,
                                                         GParamFlags flags);

#define             G_IS_PARAM_SPEC_OVERRIDE            (pspec)
#define             G_PARAM_SPEC_OVERRIDE               (pspec)
#define             G_TYPE_PARAM_OVERRIDE
struct              GParamSpecOverride;
GParamSpec *        g_param_spec_override               (const gchar *name,
                                                         GParamSpec *overridden);

#define             G_IS_PARAM_SPEC_GTYPE               (pspec)
#define             G_PARAM_SPEC_GTYPE                  (pspec)
#define             G_VALUE_HOLDS_GTYPE                 (value)
#define             G_TYPE_PARAM_GTYPE
struct              GParamSpecGType;
GParamSpec *        g_param_spec_gtype                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType is_a_type,
                                                         GParamFlags flags);
GType               g_value_get_gtype                   (const GValue *value);
void                g_value_set_gtype                   (GValue *value,
                                                         GType v_gtype);

Description

GValue provides an abstract container structure which can be copied, transformed and compared while holding a value of any (derived) type, which is registered as a GType with a GTypeValueTable in its GTypeInfo structure. Parameter specifications for most value types can be created as GParamSpec derived instances, to implement e.g. GObject properties which operate on GValue containers.

Parameter names need to start with a letter (a-z or A-Z). Subsequent characters can be letters, numbers or a '-'. All other characters are replaced by a '-' during construction.

Details

G_IS_PARAM_SPEC_BOOLEAN()

#define G_IS_PARAM_SPEC_BOOLEAN(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOOLEAN))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_BOOLEAN.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_BOOLEAN()

#define G_PARAM_SPEC_BOOLEAN(pspec)        (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOOLEAN, GParamSpecBoolean))

Cast a GParamSpec instance into a GParamSpecBoolean.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_BOOLEAN()

#define G_VALUE_HOLDS_BOOLEAN(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOOLEAN))

Checks whether the given GValue can hold values of type G_TYPE_BOOLEAN.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_BOOLEAN

#define G_TYPE_PARAM_BOOLEAN		   (g_param_spec_types[2])

The GType of GParamSpecBoolean.


struct GParamSpecBoolean

struct GParamSpecBoolean {
  GParamSpec    parent_instance;
  
  gboolean      default_value;
};

A GParamSpec derived structure that contains the meta data for boolean properties.

GParamSpec parent_instance;

private GParamSpec portion

gboolean default_value;

default value for the property specified

g_param_spec_boolean ()

GParamSpec *        g_param_spec_boolean                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gboolean default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecBoolean instance specifying a G_TYPE_BOOLEAN property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_boolean ()

void                g_value_set_boolean                 (GValue *value,
                                                         gboolean v_boolean);

Set the contents of a G_TYPE_BOOLEAN GValue to v_boolean.

value :

a valid GValue of type G_TYPE_BOOLEAN

v_boolean :

boolean value to be set

g_value_get_boolean ()

gboolean            g_value_get_boolean                 (const GValue *value);

Get the contents of a G_TYPE_BOOLEAN GValue.

value :

a valid GValue of type G_TYPE_BOOLEAN

Returns :

boolean contents of value

G_IS_PARAM_SPEC_CHAR()

#define G_IS_PARAM_SPEC_CHAR(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_CHAR))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_CHAR.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_CHAR()

#define G_PARAM_SPEC_CHAR(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CHAR, GParamSpecChar))

Cast a GParamSpec instance into a GParamSpecChar.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_CHAR()

#define G_VALUE_HOLDS_CHAR(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_CHAR))

Checks whether the given GValue can hold values of type G_TYPE_CHAR.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_CHAR

#define G_TYPE_PARAM_CHAR		   (g_param_spec_types[0])

The GType of GParamSpecChar.


struct GParamSpecChar

struct GParamSpecChar {
  GParamSpec    parent_instance;
  
  gint8         minimum;
  gint8         maximum;
  gint8         default_value;
};

A GParamSpec derived structure that contains the meta data for character properties.

GParamSpec parent_instance;

private GParamSpec portion

gint8 minimum;

minimum value for the property specified

gint8 maximum;

maximum value for the property specified

gint8 default_value;

default value for the property specified

g_param_spec_char ()

GParamSpec *        g_param_spec_char                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint8 minimum,
                                                         gint8 maximum,
                                                         gint8 default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecChar instance specifying a G_TYPE_CHAR property.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_char ()

void                g_value_set_char                    (GValue *value,
                                                         gchar v_char);

Set the contents of a G_TYPE_CHAR GValue to v_char.

value :

a valid GValue of type G_TYPE_CHAR

v_char :

character value to be set

g_value_get_char ()

gchar               g_value_get_char                    (const GValue *value);

Get the contents of a G_TYPE_CHAR GValue.

value :

a valid GValue of type G_TYPE_CHAR

Returns :

character contents of value

G_IS_PARAM_SPEC_UCHAR()

#define G_IS_PARAM_SPEC_UCHAR(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UCHAR))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_UCHAR.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_UCHAR()

#define G_PARAM_SPEC_UCHAR(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UCHAR, GParamSpecUChar))

Cast a GParamSpec instance into a GParamSpecUChar.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_UCHAR()

#define G_VALUE_HOLDS_UCHAR(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UCHAR))

Checks whether the given GValue can hold values of type G_TYPE_UCHAR.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_UCHAR

#define G_TYPE_PARAM_UCHAR		   (g_param_spec_types[1])

The GType of GParamSpecUChar.


struct GParamSpecUChar

struct GParamSpecUChar {
  GParamSpec    parent_instance;
  
  guint8        minimum;
  guint8        maximum;
  guint8        default_value;
};

A GParamSpec derived structure that contains the meta data for unsigned character properties.

GParamSpec parent_instance;

private GParamSpec portion

guint8 minimum;

minimum value for the property specified

guint8 maximum;

maximum value for the property specified

guint8 default_value;

default value for the property specified

g_param_spec_uchar ()

GParamSpec *        g_param_spec_uchar                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint8 minimum,
                                                         guint8 maximum,
                                                         guint8 default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecUChar instance specifying a G_TYPE_UCHAR property.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_uchar ()

void                g_value_set_uchar                   (GValue *value,
                                                         guchar v_uchar);

Set the contents of a G_TYPE_UCHAR GValue to v_uchar.

value :

a valid GValue of type G_TYPE_UCHAR

v_uchar :

unsigned character value to be set

g_value_get_uchar ()

guchar              g_value_get_uchar                   (const GValue *value);

Get the contents of a G_TYPE_UCHAR GValue.

value :

a valid GValue of type G_TYPE_UCHAR

Returns :

unsigned character contents of value

G_IS_PARAM_SPEC_INT()

#define G_IS_PARAM_SPEC_INT(pspec)         (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_INT))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_INT.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_INT()

#define G_PARAM_SPEC_INT(pspec)            (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT, GParamSpecInt))

Cast a GParamSpec instance into a GParamSpecInt.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_INT()

#define G_VALUE_HOLDS_INT(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_INT))

Checks whether the given GValue can hold values of type G_TYPE_INT.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_INT

#define G_TYPE_PARAM_INT		   (g_param_spec_types[3])

The GType of GParamSpecInt.


struct GParamSpecInt

struct GParamSpecInt {
  GParamSpec    parent_instance;
  
  gint          minimum;
  gint          maximum;
  gint          default_value;
};

A GParamSpec derived structure that contains the meta data for integer properties.

GParamSpec parent_instance;

private GParamSpec portion

gint minimum;

minimum value for the property specified

gint maximum;

maximum value for the property specified

gint default_value;

default value for the property specified

g_param_spec_int ()

GParamSpec *        g_param_spec_int                    (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint minimum,
                                                         gint maximum,
                                                         gint default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecInt instance specifying a G_TYPE_INT property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_int ()

void                g_value_set_int                     (GValue *value,
                                                         gint v_int);

Set the contents of a G_TYPE_INT GValue to v_int.

value :

a valid GValue of type G_TYPE_INT

v_int :

integer value to be set

g_value_get_int ()

gint                g_value_get_int                     (const GValue *value);

Get the contents of a G_TYPE_INT GValue.

value :

a valid GValue of type G_TYPE_INT

Returns :

integer contents of value

G_IS_PARAM_SPEC_UINT()

#define G_IS_PARAM_SPEC_UINT(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UINT))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_UINT.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_UINT()

#define G_PARAM_SPEC_UINT(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT, GParamSpecUInt))

Cast a GParamSpec instance into a GParamSpecUInt.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_UINT()

#define G_VALUE_HOLDS_UINT(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UINT))

Checks whether the given GValue can hold values of type G_TYPE_UINT.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_UINT

#define G_TYPE_PARAM_UINT		   (g_param_spec_types[4])

The GType of GParamSpecUInt.


struct GParamSpecUInt

struct GParamSpecUInt {
  GParamSpec    parent_instance;
  
  guint         minimum;
  guint         maximum;
  guint         default_value;
};

A GParamSpec derived structure that contains the meta data for unsigned integer properties.

GParamSpec parent_instance;

private GParamSpec portion

guint minimum;

minimum value for the property specified

guint maximum;

maximum value for the property specified

guint default_value;

default value for the property specified

g_param_spec_uint ()

GParamSpec *        g_param_spec_uint                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint minimum,
                                                         guint maximum,
                                                         guint default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecUInt instance specifying a G_TYPE_UINT property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_uint ()

void                g_value_set_uint                    (GValue *value,
                                                         guint v_uint);

Set the contents of a G_TYPE_UINT GValue to v_uint.

value :

a valid GValue of type G_TYPE_UINT

v_uint :

unsigned integer value to be set

g_value_get_uint ()

guint               g_value_get_uint                    (const GValue *value);

Get the contents of a G_TYPE_UINT GValue.

value :

a valid GValue of type G_TYPE_UINT

Returns :

unsigned integer contents of value

G_IS_PARAM_SPEC_LONG()

#define G_IS_PARAM_SPEC_LONG(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_LONG))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_LONG.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_LONG()

#define G_PARAM_SPEC_LONG(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_LONG, GParamSpecLong))

Cast a GParamSpec instance into a GParamSpecLong.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_LONG()

#define G_VALUE_HOLDS_LONG(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_LONG))

Checks whether the given GValue can hold values of type G_TYPE_LONG.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_LONG

#define G_TYPE_PARAM_LONG		   (g_param_spec_types[5])

The GType of GParamSpecLong.


struct GParamSpecLong

struct GParamSpecLong {
  GParamSpec    parent_instance;
  
  glong         minimum;
  glong         maximum;
  glong         default_value;
};

A GParamSpec derived structure that contains the meta data for long integer properties.

GParamSpec parent_instance;

private GParamSpec portion

glong minimum;

minimum value for the property specified

glong maximum;

maximum value for the property specified

glong default_value;

default value for the property specified

g_param_spec_long ()

GParamSpec *        g_param_spec_long                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         glong minimum,
                                                         glong maximum,
                                                         glong default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecLong instance specifying a G_TYPE_LONG property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_long ()

void                g_value_set_long                    (GValue *value,
                                                         glong v_long);

Set the contents of a G_TYPE_LONG GValue to v_long.

value :

a valid GValue of type G_TYPE_LONG

v_long :

long integer value to be set

g_value_get_long ()

glong               g_value_get_long                    (const GValue *value);

Get the contents of a G_TYPE_LONG GValue.

value :

a valid GValue of type G_TYPE_LONG

Returns :

long integer contents of value

G_IS_PARAM_SPEC_ULONG()

#define G_IS_PARAM_SPEC_ULONG(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ULONG))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_ULONG.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_ULONG()

#define G_PARAM_SPEC_ULONG(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ULONG, GParamSpecULong))

Cast a GParamSpec instance into a GParamSpecULong.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_ULONG()

#define G_VALUE_HOLDS_ULONG(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_ULONG))

Checks whether the given GValue can hold values of type G_TYPE_ULONG.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_ULONG

#define G_TYPE_PARAM_ULONG		   (g_param_spec_types[6])

The GType of GParamSpecULong.


struct GParamSpecULong

struct GParamSpecULong {
  GParamSpec    parent_instance;
  
  gulong        minimum;
  gulong        maximum;
  gulong        default_value;
};

A GParamSpec derived structure that contains the meta data for unsigned long integer properties.

GParamSpec parent_instance;

private GParamSpec portion

gulong minimum;

minimum value for the property specified

gulong maximum;

maximum value for the property specified

gulong default_value;

default value for the property specified

g_param_spec_ulong ()

GParamSpec *        g_param_spec_ulong                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gulong minimum,
                                                         gulong maximum,
                                                         gulong default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecULong instance specifying a G_TYPE_ULONG property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_ulong ()

void                g_value_set_ulong                   (GValue *value,
                                                         gulong v_ulong);

Set the contents of a G_TYPE_ULONG GValue to v_ulong.

value :

a valid GValue of type G_TYPE_ULONG

v_ulong :

unsigned long integer value to be set

g_value_get_ulong ()

gulong              g_value_get_ulong                   (const GValue *value);

Get the contents of a G_TYPE_ULONG GValue.

value :

a valid GValue of type G_TYPE_ULONG

Returns :

unsigned long integer contents of value

G_IS_PARAM_SPEC_INT64()

#define G_IS_PARAM_SPEC_INT64(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_INT64))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_INT64.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_INT64()

#define G_PARAM_SPEC_INT64(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT64, GParamSpecInt64))

Cast a GParamSpec instance into a GParamSpecInt64.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_INT64()

#define G_VALUE_HOLDS_INT64(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_INT64))

Checks whether the given GValue can hold values of type G_TYPE_INT64.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_INT64

#define G_TYPE_PARAM_INT64		   (g_param_spec_types[7])

The GType of GParamSpecInt64.


struct GParamSpecInt64

struct GParamSpecInt64 {
  GParamSpec    parent_instance;
  
  gint64        minimum;
  gint64        maximum;
  gint64        default_value;
};

A GParamSpec derived structure that contains the meta data for 64bit integer properties.

GParamSpec parent_instance;

private GParamSpec portion

gint64 minimum;

minimum value for the property specified

gint64 maximum;

maximum value for the property specified

gint64 default_value;

default value for the property specified

g_param_spec_int64 ()

GParamSpec *        g_param_spec_int64                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint64 minimum,
                                                         gint64 maximum,
                                                         gint64 default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecInt64 instance specifying a G_TYPE_INT64 property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_int64 ()

void                g_value_set_int64                   (GValue *value,
                                                         gint64 v_int64);

Set the contents of a G_TYPE_INT64 GValue to v_int64.

value :

a valid GValue of type G_TYPE_INT64

v_int64 :

64bit integer value to be set

g_value_get_int64 ()

gint64              g_value_get_int64                   (const GValue *value);

Get the contents of a G_TYPE_INT64 GValue.

value :

a valid GValue of type G_TYPE_INT64

Returns :

64bit integer contents of value

G_IS_PARAM_SPEC_UINT64()

#define G_IS_PARAM_SPEC_UINT64(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UINT64))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_UINT64.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_UINT64()

#define G_PARAM_SPEC_UINT64(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT64, GParamSpecUInt64))

Cast a GParamSpec instance into a GParamSpecUInt64.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_UINT64()

#define G_VALUE_HOLDS_UINT64(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UINT64))

Checks whether the given GValue can hold values of type G_TYPE_UINT64.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_UINT64

#define G_TYPE_PARAM_UINT64		   (g_param_spec_types[8])

The GType of GParamSpecUInt64.


struct GParamSpecUInt64

struct GParamSpecUInt64 {
  GParamSpec    parent_instance;
  
  guint64       minimum;
  guint64       maximum;
  guint64       default_value;
};

A GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties.

GParamSpec parent_instance;

private GParamSpec portion

guint64 minimum;

minimum value for the property specified

guint64 maximum;

maximum value for the property specified

guint64 default_value;

default value for the property specified

g_param_spec_uint64 ()

GParamSpec *        g_param_spec_uint64                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint64 minimum,
                                                         guint64 maximum,
                                                         guint64 default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecUInt64 instance specifying a G_TYPE_UINT64 property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_uint64 ()

void                g_value_set_uint64                  (GValue *value,
                                                         guint64 v_uint64);

Set the contents of a G_TYPE_UINT64 GValue to v_uint64.

value :

a valid GValue of type G_TYPE_UINT64

v_uint64 :

unsigned 64bit integer value to be set

g_value_get_uint64 ()

guint64             g_value_get_uint64                  (const GValue *value);

Get the contents of a G_TYPE_UINT64 GValue.

value :

a valid GValue of type G_TYPE_UINT64

Returns :

unsigned 64bit integer contents of value

G_IS_PARAM_SPEC_FLOAT()

#define G_IS_PARAM_SPEC_FLOAT(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLOAT))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_FLOAT.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_FLOAT()

#define G_PARAM_SPEC_FLOAT(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLOAT, GParamSpecFloat))

Cast a GParamSpec instance into a GParamSpecFloat.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_FLOAT()

#define G_VALUE_HOLDS_FLOAT(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_FLOAT))

Checks whether the given GValue can hold values of type G_TYPE_FLOAT.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_FLOAT

#define G_TYPE_PARAM_FLOAT		   (g_param_spec_types[12])

The GType of GParamSpecFloat.


struct GParamSpecFloat

struct GParamSpecFloat {
  GParamSpec    parent_instance;
  
  gfloat        minimum;
  gfloat        maximum;
  gfloat        default_value;
  gfloat        epsilon;
};

A GParamSpec derived structure that contains the meta data for float properties.

GParamSpec parent_instance;

private GParamSpec portion

gfloat minimum;

minimum value for the property specified

gfloat maximum;

maximum value for the property specified

gfloat default_value;

default value for the property specified

gfloat epsilon;

values closer than epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-30.

g_param_spec_float ()

GParamSpec *        g_param_spec_float                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gfloat minimum,
                                                         gfloat maximum,
                                                         gfloat default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecFloat instance specifying a G_TYPE_FLOAT property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_float ()

void                g_value_set_float                   (GValue *value,
                                                         gfloat v_float);

Set the contents of a G_TYPE_FLOAT GValue to v_float.

value :

a valid GValue of type G_TYPE_FLOAT

v_float :

float value to be set

g_value_get_float ()

gfloat              g_value_get_float                   (const GValue *value);

Get the contents of a G_TYPE_FLOAT GValue.

value :

a valid GValue of type G_TYPE_FLOAT

Returns :

float contents of value

G_IS_PARAM_SPEC_DOUBLE()

#define G_IS_PARAM_SPEC_DOUBLE(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_DOUBLE))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_DOUBLE.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_DOUBLE()

#define G_PARAM_SPEC_DOUBLE(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_DOUBLE, GParamSpecDouble))

Cast a GParamSpec instance into a GParamSpecDouble.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_DOUBLE()

#define G_VALUE_HOLDS_DOUBLE(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_DOUBLE))

Checks whether the given GValue can hold values of type G_TYPE_DOUBLE.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_DOUBLE

#define G_TYPE_PARAM_DOUBLE		   (g_param_spec_types[13])

The GType of GParamSpecDouble.


struct GParamSpecDouble

struct GParamSpecDouble {
  GParamSpec    parent_instance;
  
  gdouble       minimum;
  gdouble       maximum;
  gdouble       default_value;
  gdouble       epsilon;
};

A GParamSpec derived structure that contains the meta data for double properties.

GParamSpec parent_instance;

private GParamSpec portion

gdouble minimum;

minimum value for the property specified

gdouble maximum;

maximum value for the property specified

gdouble default_value;

default value for the property specified

gdouble epsilon;

values closer than epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-90.

g_param_spec_double ()

GParamSpec *        g_param_spec_double                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gdouble minimum,
                                                         gdouble maximum,
                                                         gdouble default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecDouble instance specifying a G_TYPE_DOUBLE property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

minimum :

minimum value for the property specified

maximum :

maximum value for the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_double ()

void                g_value_set_double                  (GValue *value,
                                                         gdouble v_double);

Set the contents of a G_TYPE_DOUBLE GValue to v_double.

value :

a valid GValue of type G_TYPE_DOUBLE

v_double :

double value to be set

g_value_get_double ()

gdouble             g_value_get_double                  (const GValue *value);

Get the contents of a G_TYPE_DOUBLE GValue.

value :

a valid GValue of type G_TYPE_DOUBLE

Returns :

double contents of value

G_IS_PARAM_SPEC_ENUM()

#define G_IS_PARAM_SPEC_ENUM(pspec)        (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_ENUM))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_ENUM.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_ENUM()

#define G_PARAM_SPEC_ENUM(pspec)           (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ENUM, GParamSpecEnum))

Cast a GParamSpec instance into a GParamSpecEnum.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_ENUM()

#define G_VALUE_HOLDS_ENUM(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_ENUM))

Checks whether the given GValue can hold values derived from type G_TYPE_ENUM.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_ENUM

#define G_TYPE_PARAM_ENUM		   (g_param_spec_types[10])

The GType of GParamSpecEnum.


struct GParamSpecEnum

struct GParamSpecEnum {
  GParamSpec    parent_instance;
  
  GEnumClass   *enum_class;
  gint          default_value;
};

A GParamSpec derived structure that contains the meta data for enum properties.

GParamSpec parent_instance;

private GParamSpec portion

GEnumClass *enum_class;

the GEnumClass for the enum

gint default_value;

default value for the property specified

g_param_spec_enum ()

GParamSpec *        g_param_spec_enum                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType enum_type,
                                                         gint default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecEnum instance specifying a G_TYPE_ENUM property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

enum_type :

a GType derived from G_TYPE_ENUM

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_enum ()

void                g_value_set_enum                    (GValue *value,
                                                         gint v_enum);

Set the contents of a G_TYPE_ENUM GValue to v_enum.

value :

a valid GValue whose type is derived from G_TYPE_ENUM

v_enum :

enum value to be set

g_value_get_enum ()

gint                g_value_get_enum                    (const GValue *value);

Get the contents of a G_TYPE_ENUM GValue.

value :

a valid GValue whose type is derived from G_TYPE_ENUM

Returns :

enum contents of value

G_IS_PARAM_SPEC_FLAGS()

#define G_IS_PARAM_SPEC_FLAGS(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_FLAGS))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_FLAGS.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_FLAGS()

#define G_PARAM_SPEC_FLAGS(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLAGS, GParamSpecFlags))

Cast a GParamSpec instance into a GParamSpecFlags.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_FLAGS()

#define G_VALUE_HOLDS_FLAGS(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_FLAGS))

Checks whether the given GValue can hold values derived from type G_TYPE_FLAGS.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_FLAGS

#define G_TYPE_PARAM_FLAGS		   (g_param_spec_types[11])

The GType of GParamSpecFlags.


struct GParamSpecFlags

struct GParamSpecFlags {
  GParamSpec    parent_instance;
  
  GFlagsClass  *flags_class;
  guint         default_value;
};

A GParamSpec derived structure that contains the meta data for flags properties.

GParamSpec parent_instance;

private GParamSpec portion

GFlagsClass *flags_class;

the GFlagsClass for the flags

guint default_value;

default value for the property specified

g_param_spec_flags ()

GParamSpec *        g_param_spec_flags                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType flags_type,
                                                         guint default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecFlags instance specifying a G_TYPE_FLAGS property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

flags_type :

a GType derived from G_TYPE_FLAGS

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_flags ()

void                g_value_set_flags                   (GValue *value,
                                                         guint v_flags);

Set the contents of a G_TYPE_FLAGS GValue to v_flags.

value :

a valid GValue whose type is derived from G_TYPE_FLAGS

v_flags :

flags value to be set

g_value_get_flags ()

guint               g_value_get_flags                   (const GValue *value);

Get the contents of a G_TYPE_FLAGS GValue.

value :

a valid GValue whose type is derived from G_TYPE_FLAGS

Returns :

flags contents of value

G_IS_PARAM_SPEC_STRING()

#define G_IS_PARAM_SPEC_STRING(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_STRING))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_STRING.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_STRING()

#define G_PARAM_SPEC_STRING(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_STRING, GParamSpecString))

Casts a GParamSpec instance into a GParamSpecString.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_STRING()

#define G_VALUE_HOLDS_STRING(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_STRING))

Checks whether the given GValue can hold values of type G_TYPE_STRING.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_STRING

#define G_TYPE_PARAM_STRING		   (g_param_spec_types[14])

The GType of GParamSpecString.


struct GParamSpecString

struct GParamSpecString {
  GParamSpec    parent_instance;
  
  gchar        *default_value;
  gchar        *cset_first;
  gchar        *cset_nth;
  gchar         substitutor;
  guint         null_fold_if_empty : 1;
  guint         ensure_non_null : 1;
};

A GParamSpec derived structure that contains the meta data for string properties.

GParamSpec parent_instance;

private GParamSpec portion

gchar *default_value;

default value for the property specified

gchar *cset_first;

a string containing the allowed values for the first byte

gchar *cset_nth;

a string containing the allowed values for the subsequent bytes

gchar substitutor;

the replacement byte for bytes which don't match cset_first or cset_nth.

guint null_fold_if_empty : 1;

replace empty string by NULL

guint ensure_non_null : 1;

replace NULL strings by an empty string

gchararray

typedef gchar* gchararray;

A C representable type name for G_TYPE_STRING.


g_param_spec_string ()

GParamSpec *        g_param_spec_string                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         const gchar *default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecString instance.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_string ()

void                g_value_set_string                  (GValue *value,
                                                         const gchar *v_string);

Set the contents of a G_TYPE_STRING GValue to v_string.

value :

a valid GValue of type G_TYPE_STRING

v_string :

caller-owned string to be duplicated for the GValue

g_value_set_static_string ()

void                g_value_set_static_string           (GValue *value,
                                                         const gchar *v_string);

Set the contents of a G_TYPE_STRING GValue to v_string. The string is assumed to be static, and is thus not duplicated when setting the GValue.

value :

a valid GValue of type G_TYPE_STRING

v_string :

static string to be set

g_value_take_string ()

void                g_value_take_string                 (GValue *value,
                                                         gchar *v_string);

Sets the contents of a G_TYPE_STRING GValue to v_string.

value :

a valid GValue of type G_TYPE_STRING

v_string :

string to take ownership of

Since 2.4


g_value_set_string_take_ownership ()

void                g_value_set_string_take_ownership   (GValue *value,
                                                         gchar *v_string);

Warning

g_value_set_string_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code. Use g_value_take_string() instead.

This is an internal function introduced mainly for C marshallers.

value :

a valid GValue of type G_TYPE_STRING

v_string :

duplicated unowned string to be set

g_value_get_string ()

const gchar *       g_value_get_string                  (const GValue *value);

Get the contents of a G_TYPE_STRING GValue.

value :

a valid GValue of type G_TYPE_STRING

Returns :

string content of value

g_value_dup_string ()

gchar *             g_value_dup_string                  (const GValue *value);

Get a copy the contents of a G_TYPE_STRING GValue.

value :

a valid GValue of type G_TYPE_STRING

Returns :

a newly allocated copy of the string content of value

G_IS_PARAM_SPEC_PARAM()

#define G_IS_PARAM_SPEC_PARAM(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_PARAM))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_PARAM.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_PARAM()

#define G_PARAM_SPEC_PARAM(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_PARAM, GParamSpecParam))

Casts a GParamSpec instance into a GParamSpecParam.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_PARAM()

#define G_VALUE_HOLDS_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))

Checks whether the given GValue can hold values derived from type G_TYPE_PARAM.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_PARAM

#define G_TYPE_PARAM_PARAM		   (g_param_spec_types[15])

The GType of GParamSpecParam.


struct GParamSpecParam

struct GParamSpecParam {
  GParamSpec    parent_instance;
};

A GParamSpec derived structure that contains the meta data for G_TYPE_PARAM properties.

GParamSpec parent_instance;

private GParamSpec portion

g_param_spec_param ()

GParamSpec *        g_param_spec_param                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType param_type,
                                                         GParamFlags flags);

Creates a new GParamSpecParam instance specifying a G_TYPE_PARAM property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

param_type :

a GType derived from G_TYPE_PARAM

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_param ()

void                g_value_set_param                   (GValue *value,
                                                         GParamSpec *param);

Set the contents of a G_TYPE_PARAM GValue to param.

value :

a valid GValue of type G_TYPE_PARAM

param :

the GParamSpec to be set

g_value_take_param ()

void                g_value_take_param                  (GValue *value,
                                                         GParamSpec *param);

Sets the contents of a G_TYPE_PARAM GValue to param and takes over the ownership of the callers reference to param; the caller doesn't have to unref it any more.

value :

a valid GValue of type G_TYPE_PARAM

param :

the GParamSpec to be set

Since 2.4


g_value_set_param_take_ownership ()

void                g_value_set_param_take_ownership    (GValue *value,
                                                         GParamSpec *param);

Warning

g_value_set_param_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code. Use g_value_take_param() instead.

This is an internal function introduced mainly for C marshallers.

value :

a valid GValue of type G_TYPE_PARAM

param :

the GParamSpec to be set

g_value_get_param ()

GParamSpec *        g_value_get_param                   (const GValue *value);

Get the contents of a G_TYPE_PARAM GValue.

value :

a valid GValue whose type is derived from G_TYPE_PARAM

Returns :

GParamSpec content of value

g_value_dup_param ()

GParamSpec *        g_value_dup_param                   (const GValue *value);

Get the contents of a G_TYPE_PARAM GValue, increasing its reference count.

value :

a valid GValue whose type is derived from G_TYPE_PARAM

Returns :

GParamSpec content of value, should be unreferenced when no longer needed.

G_IS_PARAM_SPEC_BOXED()

#define G_IS_PARAM_SPEC_BOXED(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_BOXED))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_BOXED.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_BOXED()

#define G_PARAM_SPEC_BOXED(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOXED, GParamSpecBoxed))

Cast a GParamSpec instance into a GParamSpecBoxed.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_BOXED()

#define G_VALUE_HOLDS_BOXED(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOXED))

Checks whether the given GValue can hold values derived from type G_TYPE_BOXED.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_BOXED

#define G_TYPE_PARAM_BOXED		   (g_param_spec_types[16])

The GType of GParamSpecBoxed.


struct GParamSpecBoxed

struct GParamSpecBoxed {
  GParamSpec    parent_instance;
};

A GParamSpec derived structure that contains the meta data for boxed properties.

GParamSpec parent_instance;

private GParamSpec portion

g_param_spec_boxed ()

GParamSpec *        g_param_spec_boxed                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType boxed_type,
                                                         GParamFlags flags);

Creates a new GParamSpecBoxed instance specifying a G_TYPE_BOXED derived property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

boxed_type :

G_TYPE_BOXED derived type of this property

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_boxed ()

void                g_value_set_boxed                   (GValue *value,
                                                         gconstpointer v_boxed);

Set the contents of a G_TYPE_BOXED derived GValue to v_boxed.

value :

a valid GValue of G_TYPE_BOXED derived type

v_boxed :

boxed value to be set

g_value_set_static_boxed ()

void                g_value_set_static_boxed            (GValue *value,
                                                         gconstpointer v_boxed);

Set the contents of a G_TYPE_BOXED derived GValue to v_boxed. The boxed value is assumed to be static, and is thus not duplicated when setting the GValue.

value :

a valid GValue of G_TYPE_BOXED derived type

v_boxed :

static boxed value to be set

g_value_take_boxed ()

void                g_value_take_boxed                  (GValue *value,
                                                         gconstpointer v_boxed);

Sets the contents of a G_TYPE_BOXED derived GValue to v_boxed and takes over the ownership of the callers reference to v_boxed; the caller doesn't have to unref it any more.

value :

a valid GValue of G_TYPE_BOXED derived type

v_boxed :

duplicated unowned boxed value to be set

Since 2.4


g_value_set_boxed_take_ownership ()

void                g_value_set_boxed_take_ownership    (GValue *value,
                                                         gconstpointer v_boxed);

Warning

g_value_set_boxed_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code. Use g_value_take_boxed() instead.

This is an internal function introduced mainly for C marshallers.

value :

a valid GValue of G_TYPE_BOXED derived type

v_boxed :

duplicated unowned boxed value to be set

g_value_get_boxed ()

gpointer            g_value_get_boxed                   (const GValue *value);

Get the contents of a G_TYPE_BOXED derived GValue.

value :

a valid GValue of G_TYPE_BOXED derived type

Returns :

boxed contents of value

g_value_dup_boxed ()

gpointer            g_value_dup_boxed                   (const GValue *value);

Get the contents of a G_TYPE_BOXED derived GValue. Upon getting, the boxed value is duplicated and needs to be later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (value), return_value);

value :

a valid GValue of G_TYPE_BOXED derived type

Returns :

boxed contents of value

G_IS_PARAM_SPEC_POINTER()

#define G_IS_PARAM_SPEC_POINTER(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_POINTER))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_POINTER.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_POINTER()

#define G_PARAM_SPEC_POINTER(pspec)        (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_POINTER, GParamSpecPointer))

Casts a GParamSpec instance into a GParamSpecPointer.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_POINTER()

#define G_VALUE_HOLDS_POINTER(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_POINTER))

Checks whether the given GValue can hold values of type G_TYPE_POINTER.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_POINTER

#define G_TYPE_PARAM_POINTER		   (g_param_spec_types[17])

The GType of GParamSpecPointer.


struct GParamSpecPointer

struct GParamSpecPointer {
  GParamSpec    parent_instance;
};

A GParamSpec derived structure that contains the meta data for pointer properties.

GParamSpec parent_instance;

private GParamSpec portion

g_param_spec_pointer ()

GParamSpec *        g_param_spec_pointer                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GParamFlags flags);

Creates a new GParamSpecPoiner instance specifying a pointer property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_pointer ()

void                g_value_set_pointer                 (GValue *value,
                                                         gpointer v_pointer);

Set the contents of a pointer GValue to v_pointer.

value :

a valid GValue of G_TYPE_POINTER

v_pointer :

pointer value to be set

g_value_get_pointer ()

gpointer            g_value_get_pointer                 (const GValue *value);

Get the contents of a pointer GValue.

value :

a valid GValue of G_TYPE_POINTER

Returns :

pointer contents of value

G_IS_PARAM_SPEC_OBJECT()

#define G_IS_PARAM_SPEC_OBJECT(pspec)      (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_OBJECT))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_OBJECT.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_OBJECT()

#define G_PARAM_SPEC_OBJECT(pspec)         (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OBJECT, GParamSpecObject))

Casts a GParamSpec instance into a GParamSpecObject.

pspec :

a valid GParamSpec instance

G_VALUE_HOLDS_OBJECT()

#define G_VALUE_HOLDS_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))

Checks whether the given GValue can hold values derived from type G_TYPE_OBJECT.

value :

a valid GValue structure

Returns :

TRUE on success.

G_TYPE_PARAM_OBJECT

#define G_TYPE_PARAM_OBJECT		   (g_param_spec_types[19])

The GType of GParamSpecObject.


struct GParamSpecObject

struct GParamSpecObject {
  GParamSpec    parent_instance;
};

A GParamSpec derived structure that contains the meta data for object properties.

GParamSpec parent_instance;

private GParamSpec portion

g_param_spec_object ()

GParamSpec *        g_param_spec_object                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType object_type,
                                                         GParamFlags flags);

Creates a new GParamSpecBoxed instance specifying a G_TYPE_OBJECT derived property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

object_type :

G_TYPE_OBJECT derived type of this property

flags :

flags for the property specified

Returns :

a newly created parameter specification

g_value_set_object ()

void                g_value_set_object                  (GValue *value,
                                                         gpointer v_object);

Set the contents of a G_TYPE_OBJECT derived GValue to v_object.

g_value_set_object() increases the reference count of v_object (the GValue holds a reference to v_object). If you do not wish to increase the reference count of the object (i.e. you wish to pass your current reference to the GValue because you no longer need it), use g_value_take_object() instead.

It is important that your GValue holds a reference to v_object (either its own, or one it has taken) to ensure that the object won't be destroyed while the GValue still exists).

value :

a valid GValue of G_TYPE_OBJECT derived type

v_object :

object value to be set

g_value_take_object ()

void                g_value_take_object                 (GValue *value,
                                                         gpointer v_object);

Sets the contents of a G_TYPE_OBJECT derived GValue to v_object and takes over the ownership of the callers reference to v_object; the caller doesn't have to unref it any more (i.e. the reference count of the object is not increased).

If you want the GValue to hold its own reference to v_object, use g_value_set_object() instead.

value :

a valid GValue of G_TYPE_OBJECT derived type

v_object :

object value to be set

Since 2.4


g_value_set_object_take_ownership ()

void                g_value_set_object_take_ownership   (GValue *value,
                                                         gpointer v_object);

Warning

g_value_set_object_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code. Use g_value_take_object() instead.

This is an internal function introduced mainly for C marshallers.

value :

a valid GValue of G_TYPE_OBJECT derived type

v_object :

object value to be set

g_value_get_object ()

gpointer            g_value_get_object                  (const GValue *value);

Get the contents of a G_TYPE_OBJECT derived GValue.

value :

a valid GValue of G_TYPE_OBJECT derived type

Returns :

object contents of value

g_value_dup_object ()

gpointer            g_value_dup_object                  (const GValue *value);

Get the contents of a G_TYPE_OBJECT derived GValue, increasing its reference count.

value :

a valid GValue whose type is derived from G_TYPE_OBJECT

Returns :

object content of value, should be unreferenced when no longer needed.

G_IS_PARAM_SPEC_UNICHAR()

#define G_IS_PARAM_SPEC_UNICHAR(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_UNICHAR))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_UNICHAR.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_UNICHAR()

#define G_PARAM_SPEC_UNICHAR(pspec)        (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UNICHAR, GParamSpecUnichar))

Cast a GParamSpec instance into a GParamSpecUnichar.

pspec :

a valid GParamSpec instance

G_TYPE_PARAM_UNICHAR

#define G_TYPE_PARAM_UNICHAR		   (g_param_spec_types[9])

The GType of GParamSpecUnichar.


struct GParamSpecUnichar

struct GParamSpecUnichar {
  GParamSpec    parent_instance;
  
  gunichar      default_value;
};

A GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.

GParamSpec parent_instance;

private GParamSpec portion

gunichar default_value;

default value for the property specified

g_param_spec_unichar ()

GParamSpec *        g_param_spec_unichar                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gunichar default_value,
                                                         GParamFlags flags);

Creates a new GParamSpecUnichar instance specifying a G_TYPE_UINT property. GValue structures for this property can be accessed with g_value_set_uint() and g_value_get_uint().

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

default_value :

default value for the property specified

flags :

flags for the property specified

Returns :

a newly created parameter specification

G_IS_PARAM_SPEC_VALUE_ARRAY()

#define G_IS_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_VALUE_ARRAY))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_VALUE_ARRAY.

pspec :

a valid GParamSpec instance

Returns :

TRUE on success.

G_PARAM_SPEC_VALUE_ARRAY()

#define G_PARAM_SPEC_VALUE_ARRAY(pspec)    (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_VALUE_ARRAY, GParamSpecValueArray))

Cast a GParamSpec instance into a GParamSpecValueArray.

pspec :

a valid GParamSpec instance

G_TYPE_PARAM_VALUE_ARRAY

#define G_TYPE_PARAM_VALUE_ARRAY	   (g_param_spec_types[18])

The GType of GParamSpecValueArray.


struct GParamSpecValueArray

struct GParamSpecValueArray {
  GParamSpec    parent_instance;
  GParamSpec   *element_spec;
  guint		fixed_n_elements;
};

A GParamSpec derived structure that contains the meta data for GValueArray properties.

GParamSpec parent_instance;

private GParamSpec portion

GParamSpec *element_spec;

a GParamSpec describing the elements contained in arrays of this property, may be NULL

guint fixed_n_elements;

if greater than 0, arrays of this property will always have this many elements

g_param_spec_value_array ()

GParamSpec *        g_param_spec_value_array            (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GParamSpec *element_spec,
                                                         GParamFlags flags);

Creates a new GParamSpecValueArray instance specifying a G_TYPE_VALUE_ARRAY property. G_TYPE_VALUE_ARRAY is a G_TYPE_BOXED type, as such, GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed().

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

element_spec :

a GParamSpec describing the elements contained in arrays of this property, may be NULL

flags :

flags for the property specified

Returns :

a newly created parameter specification

G_IS_PARAM_SPEC_OVERRIDE()

#define G_IS_PARAM_SPEC_OVERRIDE(pspec)    (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_OVERRIDE))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_OVERRIDE.

pspec :

a GParamSpec

Returns :

TRUE on success.

Since 2.4


G_PARAM_SPEC_OVERRIDE()

#define G_PARAM_SPEC_OVERRIDE(pspec)       (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OVERRIDE, GParamSpecOverride))

Casts a GParamSpec into a GParamSpecOverride.

pspec :

a GParamSpec

Since 2.4


G_TYPE_PARAM_OVERRIDE

#define G_TYPE_PARAM_OVERRIDE		   (g_param_spec_types[20])

The GType of GParamSpecOverride.

Since 2.4


struct GParamSpecOverride

struct GParamSpecOverride {
};

This is a type of GParamSpec type that simply redirects operations to another paramspec. All operations other than getting or setting the value are redirected, including accessing the nick and blurb, validating a value, and so forth. See g_param_spec_get_redirect_target() for retrieving the overidden property. GParamSpecOverride is used in implementing g_object_class_override_property(), and will not be directly useful unless you are implementing a new base type similar to GObject.

Since 2.4


g_param_spec_override ()

GParamSpec *        g_param_spec_override               (const gchar *name,
                                                         GParamSpec *overridden);

Creates a new property of type GParamSpecOverride. This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject.

name :

the name of the property.

overridden :

The property that is being overridden

Returns :

the newly created GParamSpec

Since 2.4


G_IS_PARAM_SPEC_GTYPE()

#define G_IS_PARAM_SPEC_GTYPE(pspec)       (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_GTYPE))

Checks whether the given GParamSpec is of type G_TYPE_PARAM_GTYPE.

pspec :

a GParamSpec

Returns :

TRUE on success.

Since 2.10


G_PARAM_SPEC_GTYPE()

#define G_PARAM_SPEC_GTYPE(pspec)          (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_GTYPE, GParamSpecGType))

Casts a GParamSpec into a GParamSpecGType.

pspec :

a GParamSpec

Since 2.10


G_VALUE_HOLDS_GTYPE()

#define G_VALUE_HOLDS_GTYPE(value)	 (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_GTYPE))

Checks whether the given GValue can hold values of type G_TYPE_GTYPE.

value :

a valid GValue structure

Returns :

TRUE on success.

Since 2.12


G_TYPE_PARAM_GTYPE

#define G_TYPE_PARAM_GTYPE		   (g_param_spec_types[21])

The GType of GParamSpecGType.

Since 2.10


struct GParamSpecGType

struct GParamSpecGType {
  GParamSpec    parent_instance;
  GType         is_a_type;
};

A GParamSpec derived structure that contains the meta data for GType properties.

GParamSpec parent_instance;

private GParamSpec portion

GType is_a_type;

a GType whose subtypes can occur as values

Since 2.10


g_param_spec_gtype ()

GParamSpec *        g_param_spec_gtype                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType is_a_type,
                                                         GParamFlags flags);

Creates a new GParamSpecGType instance specifying a G_TYPE_GTYPE property.

See g_param_spec_internal() for details on property names.

name :

canonical name of the property specified

nick :

nick name for the property specified

blurb :

description of the property specified

is_a_type :

a GType whose subtypes are allowed as values of the property (use G_TYPE_NONE for any type)

flags :

flags for the property specified

Returns :

a newly created parameter specification

Since 2.10


g_value_get_gtype ()

GType               g_value_get_gtype                   (const GValue *value);

Get the contents of a G_TYPE_GTYPE GValue.

value :

a valid GValue of type G_TYPE_GTYPE

Returns :

the GType stored in value

Since 2.12


g_value_set_gtype ()

void                g_value_set_gtype                   (GValue *value,
                                                         GType v_gtype);

Set the contents of a G_TYPE_GTYPE GValue to v_gtype.

value :

a valid GValue of type G_TYPE_GTYPE

v_gtype :

GType to be set

Since 2.12

See Also

GParamSpec, GValue, g_object_class_install_property().