midgard_object

midgard_object

Synopsis




#define             MIDGARD_OBJECT_GET_CLASS_BY_NAME    (name)
                    MgdObject;
typedef             midgard_object;
                    MidgardObjectPrivate;
                    MidgardObjectClassPrivate;
typedef             MidgardMetadata;
typedef             MidgardMetadataClass;
typedef             MidgardObject;
void                midgard_get_midgard                 (MgdObject *mobj,
                                                         MidgardConnection *mgd);
MgdObject*          midgard_object_new                  (MidgardConnection *mgd,
                                                         const gchar *name,
                                                         GValue *value);
MgdObject*          midgard_object_new_by_id            (MidgardConnection *mgd,
                                                         const gchar *name,
                                                         gchar *id);
gboolean            midgard_object_get_by_id            (MgdObject *object,
                                                         guint id);
gboolean            midgard_object_update               (MgdObject *object);
gboolean            midgard_object_create               (MgdObject *object);
GObject**           midgard_object_find                 (MgdObject *object,
                                                         MidgardTypeHolder *holder);
gchar*              midgard_object_build_path           (MgdObject *mobj);
gboolean            midgard_object_is_in_parent_tree    (MgdObject *object,
                                                         guint rootid,
                                                         guint id);
gboolean            midgard_object_is_in_tree           (MgdObject *object,
                                                         guint rootid,
                                                         guint id);
gchar*              midgard_object_get_tree             (MgdObject *object,
                                                         GSList *tnodes);
MgdObject*          midgard_object_get_by_old_guid      (MidgardConnection *mgd,
                                                         gchar *guid);
gboolean            midgard_object_get_by_guid          (MgdObject *object,
                                                         const gchar *guid);
gboolean            midgard_object_delete               (MgdObject *object);
gboolean            midgard_object_purge                (MgdObject *object);
MgdObject*          midgard_object_get_parent           (MgdObject *object);
gint                midgard_object_get                  (MgdObject *object);
GObject**           midgard_object_list                 (MgdObject *object,
                                                         MidgardTypeHolder *holder);
GObject**           midgard_object_list_children        (MgdObject *object,
                                                         const gchar *childname,
                                                         MidgardTypeHolder *holder);
GObject**           midgard_object_get_languages        (MgdObject *self,
                                                         MidgardTypeHolder *holder);
gboolean            midgard_object_get_by_path          (MgdObject *self,
                                                         const gchar *path);
const gchar*        midgard_object_parent               (MgdObject *object);
gboolean            midgard_object_undelete             (MidgardConnection *mgd,
                                                         const gchar *guid);
gchar*              midgard_object_export               (MgdObject *self);
gboolean            midgard_import_object               (MidgardConnection *mgd,
                                                         gchar *xml);
gboolean            midgard_object_set_guid             (MgdObject *self,
                                                         const gchar *guid);
void                midgard_object_set_connection       (MgdObject *self,
                                                         MidgardConnection *mgd);

Object Hierarchy


  GObject
   +----midgard_dbobject
         +----midgard_object

Properties


  "action"                   gchararray            : Read / Write
  "guid"                     gchararray            : Read
  "metadata"                 GObject               : Read / Write
  "sitegroup"                guint                 : Read / Write

Signals


  "action-create"                                  : Action
  "action-create-hook"                             : Action
  "action-created"                                 : Action
  "action-delete"                                  : Action
  "action-delete-hook"                             : Action
  "action-deleted"                                 : Action
  "action-export"                                  : Action
  "action-export-hook"                             : Action
  "action-exported"                                : Action
  "action-import"                                  : Action
  "action-import-hook"                             : Action
  "action-imported"                                : Action
  "action-loaded"                                  : Action
  "action-loaded-hook"                             : Action
  "action-update"                                  : Action
  "action-update-hook"                             : Action
  "action-updated"                                 : Action

Description

Details

MIDGARD_OBJECT_GET_CLASS_BY_NAME()

#define MIDGARD_OBJECT_GET_CLASS_BY_NAME(name) ((MidgardObjectClass*) g_type_class_peek(g_type_from_name(name)))

name :

MgdObject

typedef struct {
	GObject parent;
	MidgardDBObjectPrivate *dbpriv;
	MidgardObjectPrivate *priv;	
	MidgardMetadata *metadata;	
} MgdObject;

midgard_object

typedef struct _MgdObject midgard_object;

MidgardObjectPrivate

typedef struct _MidgardObjectPrivate MidgardObjectPrivate;

MidgardObjectClassPrivate

typedef struct _MidgardObjectClassPrivate MidgardObjectClassPrivate;

MidgardMetadata

typedef struct MidgardMetadata MidgardMetadata;

MidgardMetadataClass

typedef struct MidgardMetadataClass MidgardMetadataClass;

MidgardObject

typedef struct _MgdObject MidgardObject;

midgard_get_midgard ()

void                midgard_get_midgard                 (MgdObject *mobj,
                                                         MidgardConnection *mgd);

mobj :
mgd :

midgard_object_new ()

MgdObject*          midgard_object_new                  (MidgardConnection *mgd,
                                                         const gchar *name,
                                                         GValue *value);

mgd :
name :
value :
Returns :

midgard_object_new_by_id ()

MgdObject*          midgard_object_new_by_id            (MidgardConnection *mgd,
                                                         const gchar *name,
                                                         gchar *id);

mgd :
name :
id :
Returns :

midgard_object_get_by_id ()

gboolean            midgard_object_get_by_id            (MgdObject *object,
                                                         guint id);

object :
id :
Returns :

midgard_object_update ()

gboolean            midgard_object_update               (MgdObject *object);

object :
Returns :

midgard_object_create ()

gboolean            midgard_object_create               (MgdObject *object);

object :
Returns :

midgard_object_find ()

GObject**           midgard_object_find                 (MgdObject *object,
                                                         MidgardTypeHolder *holder);

object :
holder :
Returns :

midgard_object_build_path ()

gchar*              midgard_object_build_path           (MgdObject *mobj);

mobj :
Returns :

midgard_object_is_in_parent_tree ()

gboolean            midgard_object_is_in_parent_tree    (MgdObject *object,
                                                         guint rootid,
                                                         guint id);

object :
rootid :
id :
Returns :

midgard_object_is_in_tree ()

gboolean            midgard_object_is_in_tree           (MgdObject *object,
                                                         guint rootid,
                                                         guint id);

object :
rootid :
id :
Returns :

midgard_object_get_tree ()

gchar*              midgard_object_get_tree             (MgdObject *object,
                                                         GSList *tnodes);

object :
tnodes :
Returns :

midgard_object_get_by_old_guid ()

MgdObject*          midgard_object_get_by_old_guid      (MidgardConnection *mgd,
                                                         gchar *guid);

mgd :
guid :
Returns :

midgard_object_get_by_guid ()

gboolean            midgard_object_get_by_guid          (MgdObject *object,
                                                         const gchar *guid);

object :
guid :
Returns :

midgard_object_delete ()

gboolean            midgard_object_delete               (MgdObject *object);

object :
Returns :

midgard_object_purge ()

gboolean            midgard_object_purge                (MgdObject *object);

object :
Returns :

midgard_object_get_parent ()

MgdObject*          midgard_object_get_parent           (MgdObject *object);

object :
Returns :

midgard_object_get ()

gint                midgard_object_get                  (MgdObject *object);

object :
Returns :

midgard_object_list ()

GObject**           midgard_object_list                 (MgdObject *object,
                                                         MidgardTypeHolder *holder);

object :
holder :
Returns :

midgard_object_list_children ()

GObject**           midgard_object_list_children        (MgdObject *object,
                                                         const gchar *childname,
                                                         MidgardTypeHolder *holder);

object :
childname :
holder :
Returns :

midgard_object_get_languages ()

GObject**           midgard_object_get_languages        (MgdObject *self,
                                                         MidgardTypeHolder *holder);

self :
holder :
Returns :

midgard_object_get_by_path ()

gboolean            midgard_object_get_by_path          (MgdObject *self,
                                                         const gchar *path);

self :
path :
Returns :

midgard_object_parent ()

const gchar*        midgard_object_parent               (MgdObject *object);

object :
Returns :

midgard_object_undelete ()

gboolean            midgard_object_undelete             (MidgardConnection *mgd,
                                                         const gchar *guid);

mgd :
guid :
Returns :

midgard_object_export ()

gchar*              midgard_object_export               (MgdObject *self);

self :
Returns :

midgard_import_object ()

gboolean            midgard_import_object               (MidgardConnection *mgd,
                                                         gchar *xml);

mgd :
xml :
Returns :

midgard_object_set_guid ()

gboolean            midgard_object_set_guid             (MgdObject *self,
                                                         const gchar *guid);

self :
guid :
Returns :

midgard_object_set_connection ()

void                midgard_object_set_connection       (MgdObject *self,
                                                         MidgardConnection *mgd);

self :
mgd :

Property Details

The "action" property

  "action"                   gchararray            : Read / Write

What was done with object.

Default value: " "

The "guid" property

  "guid"                     gchararray            : Read

GUID.

Default value: " "

The "metadata" property

  "metadata"                 GObject               : Read / Write

Property with Midgard metadata object.

The "sitegroup" property

  "sitegroup"                guint                 : Read / Write

Sitegroup which object belongs to. Only for old objects.

Default value: 0

Signal Details

The "action-create" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-create-hook" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-created" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-delete" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-delete-hook" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-deleted" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-export" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-export-hook" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-exported" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-import" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-import-hook" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-imported" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-loaded" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-loaded-hook" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-update" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-update-hook" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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

The "action-updated" signal

void                user_function                      (midgard_object *midgard_object,
                                                        gpointer        user_data)           : Action

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