Parameter Specifications

Name

Parameter Specifications -- 

Synopsis


#include <gobject.h>


struct      GParamSpec;
struct      GParamSpecClass;
#define     G_PARAM_SPEC_TYPE               (pspec)
#define     G_PARAM_SPEC_TYPE_NAME          (pspec)
#define     G_PARAM_SPEC                    (pspec)
#define     G_IS_PARAM_SPEC                 (pspec)
#define     G_PARAM_SPEC_GET_CLASS          (pspec)
#define     G_IS_PARAM_VALUE                (pspec, value)
#define     G_PARAM_SPEC_VALUE_TYPE         (pspec)
#define     G_TYPE_IS_PARAM                 (type)
enum        GParamFlags;
GParamSpec* g_param_spec_ref                (GParamSpec *pspec);
void        g_param_spec_unref              (GParamSpec *pspec);
gpointer    g_param_spec_get_qdata          (GParamSpec *pspec,
                                             GQuark quark);
void        g_param_spec_set_qdata          (GParamSpec *pspec,
                                             GQuark quark,
                                             gpointer data);
void        g_param_spec_set_qdata_full     (GParamSpec *pspec,
                                             GQuark quark,
                                             gpointer data,
                                             GDestroyNotify destroy);
gpointer    g_param_spec_steal_qdata        (GParamSpec *pspec,
                                             GQuark quark);
void        g_param_value_set_default       (GParamSpec *pspec,
                                             GValue *value);
gboolean    g_param_value_defaults          (GParamSpec *pspec,
                                             GValue *value);
gboolean    g_param_value_validate          (GParamSpec *pspec,
                                             GValue *value);
gint        g_param_values_cmp              (GParamSpec *pspec,
                                             const GValue *value1,
                                             const GValue *value2);
gpointer    g_param_spec_internal           (GType param_type,
                                             const gchar *name,
                                             const gchar *nick,
                                             const gchar *blurb,
                                             GParamFlags flags);
GHashTable* g_param_spec_hash_table_new     (void);
void        g_param_spec_hash_table_insert  (GHashTable *hash_table,
                                             GParamSpec *pspec,
                                             GType owner_type);
void        g_param_spec_hash_table_remove  (GHashTable *hash_table,
                                             GParamSpec *pspec);
GParamSpec* g_param_spec_hash_table_lookup  (GHashTable *hash_table,
                                             const gchar *param_name,
                                             GType owner_type,
                                             gboolean try_ancestors,
                                             const gchar **trailer);

Description

Details

struct GParamSpec

struct GParamSpec
{
  GTypeInstance  g_instance;

  gchar         *name;
  gchar         *nick;
  gchar         *blurb;
  GParamFlags    flags;

  /*< private >*/
  GType		 owner_type;
  GData		*qdata;
  guint          ref_count;
};


struct GParamSpecClass

struct GParamSpecClass;


G_PARAM_SPEC_TYPE()

#define G_PARAM_SPEC_TYPE(pspec)	(G_TYPE_FROM_INSTANCE (pspec))

pspec : 


G_PARAM_SPEC_TYPE_NAME()

#define G_PARAM_SPEC_TYPE_NAME(pspec)	(g_type_name (G_PARAM_SPEC_TYPE (pspec)))

pspec : 


G_PARAM_SPEC()

#define G_PARAM_SPEC(pspec)		(G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))

pspec : 


G_IS_PARAM_SPEC()

#define G_IS_PARAM_SPEC(pspec)		(G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))

pspec : 


G_PARAM_SPEC_GET_CLASS()

#define G_PARAM_SPEC_GET_CLASS(pspec)	(G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))

pspec : 


G_IS_PARAM_VALUE()

#define	G_IS_PARAM_VALUE(pspec, value)	(g_type_is_a (G_VALUE_TYPE (value), G_PARAM_SPEC_VALUE_TYPE (pspec))) /* FIXME */

pspec : 
value : 


G_PARAM_SPEC_VALUE_TYPE()

#define	G_PARAM_SPEC_VALUE_TYPE(pspec)	(G_PARAM_SPEC_GET_CLASS (pspec)->value_type)

pspec : 


G_TYPE_IS_PARAM()

#define     G_TYPE_IS_PARAM(type)

type : 


enum GParamFlags

typedef enum
{
  G_PARAM_READABLE            = 1 << 0,
  G_PARAM_WRITABLE            = 1 << 1,
  G_PARAM_MASK                = 0x000f,
  /* bits in the range 0xfff0 are reserved for 3rd party usage */
  G_PARAM_USER_MASK           = 0xfff0
} GParamFlags;


g_param_spec_ref ()

GParamSpec* g_param_spec_ref                (GParamSpec *pspec);

pspec : 
Returns : 


g_param_spec_unref ()

void        g_param_spec_unref              (GParamSpec *pspec);

pspec : 


g_param_spec_get_qdata ()

gpointer    g_param_spec_get_qdata          (GParamSpec *pspec,
                                             GQuark quark);

pspec : 
quark : 
Returns : 


g_param_spec_set_qdata ()

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

pspec : 
quark : 
data : 


g_param_spec_set_qdata_full ()

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

pspec : 
quark : 
data : 
destroy : 


g_param_spec_steal_qdata ()

gpointer    g_param_spec_steal_qdata        (GParamSpec *pspec,
                                             GQuark quark);

pspec : 
quark : 
Returns : 


g_param_value_set_default ()

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

pspec : 
value : 


g_param_value_defaults ()

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

pspec : 
value : 
Returns : 


g_param_value_validate ()

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

pspec : 
value : 
Returns : 


g_param_values_cmp ()

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

pspec : 
value1 : 
value2 : 
Returns : 


g_param_spec_internal ()

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

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


g_param_spec_hash_table_new ()

GHashTable* g_param_spec_hash_table_new     (void);

Returns : 


g_param_spec_hash_table_insert ()

void        g_param_spec_hash_table_insert  (GHashTable *hash_table,
                                             GParamSpec *pspec,
                                             GType owner_type);

hash_table : 
pspec : 
owner_type : 


g_param_spec_hash_table_remove ()

void        g_param_spec_hash_table_remove  (GHashTable *hash_table,
                                             GParamSpec *pspec);

hash_table : 
pspec : 


g_param_spec_hash_table_lookup ()

GParamSpec* g_param_spec_hash_table_lookup  (GHashTable *hash_table,
                                             const gchar *param_name,
                                             GType owner_type,
                                             gboolean try_ancestors,
                                             const gchar **trailer);

hash_table : 
param_name : 
owner_type : 
try_ancestors : 
trailer : 
Returns :