gobject.Value.Value Class Reference

List of all members.

Detailed Description

Description The GValue structure is basically a variable container that consists of a type identifier and a specific value of that type.

The type identifier within a GValue structure always determines the type of the associated value. To create a undefined GValue structure, simply create a zero-filled GValue structure. To initialize the GValue, use the g_value_init() function. A GValue cannot be used until it is initialized. The basic type operations (such as freeing and copying) are determined by the GTypeValueTable associated with the type ID stored in the GValue. Other GValue operations (such as converting values between types) are provided by this interface.


Public Member Functions

GValuegetValueStruct ()
 this (GValue *gValue)
 Sets our main struct and passes it to the parent class.
 this ()
 this (Pixbuf pixbuf)
 this (char[] value)
 this (int value)
Value init (GType gType)
 Initializes value with the default value of type.
Value reset ()
 Clears the current value in value and resets it to the default value (as if the value had just been initialized).
void copy (Value destValue)
 Copies the value of src_value into dest_value.
void unset ()
 Clears the current value in value and "unsets" the type, this releases all resources associated with this GValue.
void setInstance (void *instanc)
 Sets value from an instantiatable type via the value_table's collect_value() function.
int fitsPointer ()
 Determines if value will fit inside the size of a pointer value.
void * peekPointer ()
 Return the value contents as pointer.
int transform (Value destValue)
 Tries to cast the contents of src_value into a type appropriate to store in dest_value, e.g.
char[] gStrdupValueContents ()
 Return a newly allocated string, which describes the contents of a GValue.
void setBoolean (int vBoolean)
 Set the contents of a G_TYPE_BOOLEAN GValue to v_boolean.
int getBoolean ()
 Get the contents of a G_TYPE_BOOLEAN GValue.
void setChar (char vChar)
 Set the contents of a G_TYPE_CHAR GValue to v_char.
char getChar ()
 Get the contents of a G_TYPE_CHAR GValue.
void setUchar (char vUchar)
 Set the contents of a G_TYPE_UCHAR GValue to v_uchar.
char getUchar ()
 Get the contents of a G_TYPE_UCHAR GValue.
void setInt (int vInt)
 Set the contents of a G_TYPE_INT GValue to v_int.
int getInt ()
 Get the contents of a G_TYPE_INT GValue.
void setUint (uint vUint)
 Set the contents of a G_TYPE_UINT GValue to v_uint.
uint getUint ()
 Get the contents of a G_TYPE_UINT GValue.
void setLong (int vLong)
 Set the contents of a G_TYPE_LONG GValue to v_long.
int getLong ()
 Get the contents of a G_TYPE_LONG GValue.
void setUlong (uint vUlong)
 Set the contents of a G_TYPE_ULONG GValue to v_ulong.
uint getUlong ()
 Get the contents of a G_TYPE_ULONG GValue.
void setInt64 (long vInt64)
 Set the contents of a G_TYPE_INT64 GValue to v_int64.
long getInt64 ()
 Get the contents of a G_TYPE_INT64 GValue.
void setUint64 (ulong vUint64)
 Set the contents of a G_TYPE_UINT64 GValue to v_uint64.
ulong getUint64 ()
 Get the contents of a G_TYPE_UINT64 GValue.
void setFloat (float vFloat)
 Set the contents of a G_TYPE_FLOAT GValue to v_float.
float getFloat ()
 Get the contents of a G_TYPE_FLOAT GValue.
void setDouble (double vDouble)
 Set the contents of a G_TYPE_DOUBLE GValue to v_double.
double getDouble ()
 Get the contents of a G_TYPE_DOUBLE GValue.
void setEnum (int vEnum)
 Set the contents of a G_TYPE_ENUM GValue to v_enum.
int getEnum ()
 Get the contents of a G_TYPE_ENUM GValue.
void setFlags (uint vFlags)
 Set the contents of a G_TYPE_FLAGS GValue to v_flags.
uint getFlags ()
 Get the contents of a G_TYPE_FLAGS GValue.
void setString (char[] vString)
 Set the contents of a G_TYPE_STRING GValue to v_string.
void setStaticString (char[] vString)
 Set the contents of a G_TYPE_STRING GValue to v_string.
void takeString (char[] vString)
 Sets the contents of a G_TYPE_STRING GValue to v_string.
void setStringTakeOwnership (char[] vString)
 Warning g_value_set_string_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.
char[] getString ()
 Get the contents of a G_TYPE_STRING GValue.
char[] dupString ()
 Get a copy the contents of a G_TYPE_STRING GValue.
void setParam (ParamSpec param)
 Set the contents of a G_TYPE_PARAM GValue to param.
void takeParam (ParamSpec 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.
void setParamTakeOwnership (ParamSpec param)
 Warning g_value_set_param_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.
ParamSpec getParam ()
 Get the contents of a G_TYPE_PARAM GValue.
ParamSpec dupParam ()
 Get the contents of a G_TYPE_PARAM GValue, increasing its reference count.
void setBoxed (void *vBoxed)
 Set the contents of a G_TYPE_BOXED derived GValue to v_boxed.
void setStaticBoxed (void *vBoxed)
 Set the contents of a G_TYPE_BOXED derived GValue to v_boxed.
void takeBoxed (void *vBoxed)
 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.
void setBoxedTakeOwnership (void *vBoxed)
 Warning g_value_set_boxed_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.
void * getBoxed ()
 Get the contents of a G_TYPE_BOXED derived GValue.
void * dupBoxed ()
 Get the contents of a G_TYPE_BOXED derived GValue.
void setPointer (void *vPointer)
 Set the contents of a pointer GValue to v_pointer.
void * getPointer ()
 Get the contents of a pointer GValue.
void setObject (void *vObject)
 Set the contents of a G_TYPE_OBJECT derived GValue to v_object.
void takeObject (void *vObject)
 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.
void setObjectTakeOwnership (void *vObject)
 Warning g_value_set_object_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.
void * getObject ()
 Get the contents of a G_TYPE_OBJECT derived GValue.
void * dupObject ()
 Get the contents of a G_TYPE_OBJECT derived GValue, increasing its reference count.
GType getGtype ()
 Get the contents of a G_TYPE_GTYPE GValue.
void setGtype (GType vGtype)
 Set the contents of a G_TYPE_GTYPE GValue to v_gtype.

Static Public Member Functions

static int typeCompatible (GType srcType, GType destType)
 Returns whether a GValue of type src_type can be copied into a GValue of type dest_type.
static int typeTransformable (GType srcType, GType destType)
 Check whether g_value_transform() is able to transform values of type src_type into values of type dest_type.
static void registerTransformFunc (GType srcType, GType destType, GValueTransform transformFunc)
 Registers a value transformation function for use in g_value_transform().
static ParamSpec gParamSpecBoolean (char[] name, char[] nick, char[] blurb, int defaultValue, GParamFlags flags)
 Creates a new GParamSpecBoolean instance specifying a G_TYPE_BOOLEAN property.
static ParamSpec gParamSpecChar (char[] name, char[] nick, char[] blurb, byte minimum, byte maximum, byte defaultValue, GParamFlags flags)
 Creates a new GParamSpecChar instance specifying a G_TYPE_CHAR property.
static ParamSpec gParamSpecUchar (char[] name, char[] nick, char[] blurb, byte minimum, byte maximum, byte defaultValue, GParamFlags flags)
 Creates a new GParamSpecUChar instance specifying a G_TYPE_UCHAR property.
static ParamSpec gParamSpecInt (char[] name, char[] nick, char[] blurb, int minimum, int maximum, int defaultValue, GParamFlags flags)
 Creates a new GParamSpecInt instance specifying a G_TYPE_INT property.
static ParamSpec gParamSpecUint (char[] name, char[] nick, char[] blurb, uint minimum, uint maximum, uint defaultValue, GParamFlags flags)
 Creates a new GParamSpecUInt instance specifying a G_TYPE_UINT property.
static ParamSpec gParamSpecLong (char[] name, char[] nick, char[] blurb, int minimum, int maximum, int defaultValue, GParamFlags flags)
 Creates a new GParamSpecLong instance specifying a G_TYPE_LONG property.
static ParamSpec gParamSpecUlong (char[] name, char[] nick, char[] blurb, uint minimum, uint maximum, uint defaultValue, GParamFlags flags)
 Creates a new GParamSpecULong instance specifying a G_TYPE_ULONG property.
static ParamSpec gParamSpecInt64 (char[] name, char[] nick, char[] blurb, long minimum, long maximum, long defaultValue, GParamFlags flags)
 Creates a new GParamSpecInt64 instance specifying a G_TYPE_INT64 property.
static ParamSpec gParamSpecUint64 (char[] name, char[] nick, char[] blurb, ulong minimum, ulong maximum, ulong defaultValue, GParamFlags flags)
 Creates a new GParamSpecUInt64 instance specifying a G_TYPE_UINT64 property.
static ParamSpec gParamSpecFloat (char[] name, char[] nick, char[] blurb, float minimum, float maximum, float defaultValue, GParamFlags flags)
 Creates a new GParamSpecFloat instance specifying a G_TYPE_FLOAT property.
static ParamSpec gParamSpecDouble (char[] name, char[] nick, char[] blurb, double minimum, double maximum, double defaultValue, GParamFlags flags)
 Creates a new GParamSpecDouble instance specifying a G_TYPE_DOUBLE property.
static ParamSpec gParamSpecEnum (char[] name, char[] nick, char[] blurb, GType enumType, int defaultValue, GParamFlags flags)
 Creates a new GParamSpecEnum instance specifying a G_TYPE_ENUM property.
static ParamSpec gParamSpecFlags (char[] name, char[] nick, char[] blurb, GType flagsType, uint defaultValue, GParamFlags flags)
 Creates a new GParamSpecEnum instance specifying a G_TYPE_FLAGS property.
static ParamSpec gParamSpecString (char[] name, char[] nick, char[] blurb, char[] defaultValue, GParamFlags flags)
 Creates a new GParamSpecString instance.
static ParamSpec gParamSpecParam (char[] name, char[] nick, char[] blurb, GType paramType, GParamFlags flags)
 Creates a new GParamSpecParam instance specifying a G_TYPE_PARAM property.
static ParamSpec gParamSpecBoxed (char[] name, char[] nick, char[] blurb, GType boxedType, GParamFlags flags)
 Creates a new GParamSpecBoxed instance specifying a G_TYPE_BOXED derived property.
static ParamSpec gParamSpecPointer (char[] name, char[] nick, char[] blurb, GParamFlags flags)
 Creates a new GParamSpecPoiner instance specifying a pointer property.
static ParamSpec gParamSpecObject (char[] name, char[] nick, char[] blurb, GType objectType, GParamFlags flags)
 Creates a new GParamSpecBoxed instance specifying a G_TYPE_OBJECT derived property.
static ParamSpec gParamSpecUnichar (char[] name, char[] nick, char[] blurb, gunichar defaultValue, GParamFlags flags)
 Creates a new GParamSpecUnichar instance specifying a G_TYPE_UINT property.
static ParamSpec gParamSpecValueArray (char[] name, char[] nick, char[] blurb, ParamSpec elementSpec, GParamFlags flags)
 Creates a new GParamSpecValueArray instance specifying a G_TYPE_VALUE_ARRAY property.
static ParamSpec gParamSpecOverride (char[] name, ParamSpec overridden)
 Creates a new property of type GParamSpecOverride.
static ParamSpec gParamSpecGtype (char[] name, char[] nick, char[] blurb, GType isAType, GParamFlags flags)
 Creates a new GParamSpecGType instance specifying a G_TYPE_GTYPE property.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GValuegValue
 the main Gtk struct


Constructor & Destructor Documentation

gobject.Value.Value.this ( GValue gValue  ) 

Sets our main struct and passes it to the parent class.

gobject.Value.Value.this (  ) 

gobject.Value.Value.this ( Pixbuf  pixbuf  ) 

gobject.Value.Value.this ( char[]  value  ) 

gobject.Value.Value.this ( int  value  ) 


Member Function Documentation

void gobject.Value.Value.copy ( Value  destValue  ) 

Copies the value of src_value into dest_value.

src_value: An initialized GValue structure. dest_value: An initialized GValue structure of the same type as src_value.

void* gobject.Value.Value.dupBoxed (  ) 

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

void* gobject.Value.Value.dupObject (  ) 

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

value: a valid GValue whose type is derived from G_TYPE_OBJECT Returns: object content of value, should be unreferenced when no longer needed.

ParamSpec gobject.Value.Value.dupParam (  ) 

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

value: a valid GValue whose type is derived from G_TYPE_PARAM Returns: GParamSpec content of value, should be unreferenced when no longer needed.

char [] gobject.Value.Value.dupString (  ) 

Get a copy the contents of a G_TYPE_STRING GValue.

value: a valid GValue of type G_TYPE_STRING Returns: a newly allocated copy of the string content of value

int gobject.Value.Value.fitsPointer (  ) 

Determines if value will fit inside the size of a pointer value.

This is an internal function introduced mainly for C marshallers. value: An initialized GValue structure. Returns: TRUE if value will fit inside a pointer value.

int gobject.Value.Value.getBoolean (  ) 

Get the contents of a G_TYPE_BOOLEAN GValue.

value: a valid GValue of type G_TYPE_BOOLEAN Returns: boolean contents of value

void* gobject.Value.Value.getBoxed (  ) 

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

char gobject.Value.Value.getChar (  ) 

Get the contents of a G_TYPE_CHAR GValue.

value: a valid GValue of type G_TYPE_CHAR Returns: character contents of value

double gobject.Value.Value.getDouble (  ) 

Get the contents of a G_TYPE_DOUBLE GValue.

value: a valid GValue of type G_TYPE_DOUBLE Returns: double contents of value

int gobject.Value.Value.getEnum (  ) 

Get the contents of a G_TYPE_ENUM GValue.

value: a valid GValue whose type is derived from G_TYPE_ENUM Returns: enum contents of value

uint gobject.Value.Value.getFlags (  ) 

Get the contents of a G_TYPE_FLAGS GValue.

value: a valid GValue whose type is derived from G_TYPE_FLAGS Returns: flags contents of value

float gobject.Value.Value.getFloat (  ) 

Get the contents of a G_TYPE_FLOAT GValue.

value: a valid GValue of type G_TYPE_FLOAT Returns: float contents of value

GType gobject.Value.Value.getGtype (  ) 

Get the contents of a G_TYPE_GTYPE GValue.

value: a valid GValue of type G_TYPE_GTYPE Returns: the GType stored in value Since 2.12

int gobject.Value.Value.getInt (  ) 

Get the contents of a G_TYPE_INT GValue.

value: a valid GValue of type G_TYPE_INT Returns: integer contents of value

long gobject.Value.Value.getInt64 (  ) 

Get the contents of a G_TYPE_INT64 GValue.

value: a valid GValue of type G_TYPE_INT64 Returns: 64bit integer contents of value

int gobject.Value.Value.getLong (  ) 

Get the contents of a G_TYPE_LONG GValue.

value: a valid GValue of type G_TYPE_LONG Returns: long integer contents of value

void* gobject.Value.Value.getObject (  ) 

Get the contents of a G_TYPE_OBJECT derived GValue.

value: a valid GValue of G_TYPE_OBJECT derived type Returns: object contents of value

ParamSpec gobject.Value.Value.getParam (  ) 

Get the contents of a G_TYPE_PARAM GValue.

value: a valid GValue whose type is derived from G_TYPE_PARAM Returns: GParamSpec content of value

void* gobject.Value.Value.getPointer (  ) 

Get the contents of a pointer GValue.

value: a valid GValue of G_TYPE_POINTER Returns: pointer contents of value

char [] gobject.Value.Value.getString (  ) 

Get the contents of a G_TYPE_STRING GValue.

value: a valid GValue of type G_TYPE_STRING Returns: string content of value

void* gobject.Value.Value.getStruct (  )  [protected]

the main Gtk struct as a void*

char gobject.Value.Value.getUchar (  ) 

Get the contents of a G_TYPE_UCHAR GValue.

value: a valid GValue of type G_TYPE_UCHAR Returns: unsigned character contents of value

uint gobject.Value.Value.getUint (  ) 

Get the contents of a G_TYPE_UINT GValue.

value: a valid GValue of type G_TYPE_UINT Returns: unsigned integer contents of value

ulong gobject.Value.Value.getUint64 (  ) 

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

uint gobject.Value.Value.getUlong (  ) 

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

GValue* gobject.Value.Value.getValueStruct (  ) 

static ParamSpec gobject.Value.Value.gParamSpecBoolean ( char[]  name,
char[]  nick,
char[]  blurb,
int  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecBoolean instance specifying a G_TYPE_BOOLEAN property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecBoxed ( char[]  name,
char[]  nick,
char[]  blurb,
GType  boxedType,
GParamFlags  flags 
) [static]

Creates a new GParamSpecBoxed instance specifying a G_TYPE_BOXED derived property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified boxed_type: G_TYPE_BOXED derived type of this property flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecChar ( char[]  name,
char[]  nick,
char[]  blurb,
byte  minimum,
byte  maximum,
byte  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecChar instance specifying a G_TYPE_CHAR property.

name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecDouble ( char[]  name,
char[]  nick,
char[]  blurb,
double  minimum,
double  maximum,
double  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecDouble instance specifying a G_TYPE_DOUBLE property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecEnum ( char[]  name,
char[]  nick,
char[]  blurb,
GType  enumType,
int  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecEnum instance specifying a G_TYPE_ENUM property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified enum_type: a GType derived from G_TYPE_ENUM default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecFlags ( char[]  name,
char[]  nick,
char[]  blurb,
GType  flagsType,
uint  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecEnum instance specifying a G_TYPE_FLAGS property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified flags_type: a GType derived from G_TYPE_FLAGS default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecFloat ( char[]  name,
char[]  nick,
char[]  blurb,
float  minimum,
float  maximum,
float  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecFloat instance specifying a G_TYPE_FLOAT property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecGtype ( char[]  name,
char[]  nick,
char[]  blurb,
GType  isAType,
GParamFlags  flags 
) [static]

Creates a new GParamSpecGType instance specifying a G_TYPE_GTYPE property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified is_a_type: a GType whose subtypes are allowed as values of the property (use G_TYPE_NONE for any type) flags: flags for the property specified Returns: a newly created parameter specification Since 2.10

static ParamSpec gobject.Value.Value.gParamSpecInt ( char[]  name,
char[]  nick,
char[]  blurb,
int  minimum,
int  maximum,
int  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecInt instance specifying a G_TYPE_INT property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecInt64 ( char[]  name,
char[]  nick,
char[]  blurb,
long  minimum,
long  maximum,
long  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecInt64 instance specifying a G_TYPE_INT64 property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecLong ( char[]  name,
char[]  nick,
char[]  blurb,
int  minimum,
int  maximum,
int  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecLong instance specifying a G_TYPE_LONG property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecObject ( char[]  name,
char[]  nick,
char[]  blurb,
GType  objectType,
GParamFlags  flags 
) [static]

Creates a new GParamSpecBoxed instance specifying a G_TYPE_OBJECT derived property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified object_type: G_TYPE_OBJECT derived type of this property flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecOverride ( char[]  name,
ParamSpec  overridden 
) [static]

Creates a new property of type GParamSpecOverride.

This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject. name: the name of the property. overridden: The property that is being overridden Returns: the newly created GParamSpec Since 2.4

static ParamSpec gobject.Value.Value.gParamSpecParam ( char[]  name,
char[]  nick,
char[]  blurb,
GType  paramType,
GParamFlags  flags 
) [static]

Creates a new GParamSpecParam instance specifying a G_TYPE_PARAM property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified param_type: a GType derived from G_TYPE_PARAM flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecPointer ( char[]  name,
char[]  nick,
char[]  blurb,
GParamFlags  flags 
) [static]

Creates a new GParamSpecPoiner instance specifying a pointer property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecString ( char[]  name,
char[]  nick,
char[]  blurb,
char[]  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecString instance.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecUchar ( char[]  name,
char[]  nick,
char[]  blurb,
byte  minimum,
byte  maximum,
byte  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecUChar instance specifying a G_TYPE_UCHAR property.

name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecUint ( char[]  name,
char[]  nick,
char[]  blurb,
uint  minimum,
uint  maximum,
uint  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecUInt instance specifying a G_TYPE_UINT property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecUint64 ( char[]  name,
char[]  nick,
char[]  blurb,
ulong  minimum,
ulong  maximum,
ulong  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecUInt64 instance specifying a G_TYPE_UINT64 property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecUlong ( char[]  name,
char[]  nick,
char[]  blurb,
uint  minimum,
uint  maximum,
uint  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecULong instance specifying a G_TYPE_ULONG property.

See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified minimum: minimum value for the property specified maximum: maximum value for the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecUnichar ( char[]  name,
char[]  nick,
char[]  blurb,
gunichar  defaultValue,
GParamFlags  flags 
) [static]

Creates a new GParamSpecUnichar instance specifying a G_TYPE_UINT property.

GValue structures for this property can be accessed with g_value_set_uint() and g_value_get_uint(). See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified default_value: default value for the property specified flags: flags for the property specified Returns: a newly created parameter specification

static ParamSpec gobject.Value.Value.gParamSpecValueArray ( char[]  name,
char[]  nick,
char[]  blurb,
ParamSpec  elementSpec,
GParamFlags  flags 
) [static]

Creates a new GParamSpecValueArray instance specifying a G_TYPE_VALUE_ARRAY property.

G_TYPE_VALUE_ARRAY is a G_TYPE_BOXED type, as such, GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed(). See g_param_spec_internal() for details on property names. name: canonical name of the property specified nick: nick name for the property specified blurb: description of the property specified element_spec: a GParamSpec describing the elements contained in arrays of this property, may be NULL flags: flags for the property specified Returns: a newly created parameter specification

char [] gobject.Value.Value.gStrdupValueContents (  ) 

Return a newly allocated string, which describes the contents of a GValue.

The main purpose of this function is to describe GValue contents for debugging output, the way in which the contents are described may change between different GLib versions. value: GValue which contents are to be described. Returns: Newly allocated string. See Also The fundamental types which all support GValue operations and thus can be used as a type initializer for g_value_init() are defined by a separate interface. See the Standard Values API for details.

Value gobject.Value.Value.init ( GType  gType  ) 

Initializes value with the default value of type.

value: A zero-filled (uninitialized) GValue structure. g_type: Type the GValue should hold values of. Returns: the GValue structure that has been passed in

void* gobject.Value.Value.peekPointer (  ) 

Return the value contents as pointer.

This function asserts that g_value_fits_pointer() returned TRUE for the passed in value. This is an internal function introduced mainly for C marshallers. value: An initialized GValue structure. Returns: TRUE if value will fit inside a pointer value.

static void gobject.Value.Value.registerTransformFunc ( GType  srcType,
GType  destType,
GValueTransform  transformFunc 
) [static]

Registers a value transformation function for use in g_value_transform().

A previously registered transformation function for src_type and dest_type will be replaced. src_type: Source type. dest_type: Target type. transform_func: a function which transforms values of type src_type into value of type dest_type

Value gobject.Value.Value.reset (  ) 

Clears the current value in value and resets it to the default value (as if the value had just been initialized).

value: An initialized GValue structure. Returns: the GValue structure that has been passed in

void gobject.Value.Value.setBoolean ( int  vBoolean  ) 

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

void gobject.Value.Value.setBoxed ( void *  vBoxed  ) 

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

void gobject.Value.Value.setBoxedTakeOwnership ( void *  vBoxed  ) 

Warning g_value_set_boxed_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.

Use g_value_take_boxed() instead. This is an internal function introduced mainly for C marshallers. value: a valid GValue of G_TYPE_BOXED derived type v_boxed: duplicated unowned boxed value to be set

void gobject.Value.Value.setChar ( char  vChar  ) 

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

void gobject.Value.Value.setDouble ( double  vDouble  ) 

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

void gobject.Value.Value.setEnum ( int  vEnum  ) 

Set the contents of a G_TYPE_ENUM GValue to v_enum.

value: a valid GValue whose type is derived from G_TYPE_ENUM v_enum: enum value to be set

void gobject.Value.Value.setFlags ( uint  vFlags  ) 

Set the contents of a G_TYPE_FLAGS GValue to v_flags.

value: a valid GValue whose type is derived from G_TYPE_FLAGS v_flags: flags value to be set

void gobject.Value.Value.setFloat ( float  vFloat  ) 

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

void gobject.Value.Value.setGtype ( GType  vGtype  ) 

Set the contents of a G_TYPE_GTYPE GValue to v_gtype.

value: a valid GValue of type G_TYPE_GTYPE v_gtype: GType to be set Since 2.12 See Also GParamSpec, GValue, g_object_class_install_property().

void gobject.Value.Value.setInstance ( void *  instanc  ) 

Sets value from an instantiatable type via the value_table's collect_value() function.

value: An initialized GValue structure. instance: the instance

void gobject.Value.Value.setInt ( int  vInt  ) 

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

void gobject.Value.Value.setInt64 ( long  vInt64  ) 

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

void gobject.Value.Value.setLong ( int  vLong  ) 

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

void gobject.Value.Value.setObject ( void *  vObject  ) 

Set the contents of a G_TYPE_OBJECT derived GValue to v_object.

value: a valid GValue of G_TYPE_OBJECT derived type v_object: object value to be set

void gobject.Value.Value.setObjectTakeOwnership ( void *  vObject  ) 

Warning g_value_set_object_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.

Use g_value_take_object() instead. This is an internal function introduced mainly for C marshallers. value: a valid GValue of G_TYPE_OBJECT derived type v_object: object value to be set

void gobject.Value.Value.setParam ( ParamSpec  param  ) 

Set the contents of a G_TYPE_PARAM GValue to param.

value: a valid GValue of type G_TYPE_PARAM param: the GParamSpec to be set

void gobject.Value.Value.setParamTakeOwnership ( ParamSpec  param  ) 

Warning g_value_set_param_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.

Use g_value_take_param() instead. This is an internal function introduced mainly for C marshallers. value: a valid GValue of type G_TYPE_PARAM param: the GParamSpec to be set

void gobject.Value.Value.setPointer ( void *  vPointer  ) 

Set the contents of a pointer GValue to v_pointer.

value: a valid GValue of G_TYPE_POINTER v_pointer: pointer value to be set

void gobject.Value.Value.setStaticBoxed ( void *  vBoxed  ) 

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

void gobject.Value.Value.setStaticString ( char[]  vString  ) 

Set the contents of a G_TYPE_STRING GValue to v_string.

The string is assumed to be static, and is thus not duplicated when setting the GValue. value: a valid GValue of type G_TYPE_STRING v_string: static string to be set

void gobject.Value.Value.setString ( char[]  vString  ) 

Set the contents of a G_TYPE_STRING GValue to v_string.

value: a valid GValue of type G_TYPE_STRING v_string: string to be set

void gobject.Value.Value.setStringTakeOwnership ( char[]  vString  ) 

Warning g_value_set_string_take_ownership has been deprecated since version 2.4 and should not be used in newly-written code.

Use g_value_take_string() instead. This is an internal function introduced mainly for C marshallers. value: a valid GValue of type G_TYPE_STRING v_string: duplicated unowned string to be set

void gobject.Value.Value.setUchar ( char  vUchar  ) 

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

void gobject.Value.Value.setUint ( uint  vUint  ) 

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

void gobject.Value.Value.setUint64 ( ulong  vUint64  ) 

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

void gobject.Value.Value.setUlong ( uint  vUlong  ) 

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

void gobject.Value.Value.takeBoxed ( void *  vBoxed  ) 

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

value: a valid GValue of G_TYPE_BOXED derived type v_boxed: duplicated unowned boxed value to be set Since 2.4

void gobject.Value.Value.takeObject ( void *  vObject  ) 

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.

value: a valid GValue of G_TYPE_OBJECT derived type v_object: object value to be set Since 2.4

void gobject.Value.Value.takeParam ( ParamSpec  param  ) 

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

value: a valid GValue of type G_TYPE_PARAM param: the GParamSpec to be set Since 2.4

void gobject.Value.Value.takeString ( char[]  vString  ) 

Sets the contents of a G_TYPE_STRING GValue to v_string.

value: a valid GValue of type G_TYPE_STRING v_string: duplicated unowned string to be set Since 2.4

int gobject.Value.Value.transform ( Value  destValue  ) 

Tries to cast the contents of src_value into a type appropriate to store in dest_value, e.g.

to transform a G_TYPE_INT value into a G_TYPE_FLOAT value. Performing transformations between value types might incur precision lossage. Especially transformations into strings might reveal seemingly arbitrary results and shouldn't be relied upon for production code (such as rcfile value or object property serialization). src_value: Source value. dest_value: Target value. Returns: Whether a transformation rule was found and could be applied. Upon failing transformations, dest_value is left untouched.

static int gobject.Value.Value.typeCompatible ( GType  srcType,
GType  destType 
) [static]

Returns whether a GValue of type src_type can be copied into a GValue of type dest_type.

src_type: source type to be copied. dest_type: destination type for copying. Returns: TRUE if g_value_copy() is possible with src_type and dest_type.

static int gobject.Value.Value.typeTransformable ( GType  srcType,
GType  destType 
) [static]

Check whether g_value_transform() is able to transform values of type src_type into values of type dest_type.

src_type: Source type. dest_type: Target type. Returns: TRUE if the transformation is possible, FALSE otherwise.

void gobject.Value.Value.unset (  ) 

Clears the current value in value and "unsets" the type, this releases all resources associated with this GValue.

An unset value is the same as an uninitialized (zero-filled) GValue structure. value: An initialized GValue structure.


Member Data Documentation

GValue* gobject.Value.Value.gValue [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo