luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-27 19:38:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Migrating docs.

Browse Source 
* docs/reference/gobject/tmpl/generic_values.sgml:
	* gobject/gboxed.h:
	* gobject/gtype.h:
	* gobject/gvalue.c:
	* gobject/gvalue.h:
	* gobject/gvaluetypes.c:
	  Migrating docs.


svn path=/trunk/; revision=7071
This commit is contained in:
Stefan Kost
2008-06-21 12:45:49 +00:00
parent 2ff70abe68
commit 0b9bf79ec2
7 changed files with 237 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
gobject/gvalue.h
View File

@@ -30,16 +30,81 @@
G_BEGIN_DECLS
/* --- type macros --- */
/**
* G_TYPE_IS_VALUE:
* @type: A #GType value.
*
* Checks whether the passed in type ID can be used for g_value_init().
* That is, this macro checks whether this type provides an implementation
* of the #GTypeValueTable functions required for a type to create a #GValue of.
*
* Returns: Whether @type is suitable as a #GValue type.
*/
#define G_TYPE_IS_VALUE(type) (g_type_check_is_value_type (type))
/**
* G_IS_VALUE:
* @value: A #GValue structure.
*
* Checks if @value is a valid and initialized #GValue structure.
*
* Returns: %TRUE on success.
*/
#define G_IS_VALUE(value) (G_TYPE_CHECK_VALUE (value))
/**
* G_VALUE_TYPE:
* @value: A #GValue structure.
*
* Get the type identifier of @value.
*
* Returns: the #GType.
*/
#define G_VALUE_TYPE(value) (((GValue*) (value))->g_type)
/**
* G_VALUE_TYPE_NAME:
* @value: A #GValue structure.
*
* Gets the the type name of @value.
*
* Returns: the type name.
*/
#define G_VALUE_TYPE_NAME(value) (g_type_name (G_VALUE_TYPE (value)))
/**
* G_VALUE_HOLDS:
* @value: A #GValue structure.
* @type: A #GType value.
*
* Checks if @value holds (or contains) a value of @type.
* This macro will also check for @value != %NULL and issue a
* warning if the check fails.
*
* Returns: %TRUE if @value holds the @type.
*/
#define G_VALUE_HOLDS(value,type) (G_TYPE_CHECK_VALUE_TYPE ((value), (type)))
/* --- typedefs & structures --- */
/**
* GValueTransform:
* @src_value: Source value.
* @dest_value: Target value.
*
* The type of value transformation functions which can be registered with
* g_value_register_transform_func().
*/
typedef void (*GValueTransform) (const GValue *src_value,
GValue *dest_value);
/**
* GValue:
*
* An opaque structure used to hold different types of values.
* The data within the structure has protected scope: it is accessible only
* to functions within a #GTypeValueTable structure, or implementations of
* the g_value_*() API. That is, code portions which implement new fundamental
* types.
* #GValue users can not make any assumptions about how data is stored
* within the 2 element @data union, and the @g_type member should
* only be accessed through the G_VALUE_TYPE() macro.
*/
struct _GValue
{
/*< private >*/