GXmlSerializableObjectModel

GXmlSerializableObjectModel — Object Model is an GXmlSerializable implementation using GXmlElement to represent GObject class objects.

Functions

Types and Values

Description

This implementation consider each object as a XML node, represented in GXml as a GXmlElement and its properties is represented by GXmlAttribute. Each property, if it is a GXmlSerializable object, is represented as child GXmlElement.

If a object's value property must be represented as a XML node content, then it requires to override gxml_serializable_serialize_use_xml_node_value() and set value at "serialized-xml-node-value".

Functions

gxml_serializable_object_model_get_enable_unknown_serializable_property ()

gboolean
gxml_serializable_object_model_get_enable_unknown_serializable_property
                               (GXmlSerializableObjectModel *self);

Parameters

self

the GXmlSerializableObjectModel instance

 

gxml_serializable_object_model_serialize_use_xml_node_value ()

gboolean
gxml_serializable_object_model_serialize_use_xml_node_value
                               (GXmlSerializableObjectModel *self);

Parameters

self

the GXmlSerializableObjectModel instance

 

gxml_serializable_object_model_property_use_nick ()

gboolean
gxml_serializable_object_model_property_use_nick
                               (GXmlSerializableObjectModel *self);

Parameters

self

the GXmlSerializableObjectModel instance

 

gxml_serializable_object_model_set_default_namespace ()

gboolean
gxml_serializable_object_model_set_default_namespace
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *node);

Parameters

self

the GXmlSerializableObjectModel instance

 

node

 

 

gxml_serializable_object_model_node_name ()

gchar *
gxml_serializable_object_model_node_name
                               (GXmlSerializableObjectModel *self);

Parameters

self

the GXmlSerializableObjectModel instance

 

gxml_serializable_object_model_default_node_name ()

gchar *
gxml_serializable_object_model_default_node_name
                               (GXmlSerializableObjectModel *self);

Parameters

self

the GXmlSerializableObjectModel instance

 

gxml_serializable_object_model_find_property_spec ()

GParamSpec *
gxml_serializable_object_model_find_property_spec
                               (GXmlSerializableObjectModel *self,
                                const gchar *property_name);

Parameters

self

the GXmlSerializableObjectModel instance

 

property_name

 

 

gxml_serializable_object_model_list_serializable_properties ()

GParamSpec **
gxml_serializable_object_model_list_serializable_properties
                               (GXmlSerializableObjectModel *self,
                                int *result_length1);

Parameters

self

the GXmlSerializableObjectModel instance

 

Returns

.

[array length=result_length1]


gxml_serializable_object_model_serialize ()

GXmlNode *
gxml_serializable_object_model_serialize
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *node,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

node

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_default_serialize ()

GXmlNode *
gxml_serializable_object_model_default_serialize
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *node,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

node

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_serialize_property ()

GXmlNode *
gxml_serializable_object_model_serialize_property
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *element,
                                GParamSpec *prop,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

element

 

 

prop

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_default_serialize_property ()

GXmlNode *
gxml_serializable_object_model_default_serialize_property
                               (GXmlSerializableObjectModel *self,
                                GXmlElement *element,
                                GParamSpec *prop,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

element

 

 

prop

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_deserialize ()

gboolean
gxml_serializable_object_model_deserialize
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *node,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

node

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_default_deserialize ()

gboolean
gxml_serializable_object_model_default_deserialize
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *node,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

node

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_deserialize_property ()

gboolean
gxml_serializable_object_model_deserialize_property
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *property_node,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

property_node

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_default_deserialize_property ()

gboolean
gxml_serializable_object_model_default_deserialize_property
                               (GXmlSerializableObjectModel *self,
                                GXmlNode *property_node,
                                GError **error);

Parameters

self

the GXmlSerializableObjectModel instance

 

property_node

 

 

error

location to store the error occuring, or NULL to ignore

 

gxml_serializable_object_model_to_string ()

gchar *
gxml_serializable_object_model_to_string
                               (GXmlSerializableObjectModel *self);

Parameters

self

the GXmlSerializableObjectModel instance

 

gxml_serializable_object_model_get_properties ()

GParamSpec **
gxml_serializable_object_model_get_properties
                               (GXmlSerializableObjectModel *self,
                                int *result_length1);

Get and return the current value of the "properties" property.

Parameters

self

the GXmlSerializableObjectModel instance to query

 

Returns

the value of the "properties" property


gxml_serializable_object_model_set_properties ()

void
gxml_serializable_object_model_set_properties
                               (GXmlSerializableObjectModel *self,
                                GParamSpec **value,
                                int value_length1);

Set the value of the "properties" property to value .

Parameters

self

the GXmlSerializableObjectModel instance to modify

 

value

the new value of the "properties" property

 

gxml_serializable_object_model_get_ignored_serializable_properties ()

GHashTable *
gxml_serializable_object_model_get_ignored_serializable_properties
                               (GXmlSerializableObjectModel *self);

Get and return the current value of the "ignored-serializable-properties" property.

Parameters

self

the GXmlSerializableObjectModel instance to query

 

Returns

the value of the "ignored-serializable-properties" property


gxml_serializable_object_model_set_ignored_serializable_properties ()

void
gxml_serializable_object_model_set_ignored_serializable_properties
                               (GXmlSerializableObjectModel *self,
                                GHashTable *value);

Set the value of the "ignored-serializable-properties" property to value .

Parameters

self

the GXmlSerializableObjectModel instance to modify

 

value

the new value of the "ignored-serializable-properties" property

 

Types and Values

GXML_TYPE_SERIALIZABLE_OBJECT_MODEL

#define GXML_TYPE_SERIALIZABLE_OBJECT_MODEL (gxml_serializable_object_model_get_type ())

The type for GXmlSerializableObjectModel.


struct GXmlSerializableObjectModel

struct GXmlSerializableObjectModel {
	GObject parent_instance;
	GXmlSerializableObjectModelPrivate * priv;
	GXmlNode* _node;
};

Object Model is an GXmlSerializable implementation using GXmlElement to represent GObject class objects.

This implementation consider each object as a XML node, represented in GXml as a GXmlElement and its properties is represented by GXmlAttribute. Each property, if it is a GXmlSerializable object, is represented as child GXmlElement.

If a object's value property must be represented as a XML node content, then it requires to override gxml_serializable_serialize_use_xml_node_value() and set value at "serialized-xml-node-value".


struct GXmlSerializableObjectModelClass

struct GXmlSerializableObjectModelClass {
	GObjectClass parent_class;
	gboolean (*get_enable_unknown_serializable_property) (GXmlSerializableObjectModel* self);
	gboolean (*serialize_use_xml_node_value) (GXmlSerializableObjectModel* self);
	gboolean (*property_use_nick) (GXmlSerializableObjectModel* self);
	gboolean (*set_default_namespace) (GXmlSerializableObjectModel* self, GXmlNode* node);
	gchar* (*node_name) (GXmlSerializableObjectModel* self);
	GParamSpec* (*find_property_spec) (GXmlSerializableObjectModel* self, const gchar* property_name);
	GParamSpec** (*list_serializable_properties) (GXmlSerializableObjectModel* self, int* result_length1);
	GXmlNode* (*serialize) (GXmlSerializableObjectModel* self, GXmlNode* node, GError** error);
	GXmlNode* (*serialize_property) (GXmlSerializableObjectModel* self, GXmlNode* element, GParamSpec* prop, GError** error);
	gboolean (*deserialize) (GXmlSerializableObjectModel* self, GXmlNode* node, GError** error);
	gboolean (*deserialize_property) (GXmlSerializableObjectModel* self, GXmlNode* property_node, GError** error);
	gchar* (*to_string) (GXmlSerializableObjectModel* self);
};

The class structure for GXML_TYPE_SERIALIZABLE_OBJECT_MODEL. All the fields in this structure are private and should never be accessed directly.

Members

get_enable_unknown_serializable_property ()

virtual method called by gxml_serializable_object_model_get_enable_unknown_serializable_property()

 

serialize_use_xml_node_value ()

virtual method called by gxml_serializable_object_model_serialize_use_xml_node_value()

 

property_use_nick ()

virtual method called by gxml_serializable_object_model_property_use_nick()

 

set_default_namespace ()

virtual method called by gxml_serializable_object_model_set_default_namespace()

 

node_name ()

virtual method called by gxml_serializable_object_model_node_name()

 

find_property_spec ()

virtual method called by gxml_serializable_object_model_find_property_spec()

 

list_serializable_properties ()

virtual method called by gxml_serializable_object_model_list_serializable_properties()

 

serialize ()

virtual method called by gxml_serializable_object_model_serialize()

 

serialize_property ()

virtual method called by gxml_serializable_object_model_serialize_property()

 

deserialize ()

virtual method called by gxml_serializable_object_model_deserialize()

 

deserialize_property ()

virtual method called by gxml_serializable_object_model_deserialize_property()

 

to_string ()

virtual method called by gxml_serializable_object_model_to_string()