GObject Reference Manual
<<< Previous PageHomeUpNext Page >>>

Parameters and Values

Name

Parameters and Values -- Standard Parameter and Value Types.

Synopsis


#include <gobject.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_set_string_take_ownership
                                            (GValue *value,
                                             gchar *v_string);
G_CONST_RETURN 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_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_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_set_object_take_ownership
                                            (GValue *value,
                                             gpointer v_object);
gpointer    g_value_get_object              (const GValue *value);
GObject*    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);

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.

Details

G_IS_PARAM_SPEC_BOOLEAN()

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

Return whether the given GParamSpec is of type G_TYPE_PARAM_BOOLEAN.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_BOOLEAN

#define	G_TYPE_PARAM_BOOLEAN		   (g_param_spec_types[2])

struct GParamSpecBoolean

struct GParamSpecBoolean
{
  GParamSpec    parent_instance;
  
  gboolean      default_value;
};

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

GParamSpec parent_instanceprivate 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);

Create a new GParamSpecBoolean instance specifying a G_TYPE_BOOLEAN property.

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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_CHAR.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_CHAR

#define	G_TYPE_PARAM_CHAR		   (g_param_spec_types[0])

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_instanceprivate 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);

Create 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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_UCHAR.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_UCHAR

#define	G_TYPE_PARAM_UCHAR		   (g_param_spec_types[1])

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_instanceprivate 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);

Create 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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_INT.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_INT

#define	G_TYPE_PARAM_INT		   (g_param_spec_types[3])

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_instanceprivate 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);

Create a new GParamSpecInt instance specifying a G_TYPE_INT 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_UINT.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_UINT

#define	G_TYPE_PARAM_UINT		   (g_param_spec_types[4])

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_instanceprivate 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);

Create a new GParamSpecUInt instance specifying a G_TYPE_UINT 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_LONG.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_LONG

#define	G_TYPE_PARAM_LONG		   (g_param_spec_types[5])

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_instanceprivate 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);

Create a new GParamSpecLong instance specifying a G_TYPE_LONG 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_ULONG.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_ULONG

#define	G_TYPE_PARAM_ULONG		   (g_param_spec_types[6])

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_instanceprivate 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);

Create a new GParamSpecULong instance specifying a G_TYPE_ULONG 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_INT64.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_INT64

#define	G_TYPE_PARAM_INT64		   (g_param_spec_types[7])

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_instanceprivate 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);

Create a new GParamSpecInt64 instance specifying a G_TYPE_INT64 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_UINT64.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_UINT64

#define	G_TYPE_PARAM_UINT64		   (g_param_spec_types[8])

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_instanceprivate 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);

Create a new GParamSpecUInt64 instance specifying a G_TYPE_UINT64 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_FLOAT.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_FLOAT

#define	G_TYPE_PARAM_FLOAT		   (g_param_spec_types[12])

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_instanceprivate 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 

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);

Create a new GParamSpecFloat instance specifying a G_TYPE_FLOAT 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_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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_DOUBLE.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_DOUBLE

#define	G_TYPE_PARAM_DOUBLE		   (g_param_spec_types[13])

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_instanceprivate 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 

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);

Create a new GParamSpecDouble instance specifying a G_TYPE_DOUBLE 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_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))

pspec : 

G_PARAM_SPEC_ENUM()

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

pspec : 

G_VALUE_HOLDS_ENUM()

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

value : 

G_TYPE_PARAM_ENUM

#define	G_TYPE_PARAM_ENUM		   (g_param_spec_types[10])

struct GParamSpecEnum

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

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);

name : 
nick : 
blurb : 
enum_type : 
default_value : 
flags : 
Returns : 

g_value_set_enum ()

void        g_value_set_enum                (GValue *value,
                                             gint v_enum);

value : 
v_enum : 

g_value_get_enum ()

gint        g_value_get_enum                (const GValue *value);

value : 
Returns : 

G_IS_PARAM_SPEC_FLAGS()

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

pspec : 

G_PARAM_SPEC_FLAGS()

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

pspec : 

G_VALUE_HOLDS_FLAGS()

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

value : 

G_TYPE_PARAM_FLAGS

#define	G_TYPE_PARAM_FLAGS		   (g_param_spec_types[11])

struct GParamSpecFlags

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

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);

name : 
nick : 
blurb : 
flags_type : 
default_value : 
flags : 
Returns : 

g_value_set_flags ()

void        g_value_set_flags               (GValue *value,
                                             guint v_flags);

value : 
v_flags : 

g_value_get_flags ()

guint       g_value_get_flags               (const GValue *value);

value : 
Returns : 

G_IS_PARAM_SPEC_STRING()

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

pspec : 

G_PARAM_SPEC_STRING()

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

pspec : 

G_VALUE_HOLDS_STRING()

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

value : 

G_TYPE_PARAM_STRING

#define	G_TYPE_PARAM_STRING		   (g_param_spec_types[14])

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;
};

gchararray

typedef gchar* gchararray;

g_param_spec_string ()

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

name : 
nick : 
blurb : 
default_value : 
flags : 
Returns : 

g_value_set_string ()

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

value : 
v_string : 

g_value_set_static_string ()

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

value : 
v_string : 

g_value_set_string_take_ownership ()

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

value : 
v_string : 

g_value_get_string ()

G_CONST_RETURN gchar* g_value_get_string    (const GValue *value);

value : 
Returns : 

g_value_dup_string ()

gchar*      g_value_dup_string              (const GValue *value);

value : 
Returns : 

G_IS_PARAM_SPEC_PARAM()

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

pspec : 

G_PARAM_SPEC_PARAM()

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

pspec : 

G_VALUE_HOLDS_PARAM()

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

value : 

G_TYPE_PARAM_PARAM

#define	G_TYPE_PARAM_PARAM		   (g_param_spec_types[15])

struct GParamSpecParam

struct GParamSpecParam
{
  GParamSpec    parent_instance;
};

g_param_spec_param ()

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

name : 
nick : 
blurb : 
param_type : 
flags : 
Returns : 

g_value_set_param ()

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

value : 
param : 

g_value_set_param_take_ownership ()

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

value : 
param : 

g_value_get_param ()

GParamSpec* g_value_get_param               (const GValue *value);

value : 
Returns : 

g_value_dup_param ()

GParamSpec* g_value_dup_param               (const GValue *value);

value : 
Returns : 

G_IS_PARAM_SPEC_BOXED()

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

Return whether the given GParamSpec is of type G_TYPE_PARAM_BOXED.

pspec :a valid GParamSpec instance

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))

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

value :a valid GValue structure

G_TYPE_PARAM_BOXED

#define	G_TYPE_PARAM_BOXED		   (g_param_spec_types[16])

struct GParamSpecBoxed

struct GParamSpecBoxed
{
  GParamSpec    parent_instance;
};

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

GParamSpec parent_instanceprivate 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);

Create a new GParamSpecBoxed instance specifying a G_TYPE_BOXED derived property.

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_set_boxed_take_ownership ()

void        g_value_set_boxed_take_ownership
                                            (GValue *value,
                                             gconstpointer v_boxed);

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))

pspec : 

G_PARAM_SPEC_POINTER()

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

pspec : 

G_VALUE_HOLDS_POINTER()

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

value : 

G_TYPE_PARAM_POINTER

#define	G_TYPE_PARAM_POINTER		   (g_param_spec_types[17])

struct GParamSpecPointer

struct GParamSpecPointer
{
  GParamSpec    parent_instance;
};

g_param_spec_pointer ()

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

name : 
nick : 
blurb : 
flags : 
Returns : 

g_value_set_pointer ()

void        g_value_set_pointer             (GValue *value,
                                             gpointer v_pointer);

value : 
v_pointer : 

g_value_get_pointer ()

gpointer    g_value_get_pointer             (const GValue *value);

value : 
Returns : 

G_IS_PARAM_SPEC_OBJECT()

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

pspec : 

G_PARAM_SPEC_OBJECT()

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

pspec : 

G_VALUE_HOLDS_OBJECT()

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

value : 

G_TYPE_PARAM_OBJECT

#define	G_TYPE_PARAM_OBJECT		   (g_param_spec_types[19])

struct GParamSpecObject

struct GParamSpecObject
{
  GParamSpec    parent_instance;
};

g_param_spec_object ()

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

name : 
nick : 
blurb : 
object_type : 
flags : 
Returns : 

g_value_set_object ()

void        g_value_set_object              (GValue *value,
                                             gpointer v_object);

value : 
v_object : 

g_value_set_object_take_ownership ()

void        g_value_set_object_take_ownership
                                            (GValue *value,
                                             gpointer v_object);

value : 
v_object : 

g_value_get_object ()

gpointer    g_value_get_object              (const GValue *value);

value : 
Returns : 

g_value_dup_object ()

GObject*    g_value_dup_object              (const GValue *value);

value : 
Returns : 

G_IS_PARAM_SPEC_UNICHAR()

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

Return whether the given GParamSpec is of type G_TYPE_PARAM_UNICHAR.

pspec :a valid GParamSpec instance

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])

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_instanceprivate 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);

Create 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().

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))

Return whether the given GParamSpec is of type G_TYPE_PARAM_VALUE_ARRAY.

pspec :a valid GParamSpec instance

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])

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_elementsif 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);

Create 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().

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

See Also

GParamSpec, GValue, g_object_class_install_property().



<<< Previous PageHomeUpNext Page >>>
Generic ValuesVarargs Value Collection