GtkObject

Name

GtkObject —

Synopsis


#include <gtk/gtk.h>


struct      GtkObject;
#define     GTK_OBJECT_TYPE                 (obj)
#define     GTK_OBJECT_SIGNALS              (obj)
#define     GTK_OBJECT_NSIGNALS             (obj)
enum        GtkObjectFlags;
#define     GTK_OBJECT_FLAGS                (obj)
#define     GTK_OBJECT_DESTROYED            (obj)
#define     GTK_OBJECT_FLOATING             (obj)
#define     GTK_OBJECT_CONNECTED            (obj)
#define     GTK_OBJECT_CONSTRUCTED          (obj)
#define     GTK_OBJECT_SET_FLAGS            (obj,flag)
#define     GTK_OBJECT_UNSET_FLAGS          (obj,flag)
enum        GtkArgFlags;
guint       gtk_object_class_user_signal_new
                                            (GtkObjectClass *klass,
                                             const gchar *name,
                                             GtkSignalRunType signal_flags,
                                             GtkSignalMarshaller marshaller,
                                             GtkType return_val,
                                             guint nparams,
                                             ...);
guint       gtk_object_class_user_signal_newv
                                            (GtkObjectClass *klass,
                                             const gchar *name,
                                             GtkSignalRunType signal_flags,
                                             GtkSignalMarshaller marshaller,
                                             GtkType return_val,
                                             guint nparams,
                                             GtkType *params);
GtkObject*  gtk_object_new                  (GtkType type,
                                             const gchar *first_arg_name,
                                             ...);
GtkObject*  gtk_object_newv                 (GtkType object_type,
                                             guint n_args,
                                             GtkArg *args);
void        gtk_object_constructed          (GtkObject *object);
void        gtk_object_default_construct    (GtkObject *object);
void        gtk_object_sink                 (GtkObject *object);
void        gtk_object_ref                  (GtkObject *object);
void        gtk_object_unref                (GtkObject *object);
void        gtk_object_weakref              (GtkObject *object,
                                             GtkDestroyNotify notify,
                                             gpointer data);
void        gtk_object_weakunref            (GtkObject *object,
                                             GtkDestroyNotify notify,
                                             gpointer data);
void        gtk_object_destroy              (GtkObject *object);
void        gtk_object_getv                 (GtkObject *object,
                                             guint n_args,
                                             GtkArg *args);
void        gtk_object_set                  (GtkObject *object,
                                             const gchar *first_arg_name,
                                             ...);
void        gtk_object_setv                 (GtkObject *object,
                                             guint n_args,
                                             GtkArg *args);
GtkArg*     gtk_object_query_args           (GtkType class_type,
                                             guint32 **arg_flags,
                                             guint *n_args);
void        gtk_object_set_data             (GtkObject *object,
                                             const gchar *key,
                                             gpointer data);
void        gtk_object_set_data_full        (GtkObject *object,
                                             const gchar *key,
                                             gpointer data,
                                             GtkDestroyNotify destroy);
void        gtk_object_remove_data          (GtkObject *object,
                                             const gchar *key);
gpointer    gtk_object_get_data             (GtkObject *object,
                                             const gchar *key);
void        gtk_object_remove_no_notify     (GtkObject *object,
                                             const gchar *key);
void        gtk_object_set_user_data        (GtkObject *object,
                                             gpointer data);
gpointer    gtk_object_get_user_data        (GtkObject *object);
void        gtk_object_class_add_signals    (GtkObjectClass *klass,
                                             guint *signals,
                                             guint nsignals);
void        gtk_object_add_arg_type         (const gchar *arg_name,
                                             GtkType arg_type,
                                             guint arg_flags,
                                             guint arg_id);
void        gtk_object_set_data_by_id       (GtkObject *object,
                                             GQuark data_id,
                                             gpointer data);
void        gtk_object_set_data_by_id_full  (GtkObject *object,
                                             GQuark data_id,
                                             gpointer data,
                                             GtkDestroyNotify destroy);
gpointer    gtk_object_get_data_by_id       (GtkObject *object,
                                             GQuark data_id);
void        gtk_object_remove_data_by_id    (GtkObject *object,
                                             GQuark data_id);
void        gtk_object_remove_no_notify_by_id
                                            (GtkObject *object,
                                             GQuark key_id);
#define     gtk_object_data_try_key
#define     gtk_object_data_force_id
void        gtk_object_arg_set              (GtkObject *object,
                                             GtkArg *arg,
                                             GtkArgInfo *info);
void        gtk_object_arg_get              (GtkObject *object,
                                             GtkArg *arg,
                                             GtkArgInfo *info);
gchar*      gtk_object_args_collect         (GtkType object_type,
                                             GSList **arg_list_p,
                                             GSList **info_list_p,
                                             const gchar *first_arg_name,
                                             va_list var_args);
gchar*      gtk_object_arg_get_info         (GtkType object_type,
                                             const gchar *arg_name,
                                             GtkArgInfo **info_p);
void        gtk_trace_referencing           (GtkObject *object,
                                             const gchar *func,
                                             guint dummy,
                                             guint line,
                                             gboolean do_ref);

Object Hierarchy


  GtkObject

Args


  "user_data"            gpointer             : Read / Write
  "signal"               GtkSignalFunc, gpointer : Write
  "signal_after"         GtkSignalFunc, gpointer : Write
  "object_signal"        GtkSignalFunc, gpointer : Write
  "object_signal_after"  GtkSignalFunc, gpointer : Write

Signal Prototypes


"destroy"   void        user_function      (GtkObject *object,
                                            gpointer user_data);

Description

Details

struct GtkObject

struct GtkObject;


GTK_OBJECT_TYPE()

#define GTK_OBJECT_TYPE(obj)		  (GTK_OBJECT (obj)->klass->type)

obj : 


GTK_OBJECT_SIGNALS()

#define GTK_OBJECT_SIGNALS(obj)		  (GTK_OBJECT (obj)->klass->signals)

obj : 


GTK_OBJECT_NSIGNALS()

#define GTK_OBJECT_NSIGNALS(obj)	  (GTK_OBJECT (obj)->klass->nsignals)

obj : 


enum GtkObjectFlags

typedef enum
{
  GTK_DESTROYED		= 1 << 0,
  GTK_FLOATING		= 1 << 1,
  GTK_CONNECTED		= 1 << 2,
  GTK_CONSTRUCTED	= 1 << 3
} GtkObjectFlags;


GTK_OBJECT_FLAGS()

#define GTK_OBJECT_FLAGS(obj)		  (GTK_OBJECT (obj)->flags)

obj : 


GTK_OBJECT_DESTROYED()

#define GTK_OBJECT_DESTROYED(obj)	  ((GTK_OBJECT_FLAGS (obj) & GTK_DESTROYED) != 0)

obj : 


GTK_OBJECT_FLOATING()

#define GTK_OBJECT_FLOATING(obj)	  ((GTK_OBJECT_FLAGS (obj) & GTK_FLOATING) != 0)

obj : 


GTK_OBJECT_CONNECTED()

#define GTK_OBJECT_CONNECTED(obj)	  ((GTK_OBJECT_FLAGS (obj) & GTK_CONNECTED) != 0)

obj : 


GTK_OBJECT_CONSTRUCTED()

#define GTK_OBJECT_CONSTRUCTED(obj)	  ((GTK_OBJECT_FLAGS (obj) & GTK_CONSTRUCTED) != 0)

obj : 


GTK_OBJECT_SET_FLAGS()

#define GTK_OBJECT_SET_FLAGS(obj,flag)	  G_STMT_START{ (GTK_OBJECT_FLAGS (obj) |= (flag)); }G_STMT_END

obj : 
flag : 


GTK_OBJECT_UNSET_FLAGS()

#define GTK_OBJECT_UNSET_FLAGS(obj,flag)  G_STMT_START{ (GTK_OBJECT_FLAGS (obj) &= ~(flag)); }G_STMT_END

obj : 
flag : 


enum GtkArgFlags

typedef enum
{
  GTK_ARG_READABLE	 = 1 << 0,
  GTK_ARG_WRITABLE	 = 1 << 1,
  GTK_ARG_CONSTRUCT	 = 1 << 2,
  GTK_ARG_CONSTRUCT_ONLY = 1 << 3,
  GTK_ARG_CHILD_ARG	 = 1 << 4,
  GTK_ARG_MASK		 = 0x1f,
  
  /* aliases
   */
  GTK_ARG_READWRITE	 = GTK_ARG_READABLE | GTK_ARG_WRITABLE
} GtkArgFlags;


gtk_object_class_user_signal_new ()

guint       gtk_object_class_user_signal_new
                                            (GtkObjectClass *klass,
                                             const gchar *name,
                                             GtkSignalRunType signal_flags,
                                             GtkSignalMarshaller marshaller,
                                             GtkType return_val,
                                             guint nparams,
                                             ...);

klass : 
name : 
signal_flags : 
marshaller : 
return_val : 
nparams : 
... : 
Returns : 


gtk_object_class_user_signal_newv ()

guint       gtk_object_class_user_signal_newv
                                            (GtkObjectClass *klass,
                                             const gchar *name,
                                             GtkSignalRunType signal_flags,
                                             GtkSignalMarshaller marshaller,
                                             GtkType return_val,
                                             guint nparams,
                                             GtkType *params);

klass : 
name : 
signal_flags : 
marshaller : 
return_val : 
nparams : 
params : 
Returns : 


gtk_object_new ()

GtkObject*  gtk_object_new                  (GtkType type,
                                             const gchar *first_arg_name,
                                             ...);

type : 
first_arg_name : 
... : 
Returns : 


gtk_object_newv ()

GtkObject*  gtk_object_newv                 (GtkType object_type,
                                             guint n_args,
                                             GtkArg *args);

object_type : 
n_args : 
args : 
Returns : 


gtk_object_constructed ()

void        gtk_object_constructed          (GtkObject *object);

object : 


gtk_object_default_construct ()

void        gtk_object_default_construct    (GtkObject *object);

object : 


gtk_object_sink ()

void        gtk_object_sink                 (GtkObject *object);

object : 


gtk_object_ref ()

void        gtk_object_ref                  (GtkObject *object);

object : 


gtk_object_unref ()

void        gtk_object_unref                (GtkObject *object);

object : 


gtk_object_weakref ()

void        gtk_object_weakref              (GtkObject *object,
                                             GtkDestroyNotify notify,
                                             gpointer data);

object : 
notify : 
data : 


gtk_object_weakunref ()

void        gtk_object_weakunref            (GtkObject *object,
                                             GtkDestroyNotify notify,
                                             gpointer data);

object : 
notify : 
data : 


gtk_object_destroy ()

void        gtk_object_destroy              (GtkObject *object);

object : 


gtk_object_getv ()

void        gtk_object_getv                 (GtkObject *object,
                                             guint n_args,
                                             GtkArg *args);

object : 
n_args : 
args : 


gtk_object_set ()

void        gtk_object_set                  (GtkObject *object,
                                             const gchar *first_arg_name,
                                             ...);

object : 
first_arg_name : 
... : 


gtk_object_setv ()

void        gtk_object_setv                 (GtkObject *object,
                                             guint n_args,
                                             GtkArg *args);

object : 
n_args : 
args : 


gtk_object_query_args ()

GtkArg*     gtk_object_query_args           (GtkType class_type,
                                             guint32 **arg_flags,
                                             guint *n_args);

class_type : 
arg_flags : 
n_args : 
Returns : 


gtk_object_set_data ()

void        gtk_object_set_data             (GtkObject *object,
                                             const gchar *key,
                                             gpointer data);

object : 
key : 
data : 


gtk_object_set_data_full ()

void        gtk_object_set_data_full        (GtkObject *object,
                                             const gchar *key,
                                             gpointer data,
                                             GtkDestroyNotify destroy);

object : 
key : 
data : 
destroy : 


gtk_object_remove_data ()

void        gtk_object_remove_data          (GtkObject *object,
                                             const gchar *key);

object : 
key : 


gtk_object_get_data ()

gpointer    gtk_object_get_data             (GtkObject *object,
                                             const gchar *key);

object : 
key : 
Returns : 


gtk_object_remove_no_notify ()

void        gtk_object_remove_no_notify     (GtkObject *object,
                                             const gchar *key);

object : 
key : 


gtk_object_set_user_data ()

void        gtk_object_set_user_data        (GtkObject *object,
                                             gpointer data);

object : 
data : 


gtk_object_get_user_data ()

gpointer    gtk_object_get_user_data        (GtkObject *object);

object : 
Returns : 


gtk_object_class_add_signals ()

void        gtk_object_class_add_signals    (GtkObjectClass *klass,
                                             guint *signals,
                                             guint nsignals);

klass : 
signals : 
nsignals : 


gtk_object_add_arg_type ()

void        gtk_object_add_arg_type         (const gchar *arg_name,
                                             GtkType arg_type,
                                             guint arg_flags,
                                             guint arg_id);

arg_name : 
arg_type : 
arg_flags : 
arg_id : 


gtk_object_set_data_by_id ()

void        gtk_object_set_data_by_id       (GtkObject *object,
                                             GQuark data_id,
                                             gpointer data);

object : 
data_id : 
data : 


gtk_object_set_data_by_id_full ()

void        gtk_object_set_data_by_id_full  (GtkObject *object,
                                             GQuark data_id,
                                             gpointer data,
                                             GtkDestroyNotify destroy);

object : 
data_id : 
data : 
destroy : 


gtk_object_get_data_by_id ()

gpointer    gtk_object_get_data_by_id       (GtkObject *object,
                                             GQuark data_id);

object : 
data_id : 
Returns : 


gtk_object_remove_data_by_id ()

void        gtk_object_remove_data_by_id    (GtkObject *object,
                                             GQuark data_id);

object : 
data_id : 


gtk_object_remove_no_notify_by_id ()

void        gtk_object_remove_no_notify_by_id
                                            (GtkObject *object,
                                             GQuark key_id);

object : 
key_id : 


gtk_object_data_try_key

#define	gtk_object_data_try_key	    g_quark_try_string


gtk_object_data_force_id

#define	gtk_object_data_force_id    g_quark_from_string


gtk_object_arg_set ()

void        gtk_object_arg_set              (GtkObject *object,
                                             GtkArg *arg,
                                             GtkArgInfo *info);

object : 
arg : 
info : 


gtk_object_arg_get ()

void        gtk_object_arg_get              (GtkObject *object,
                                             GtkArg *arg,
                                             GtkArgInfo *info);

object : 
arg : 
info : 


gtk_object_args_collect ()

gchar*      gtk_object_args_collect         (GtkType object_type,
                                             GSList **arg_list_p,
                                             GSList **info_list_p,
                                             const gchar *first_arg_name,
                                             va_list var_args);

object_type : 
arg_list_p : 
info_list_p : 
first_arg_name : 
var_args : 
Returns : 


gtk_object_arg_get_info ()

gchar*      gtk_object_arg_get_info         (GtkType object_type,
                                             const gchar *arg_name,
                                             GtkArgInfo **info_p);

object_type : 
arg_name : 
info_p : 
Returns : 


gtk_trace_referencing ()

void        gtk_trace_referencing           (GtkObject *object,
                                             const gchar *func,
                                             guint dummy,
                                             guint line,
                                             gboolean do_ref);

object : 
func : 
dummy : 
line : 
do_ref : 

Args

"user_data" (gpointer : Read / Write)

"signal" (GtkSignalFunc, gpointer : Write)

"signal_after" (GtkSignalFunc, gpointer : Write)

"object_signal" (GtkSignalFunc, gpointer : Write)

"object_signal_after" (GtkSignalFunc, gpointer : Write)

Signals

The "destroy" signal

void        user_function                  (GtkObject *object,
                                            gpointer user_data);

object :the object which received the signal.
user_data :user data set when the signal handler was connected.