GObject Reference Manual | ||||
---|---|---|---|---|
Top | Description |
#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
);
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.
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_BOOLEAN(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOOLEAN, GParamSpecBoolean))
Cast a GParamSpec instance into a GParamSpecBoolean.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_BOOLEAN (g_param_spec_types[2])
The GType of GParamSpecBoolean.
struct GParamSpecBoolean { GParamSpec parent_instance; gboolean default_value; };
A GParamSpec derived structure that contains the meta data for boolean properties.
GParamSpec |
private GParamSpec portion |
gboolean |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_boolean (GValue *value
,gboolean v_boolean
);
Set the contents of a G_TYPE_BOOLEAN
GValue to v_boolean
.
|
a valid GValue of type G_TYPE_BOOLEAN
|
|
boolean value to be set |
gboolean g_value_get_boolean (const GValue *value
);
Get the contents of a G_TYPE_BOOLEAN
GValue.
|
a valid GValue of type G_TYPE_BOOLEAN
|
Returns : |
boolean contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_CHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_CHAR, GParamSpecChar))
Cast a GParamSpec instance into a GParamSpecChar.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
gint8 |
minimum value for the property specified |
gint8 |
maximum value for the property specified |
gint8 |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_char (GValue *value
,gchar v_char
);
Set the contents of a G_TYPE_CHAR
GValue to v_char
.
|
a valid GValue of type G_TYPE_CHAR
|
|
character value to be set |
gchar g_value_get_char (const GValue *value
);
Get the contents of a G_TYPE_CHAR
GValue.
|
a valid GValue of type G_TYPE_CHAR
|
Returns : |
character contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_UCHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UCHAR, GParamSpecUChar))
Cast a GParamSpec instance into a GParamSpecUChar.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
guint8 |
minimum value for the property specified |
guint8 |
maximum value for the property specified |
guint8 |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_uchar (GValue *value
,guchar v_uchar
);
Set the contents of a G_TYPE_UCHAR
GValue to v_uchar
.
|
a valid GValue of type G_TYPE_UCHAR
|
|
unsigned character value to be set |
guchar g_value_get_uchar (const GValue *value
);
Get the contents of a G_TYPE_UCHAR
GValue.
|
a valid GValue of type G_TYPE_UCHAR
|
Returns : |
unsigned character contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_INT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT, GParamSpecInt))
Cast a GParamSpec instance into a GParamSpecInt.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
gint |
minimum value for the property specified |
gint |
maximum value for the property specified |
gint |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_int (GValue *value
,gint v_int
);
Set the contents of a G_TYPE_INT
GValue to v_int
.
|
a valid GValue of type G_TYPE_INT
|
|
integer value to be set |
gint g_value_get_int (const GValue *value
);
Get the contents of a G_TYPE_INT
GValue.
|
a valid GValue of type G_TYPE_INT
|
Returns : |
integer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_UINT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT, GParamSpecUInt))
Cast a GParamSpec instance into a GParamSpecUInt.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
guint |
minimum value for the property specified |
guint |
maximum value for the property specified |
guint |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_uint (GValue *value
,guint v_uint
);
Set the contents of a G_TYPE_UINT
GValue to v_uint
.
|
a valid GValue of type G_TYPE_UINT
|
|
unsigned integer value to be set |
guint g_value_get_uint (const GValue *value
);
Get the contents of a G_TYPE_UINT
GValue.
|
a valid GValue of type G_TYPE_UINT
|
Returns : |
unsigned integer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_LONG(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_LONG, GParamSpecLong))
Cast a GParamSpec instance into a GParamSpecLong.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
glong |
minimum value for the property specified |
glong |
maximum value for the property specified |
glong |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_long (GValue *value
,glong v_long
);
Set the contents of a G_TYPE_LONG
GValue to v_long
.
|
a valid GValue of type G_TYPE_LONG
|
|
long integer value to be set |
glong g_value_get_long (const GValue *value
);
Get the contents of a G_TYPE_LONG
GValue.
|
a valid GValue of type G_TYPE_LONG
|
Returns : |
long integer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_ULONG(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ULONG, GParamSpecULong))
Cast a GParamSpec instance into a GParamSpecULong.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
gulong |
minimum value for the property specified |
gulong |
maximum value for the property specified |
gulong |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_ulong (GValue *value
,gulong v_ulong
);
Set the contents of a G_TYPE_ULONG
GValue to v_ulong
.
|
a valid GValue of type G_TYPE_ULONG
|
|
unsigned long integer value to be set |
gulong g_value_get_ulong (const GValue *value
);
Get the contents of a G_TYPE_ULONG
GValue.
|
a valid GValue of type G_TYPE_ULONG
|
Returns : |
unsigned long integer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_INT64(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_INT64, GParamSpecInt64))
Cast a GParamSpec instance into a GParamSpecInt64.
|
a valid GParamSpec instance |
#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
.
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 |
private GParamSpec portion |
gint64 |
minimum value for the property specified |
gint64 |
maximum value for the property specified |
gint64 |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_int64 (GValue *value
,gint64 v_int64
);
Set the contents of a G_TYPE_INT64
GValue to v_int64
.
|
a valid GValue of type G_TYPE_INT64
|
|
64bit integer value to be set |
gint64 g_value_get_int64 (const GValue *value
);
Get the contents of a G_TYPE_INT64
GValue.
|
a valid GValue of type G_TYPE_INT64
|
Returns : |
64bit integer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_UINT64(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UINT64, GParamSpecUInt64))
Cast a GParamSpec instance into a GParamSpecUInt64.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_UINT64 (g_param_spec_types[8])
The GType of 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 |
private GParamSpec portion |
guint64 |
minimum value for the property specified |
guint64 |
maximum value for the property specified |
guint64 |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_uint64 (GValue *value
,guint64 v_uint64
);
Set the contents of a G_TYPE_UINT64
GValue to v_uint64
.
|
a valid GValue of type G_TYPE_UINT64
|
|
unsigned 64bit integer value to be set |
guint64 g_value_get_uint64 (const GValue *value
);
Get the contents of a G_TYPE_UINT64
GValue.
|
a valid GValue of type G_TYPE_UINT64
|
Returns : |
unsigned 64bit integer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_FLOAT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLOAT, GParamSpecFloat))
Cast a GParamSpec instance into a GParamSpecFloat.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_FLOAT (g_param_spec_types[12])
The GType of 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 |
private GParamSpec portion |
gfloat |
minimum value for the property specified |
gfloat |
maximum value for the property specified |
gfloat |
default value for the property specified |
gfloat |
values closer than epsilon will be considered identical
by g_param_values_cmp() ; the default value is 1e-30. |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_float (GValue *value
,gfloat v_float
);
Set the contents of a G_TYPE_FLOAT
GValue to v_float
.
|
a valid GValue of type G_TYPE_FLOAT
|
|
float value to be set |
gfloat g_value_get_float (const GValue *value
);
Get the contents of a G_TYPE_FLOAT
GValue.
|
a valid GValue of type G_TYPE_FLOAT
|
Returns : |
float contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_DOUBLE(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_DOUBLE, GParamSpecDouble))
Cast a GParamSpec instance into a GParamSpecDouble.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_DOUBLE (g_param_spec_types[13])
The GType of 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 |
private GParamSpec portion |
gdouble |
minimum value for the property specified |
gdouble |
maximum value for the property specified |
gdouble |
default value for the property specified |
gdouble |
values closer than epsilon will be considered identical
by g_param_values_cmp() ; the default value is 1e-90. |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
minimum value for the property specified |
|
maximum value for the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_double (GValue *value
,gdouble v_double
);
Set the contents of a G_TYPE_DOUBLE
GValue to v_double
.
|
a valid GValue of type G_TYPE_DOUBLE
|
|
double value to be set |
gdouble g_value_get_double (const GValue *value
);
Get the contents of a G_TYPE_DOUBLE
GValue.
|
a valid GValue of type G_TYPE_DOUBLE
|
Returns : |
double contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_ENUM(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_ENUM, GParamSpecEnum))
Cast a GParamSpec instance into a GParamSpecEnum.
|
a valid GParamSpec instance |
#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
.
struct GParamSpecEnum { GParamSpec parent_instance; GEnumClass *enum_class; gint default_value; };
A GParamSpec derived structure that contains the meta data for enum properties.
GParamSpec |
private GParamSpec portion |
GEnumClass * |
the GEnumClass for the enum |
gint |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
a GType derived from G_TYPE_ENUM
|
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_enum (GValue *value
,gint v_enum
);
Set the contents of a G_TYPE_ENUM
GValue to v_enum
.
|
a valid GValue whose type is derived from G_TYPE_ENUM
|
|
enum value to be set |
gint g_value_get_enum (const GValue *value
);
Get the contents of a G_TYPE_ENUM
GValue.
|
a valid GValue whose type is derived from G_TYPE_ENUM
|
Returns : |
enum contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_FLAGS(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_FLAGS, GParamSpecFlags))
Cast a GParamSpec instance into a GParamSpecFlags.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_FLAGS (g_param_spec_types[11])
The GType of 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 |
private GParamSpec portion |
GFlagsClass * |
the GFlagsClass for the flags |
guint |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
a GType derived from G_TYPE_FLAGS
|
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_flags (GValue *value
,guint v_flags
);
Set the contents of a G_TYPE_FLAGS
GValue to v_flags
.
|
a valid GValue whose type is derived from G_TYPE_FLAGS
|
|
flags value to be set |
guint g_value_get_flags (const GValue *value
);
Get the contents of a G_TYPE_FLAGS
GValue.
|
a valid GValue whose type is derived from G_TYPE_FLAGS
|
Returns : |
flags contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_STRING(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_STRING, GParamSpecString))
Casts a GParamSpec instance into a GParamSpecString.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_STRING (g_param_spec_types[14])
The GType of 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 |
private GParamSpec portion |
gchar * |
default value for the property specified |
gchar * |
a string containing the allowed values for the first byte |
gchar * |
a string containing the allowed values for the subsequent bytes |
gchar |
the replacement byte for bytes which don't match cset_first or cset_nth . |
guint |
replace empty string by NULL
|
guint |
replace NULL strings by an empty 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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_string (GValue *value
,const gchar *v_string
);
Set the contents of a G_TYPE_STRING
GValue to v_string
.
|
a valid GValue of type G_TYPE_STRING
|
|
caller-owned string to be duplicated for the GValue |
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.
|
a valid GValue of type G_TYPE_STRING
|
|
static string to be set |
void g_value_take_string (GValue *value
,gchar *v_string
);
Sets the contents of a G_TYPE_STRING
GValue to v_string
.
|
a valid GValue of type G_TYPE_STRING
|
|
string to take ownership of |
Since 2.4
void g_value_set_string_take_ownership (GValue *value
,gchar *v_string
);
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.
|
a valid GValue of type G_TYPE_STRING
|
|
duplicated unowned string to be set |
const gchar * g_value_get_string (const GValue *value
);
Get the contents of a G_TYPE_STRING
GValue.
|
a valid GValue of type G_TYPE_STRING
|
Returns : |
string content of value
|
gchar * g_value_dup_string (const GValue *value
);
Get a copy the contents of a G_TYPE_STRING
GValue.
|
a valid GValue of type G_TYPE_STRING
|
Returns : |
a newly allocated copy of the string content of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_PARAM(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_PARAM, GParamSpecParam))
Casts a GParamSpec instance into a GParamSpecParam.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_PARAM (g_param_spec_types[15])
The GType of GParamSpecParam.
struct GParamSpecParam { GParamSpec parent_instance; };
A GParamSpec derived structure that contains the meta data for G_TYPE_PARAM
properties.
GParamSpec |
private GParamSpec portion |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
a GType derived from G_TYPE_PARAM
|
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_param (GValue *value
,GParamSpec *param
);
Set the contents of a G_TYPE_PARAM
GValue to param
.
|
a valid GValue of type G_TYPE_PARAM
|
|
the GParamSpec to be set |
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.
|
a valid GValue of type G_TYPE_PARAM
|
|
the GParamSpec to be set |
Since 2.4
void g_value_set_param_take_ownership (GValue *value
,GParamSpec *param
);
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.
|
a valid GValue of type G_TYPE_PARAM
|
|
the GParamSpec to be set |
GParamSpec * g_value_get_param (const GValue *value
);
Get the contents of a G_TYPE_PARAM
GValue.
|
a valid GValue whose type is derived from G_TYPE_PARAM
|
Returns : |
GParamSpec content of value
|
GParamSpec * g_value_dup_param (const GValue *value
);
Get the contents of a G_TYPE_PARAM
GValue, increasing its
reference count.
|
a valid GValue whose type is derived from G_TYPE_PARAM
|
Returns : |
GParamSpec content of value , should be unreferenced when
no longer needed. |
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_BOXED(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_BOXED, GParamSpecBoxed))
Cast a GParamSpec instance into a GParamSpecBoxed.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_BOXED (g_param_spec_types[16])
The GType of GParamSpecBoxed.
struct GParamSpecBoxed { GParamSpec parent_instance; };
A GParamSpec derived structure that contains the meta data for boxed properties.
GParamSpec |
private GParamSpec portion |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
G_TYPE_BOXED derived type of this property |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_boxed (GValue *value
,gconstpointer v_boxed
);
Set the contents of a G_TYPE_BOXED
derived GValue to v_boxed
.
|
a valid GValue of G_TYPE_BOXED derived type |
|
boxed value to be set |
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.
|
a valid GValue of G_TYPE_BOXED derived type |
|
static boxed value to be set |
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.
|
a valid GValue of G_TYPE_BOXED derived type |
|
duplicated unowned boxed value to be set |
Since 2.4
void g_value_set_boxed_take_ownership (GValue *value
,gconstpointer v_boxed
);
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.
|
a valid GValue of G_TYPE_BOXED derived type |
|
duplicated unowned boxed value to be set |
gpointer g_value_get_boxed (const GValue *value
);
Get the contents of a G_TYPE_BOXED
derived GValue.
|
a valid GValue of G_TYPE_BOXED derived type |
Returns : |
boxed contents of value
|
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);
|
a valid GValue of G_TYPE_BOXED derived type |
Returns : |
boxed contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_POINTER(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_POINTER, GParamSpecPointer))
Casts a GParamSpec instance into a GParamSpecPointer.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_POINTER (g_param_spec_types[17])
The GType of GParamSpecPointer.
struct GParamSpecPointer { GParamSpec parent_instance; };
A GParamSpec derived structure that contains the meta data for pointer properties.
GParamSpec |
private GParamSpec portion |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
void g_value_set_pointer (GValue *value
,gpointer v_pointer
);
Set the contents of a pointer GValue to v_pointer
.
|
a valid GValue of G_TYPE_POINTER
|
|
pointer value to be set |
gpointer g_value_get_pointer (const GValue *value
);
Get the contents of a pointer GValue.
|
a valid GValue of G_TYPE_POINTER
|
Returns : |
pointer contents of value
|
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OBJECT, GParamSpecObject))
Casts a GParamSpec instance into a GParamSpecObject.
|
a valid GParamSpec instance |
#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
.
#define G_TYPE_PARAM_OBJECT (g_param_spec_types[19])
The GType of GParamSpecObject.
struct GParamSpecObject { GParamSpec parent_instance; };
A GParamSpec derived structure that contains the meta data for object properties.
GParamSpec |
private GParamSpec portion |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
G_TYPE_OBJECT derived type of this property |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
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).
|
a valid GValue of G_TYPE_OBJECT derived type |
|
object value to be set |
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.
|
a valid GValue of G_TYPE_OBJECT derived type |
|
object value to be set |
Since 2.4
void g_value_set_object_take_ownership (GValue *value
,gpointer v_object
);
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.
|
a valid GValue of G_TYPE_OBJECT derived type |
|
object value to be set |
gpointer g_value_get_object (const GValue *value
);
Get the contents of a G_TYPE_OBJECT
derived GValue.
|
a valid GValue of G_TYPE_OBJECT derived type |
Returns : |
object contents of value
|
gpointer g_value_dup_object (const GValue *value
);
Get the contents of a G_TYPE_OBJECT
derived GValue, increasing
its reference count.
|
a valid GValue whose type is derived from G_TYPE_OBJECT
|
Returns : |
object content of value , should be unreferenced when no
longer needed. |
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#define G_PARAM_SPEC_UNICHAR(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_UNICHAR, GParamSpecUnichar))
Cast a GParamSpec instance into a GParamSpecUnichar.
|
a valid GParamSpec instance |
#define G_TYPE_PARAM_UNICHAR (g_param_spec_types[9])
The GType of GParamSpecUnichar.
struct GParamSpecUnichar { GParamSpec parent_instance; gunichar default_value; };
A GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.
GParamSpec |
private GParamSpec portion |
gunichar |
default value for the property specified |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
default value for the property specified |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
#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
.
|
a valid GParamSpec instance |
Returns : |
TRUE on success. |
#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.
|
a valid GParamSpec instance |
#define G_TYPE_PARAM_VALUE_ARRAY (g_param_spec_types[18])
The GType of 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 |
private GParamSpec portion |
GParamSpec * |
a GParamSpec describing the elements contained in arrays of this property, may be NULL
|
guint |
if greater than 0, arrays of this property will always have this many elements |
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
a GParamSpec describing the elements contained in
arrays of this property, may be NULL
|
|
flags for the property specified |
Returns : |
a newly created parameter specification |
#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
.
|
a GParamSpec |
Returns : |
TRUE on success. |
Since 2.4
#define G_PARAM_SPEC_OVERRIDE(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_OVERRIDE, GParamSpecOverride))
Casts a GParamSpec into a GParamSpecOverride.
|
a GParamSpec |
Since 2.4
#define G_TYPE_PARAM_OVERRIDE (g_param_spec_types[20])
The GType of GParamSpecOverride.
Since 2.4
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
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.
|
the name of the property. |
|
The property that is being overridden |
Returns : |
the newly created GParamSpec |
Since 2.4
#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
.
|
a GParamSpec |
Returns : |
TRUE on success. |
Since 2.10
#define G_PARAM_SPEC_GTYPE(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_GTYPE, GParamSpecGType))
Casts a GParamSpec into a GParamSpecGType.
|
a GParamSpec |
Since 2.10
#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
.
Since 2.12
#define G_TYPE_PARAM_GTYPE (g_param_spec_types[21])
The GType of GParamSpecGType.
Since 2.10
struct GParamSpecGType { GParamSpec parent_instance; GType is_a_type; };
A GParamSpec derived structure that contains the meta data for GType properties.
GParamSpec |
private GParamSpec portion |
GType |
a GType whose subtypes can occur as values |
Since 2.10
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.
|
canonical name of the property specified |
|
nick name for the property specified |
|
description of the property specified |
|
a GType whose subtypes are allowed as values
of the property (use G_TYPE_NONE for any type) |
|
flags for the property specified |
Returns : |
a newly created parameter specification |
Since 2.10
GType g_value_get_gtype (const GValue *value
);
Get the contents of a G_TYPE_GTYPE
GValue.
|
a valid GValue of type G_TYPE_GTYPE
|
Returns : |
the GType stored in value
|
Since 2.12
void g_value_set_gtype (GValue *value
,GType v_gtype
);
Set the contents of a G_TYPE_GTYPE
GValue to v_gtype
.
|
a valid GValue of type G_TYPE_GTYPE
|
|
GType to be set |
Since 2.12