gparam.h File Reference

API published in:
API deprecated in:

#include <_ansi.h>
#include <gobject/gvalue.h>


Data Structures
struct	_GParamSpec
struct	_GParamSpecClass
struct	_GParameter
struct	_GParamSpecTypeInfo
Defines
#define	G_TYPE_IS_PARAM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)
#define	G_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))
#define	G_IS_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))
#define	G_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_CAST ((pclass), G_TYPE_PARAM, GParamSpecClass))
#define	G_IS_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_TYPE ((pclass), G_TYPE_PARAM))
#define	G_PARAM_SPEC_GET_CLASS(pspec) (G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))
#define	G_PARAM_SPEC_TYPE(pspec) (G_TYPE_FROM_INSTANCE (pspec))
#define	G_PARAM_SPEC_TYPE_NAME(pspec) (g_type_name (G_PARAM_SPEC_TYPE (pspec)))
#define	G_PARAM_SPEC_VALUE_TYPE(pspec) (G_PARAM_SPEC (pspec)->value_type)
#define	G_VALUE_HOLDS_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))
#define	G_PARAM_READWRITE (G_PARAM_READABLE \| G_PARAM_WRITABLE)
#define	G_PARAM_MASK (0x000000ff)
#define	G_PARAM_USER_SHIFT (8)
Typedefs
typedef _GParamSpec	GParamSpec
typedef _GParamSpecClass	GParamSpecClass
typedef _GParameter	GParameter
typedef _GParamSpecPool	GParamSpecPool
typedef _GParamSpecTypeInfo	GParamSpecTypeInfo
Enumerations
enum	GParamFlags { G_PARAM_READABLE = 1 << 0, G_PARAM_WRITABLE = 1 << 1, G_PARAM_CONSTRUCT = 1 << 2, G_PARAM_CONSTRUCT_ONLY = 1 << 3, G_PARAM_LAX_VALIDATION = 1 << 4, G_PARAM_STATIC_NAME = 1 << 5, G_PARAM_PRIVATE = G_PARAM_STATIC_NAME, G_PARAM_STATIC_NICK = 1 << 6, G_PARAM_STATIC_BLURB = 1 << 7 }
Functions
IMPORT_C GParamSpec *	g_param_spec_ref (GParamSpec *pspec)
IMPORT_C void	g_param_spec_unref (GParamSpec *pspec)
IMPORT_C void	g_param_spec_sink (GParamSpec *pspec)
IMPORT_C GParamSpec *	g_param_spec_ref_sink (GParamSpec *pspec)
IMPORT_C gpointer	g_param_spec_get_qdata (GParamSpec *pspec, GQuark quark)
IMPORT_C void	g_param_spec_set_qdata (GParamSpec *pspec, GQuark quark, gpointer data)
IMPORT_C void	g_param_spec_set_qdata_full (GParamSpec *pspec, GQuark quark, gpointer data, GDestroyNotify destroy)
IMPORT_C gpointer	g_param_spec_steal_qdata (GParamSpec *pspec, GQuark quark)
IMPORT_C GParamSpec *	g_param_spec_get_redirect_target (GParamSpec *pspec)
IMPORT_C void	g_param_value_set_default (GParamSpec pspec, GValue value)
IMPORT_C gboolean	g_param_value_defaults (GParamSpec pspec, GValue value)
IMPORT_C gboolean	g_param_value_validate (GParamSpec pspec, GValue value)
IMPORT_C gboolean	g_param_value_convert (GParamSpec pspec, const GValue src_value, GValue *dest_value, gboolean strict_validation)
IMPORT_C gint	g_param_values_cmp (GParamSpec pspec, const GValue value1, const GValue *value2)
IMPORT_C G_CONST_RETURN gchar *	g_param_spec_get_name (GParamSpec *pspec)
IMPORT_C G_CONST_RETURN gchar *	g_param_spec_get_nick (GParamSpec *pspec)
IMPORT_C G_CONST_RETURN gchar *	g_param_spec_get_blurb (GParamSpec *pspec)
IMPORT_C void	g_value_set_param (GValue value, GParamSpec param)
IMPORT_C GParamSpec *	g_value_get_param (const GValue *value)
IMPORT_C GParamSpec *	g_value_dup_param (const GValue *value)
IMPORT_C void	g_value_take_param (GValue value, GParamSpec param)
IMPORT_C void	g_value_set_param_take_ownership (GValue value, GParamSpec param)
IMPORT_C GType	g_param_type_register_static (const gchar name, const GParamSpecTypeInfo pspec_info)
GType	_g_param_type_register_static_constant (const gchar name, const GParamSpecTypeInfo pspec_info, GType opt_type)
IMPORT_C gpointer	g_param_spec_internal (GType param_type, const gchar name, const gchar nick, const gchar *blurb, GParamFlags flags)
IMPORT_C GParamSpecPool *	g_param_spec_pool_new (gboolean type_prefixing)
IMPORT_C void	g_param_spec_pool_insert (GParamSpecPool pool, GParamSpec pspec, GType owner_type)
IMPORT_C void	g_param_spec_pool_remove (GParamSpecPool pool, GParamSpec pspec)
IMPORT_C GParamSpec *	g_param_spec_pool_lookup (GParamSpecPool pool, const gchar param_name, GType owner_type, gboolean walk_ancestors)
IMPORT_C GList *	g_param_spec_pool_list_owned (GParamSpecPool *pool, GType owner_type)
IMPORT_C GParamSpec **	g_param_spec_pool_list (GParamSpecPool pool, GType owner_type, guint n_pspecs_p)

Define Documentation

#define G_IS_PARAM_SPEC

(

pspec

)

(G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))

#define G_IS_PARAM_SPEC_CLASS

(

pclass

)

(G_TYPE_CHECK_CLASS_TYPE ((pclass), G_TYPE_PARAM))

#define G_PARAM_MASK (0x000000ff)

#define G_PARAM_READWRITE (G_PARAM_READABLE | G_PARAM_WRITABLE)

(G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))

#define G_PARAM_SPEC_CLASS

(

pclass

)

(G_TYPE_CHECK_CLASS_CAST ((pclass), G_TYPE_PARAM, GParamSpecClass))

#define G_PARAM_SPEC_GET_CLASS

(

pspec

)

(G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))

#define G_PARAM_SPEC_TYPE

(

pspec

)

(G_TYPE_FROM_INSTANCE (pspec))

#define G_PARAM_SPEC_TYPE_NAME

(

pspec

)

(g_type_name (G_PARAM_SPEC_TYPE (pspec)))

#define G_PARAM_SPEC_VALUE_TYPE

(

pspec

)

(G_PARAM_SPEC (pspec)->value_type)

#define G_PARAM_USER_SHIFT (8)

#define G_TYPE_IS_PARAM

(

type

)

(G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)

#define G_VALUE_HOLDS_PARAM

(

value

)

(G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))

Typedef Documentation

typedef struct _GParameter GParameter

typedef struct _GParamSpec GParamSpec

typedef struct _GParamSpecClass GParamSpecClass

typedef struct _GParamSpecPool GParamSpecPool

typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo

Enumeration Type Documentation

enum GParamFlags

Enumerator:

G_PARAM_READABLE
G_PARAM_WRITABLE
G_PARAM_CONSTRUCT
G_PARAM_CONSTRUCT_ONLY
G_PARAM_LAX_VALIDATION
G_PARAM_STATIC_NAME
G_PARAM_PRIVATE
G_PARAM_STATIC_NICK
G_PARAM_STATIC_BLURB

Function Documentation

GType _g_param_type_register_static_constant	(	const gchar *	name,
		const GParamSpecTypeInfo *	pspec_info,
		GType	opt_type
	)

IMPORT_C G_CONST_RETURN gchar* g_param_spec_get_blurb

IMPORT_C G_CONST_RETURN gchar* g_param_spec_get_name

IMPORT_C G_CONST_RETURN gchar* g_param_spec_get_nick

IMPORT_C gpointer g_param_spec_get_qdata	(	GParamSpec *	pspec,
		GQuark	quark
	)

IMPORT_C GParamSpec* g_param_spec_get_redirect_target

IMPORT_C gpointer g_param_spec_internal	(	GType	param_type,
		const gchar *	name,
		const gchar *	nick,
		const gchar *	blurb,
		GParamFlags	flags
	)

IMPORT_C void g_param_spec_pool_insert	(	GParamSpecPool *	pool,
		GParamSpec *	pspec,
		GType	owner_type
	)

IMPORT_C GParamSpec** g_param_spec_pool_list	(	GParamSpecPool *	pool,
		GType	owner_type,
		guint *	n_pspecs_p
	)

IMPORT_C GList* g_param_spec_pool_list_owned	(	GParamSpecPool *	pool,
		GType	owner_type
	)

IMPORT_C GParamSpec* g_param_spec_pool_lookup	(	GParamSpecPool *	pool,
		const gchar *	param_name,
		GType	owner_type,
		gboolean	walk_ancestors
	)

IMPORT_C GParamSpecPool* g_param_spec_pool_new

IMPORT_C void g_param_spec_pool_remove	(	GParamSpecPool *	pool,
		GParamSpec *	pspec
	)

IMPORT_C GParamSpec* g_param_spec_ref

IMPORT_C GParamSpec* g_param_spec_ref_sink

IMPORT_C void g_param_spec_set_qdata	(	GParamSpec *	pspec,
		GQuark	quark,
		gpointer	data
	)

IMPORT_C void g_param_spec_set_qdata_full	(	GParamSpec *	pspec,
		GQuark	quark,
		gpointer	data,
		GDestroyNotify	destroy
	)

IMPORT_C void g_param_spec_sink

IMPORT_C gpointer g_param_spec_steal_qdata	(	GParamSpec *	pspec,
		GQuark	quark
	)

IMPORT_C void g_param_spec_unref

IMPORT_C GType g_param_type_register_static	(	const gchar *	name,
		const GParamSpecTypeInfo *	pspec_info
	)

IMPORT_C gboolean g_param_value_convert	(	GParamSpec *	pspec,
		const GValue *	src_value,
		GValue *	dest_value,
		gboolean	strict_validation
	)

IMPORT_C gboolean g_param_value_defaults	(	GParamSpec *	pspec,
		GValue *	value
	)

IMPORT_C void g_param_value_set_default	(	GParamSpec *	pspec,
		GValue *	value
	)

IMPORT_C gboolean g_param_value_validate	(	GParamSpec *	pspec,
		GValue *	value
	)

IMPORT_C gint g_param_values_cmp	(	GParamSpec *	pspec,
		const GValue *	value1,
		const GValue *	value2
	)

IMPORT_C GParamSpec* g_value_dup_param

IMPORT_C GParamSpec* g_value_get_param

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

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

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

gparam.h File Reference

Data Structures

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation