Midgard Object Property


Data Structures

struct  _MidgardObjectProperty

Functions

GType midgard_object_property_get_type (void)
GType midgard_object_property_get_midgard_type (const gchar *classname, const gchar *name)
gboolean midgard_object_property_is_link (const gchar *classname, const gchar *name)
gboolean midgard_object_property_is_linked (const gchar *classname, const gchar *name)
MidgardObjectClassmidgard_object_property_get_link_class (MidgardObjectClass *klass, const gchar *name)
const gchar * midgard_object_property_get_link_name (const gchar *classname, const gchar *name)
const gchar * midgard_object_property_description (const gchar *classname, const gchar *name)
gboolean midgard_object_property_is_multilang (const gchar *classname, const gchar *name)

Detailed Description

The MidgardObjectPropertyClass class structure .

Function Documentation

const gchar* midgard_object_property_description const gchar *  classname,
const gchar *  name
 

Gets description of the property.

Parameters:
classname name of the registered class
name property name registered for klass
Returns:
description of the property.
Description should be defined in application's xml schema file. This function is a simple wrapper to g_param_spec_get_blurb.

NULL is returned when property is not found as member of a class or if class is not registered within GType system.

Definition at line 124 of file midgard_object_property.c.

MidgardObjectClass* midgard_object_property_get_link_class MidgardObjectClass klass,
const gchar *  name
 

Returns the class that the named property is linked to. Returns NULL if the named property is not a link.

Parameters:
klass the class containing the named link property
name name of the link property
Returns:
the link target class, or NULL
NULL is returned when property is not found as member of a class or if class is not registered within GType system.

Definition at line 156 of file midgard_object_property.c.

References _MidgardObjectClass::data, _MgdSchemaPropertyAttr::is_link, _MgdSchemaPropertyAttr::link, and _MgdSchemaTypeAttr::prophash.

const gchar* midgard_object_property_get_link_name const gchar *  classname,
const gchar *  name
 

Gets the class name of type which property is linked to.

Parameters:
classname name of the registered class
name property name registered for klass
Returns:
class name or NULL if property is not linked with other type.
NULL is returned when property is not found as member of a class or if class is not registered within GType system.

Definition at line 111 of file midgard_object_property.c.

References _MgdSchemaPropertyAttr::link.

GType midgard_object_property_get_midgard_type const gchar *  classname,
const gchar *  name
 

Get Midgard Type of the property.

Parameters:
classname name of the registered class
name property name registered for klass
Returns:
Gtype
Returned Gtype is registered as Midgard type.

MGD_TYPE_NONE is returned if property is not found as member of a class or if class is not registered within GType system.

Definition at line 71 of file midgard_object_property.c.

References _MgdSchemaPropertyAttr::gtype.

GType midgard_object_property_get_type void   ) 
 

Returns the MidgardObjectProperty value type. Registers the type as a fundamental GType unless already registered.

Definition at line 46 of file midgard_object_property.c.

gboolean midgard_object_property_is_link const gchar *  classname,
const gchar *  name
 

Checks if property is a link to another type.

Parameters:
classname name of the registered class
name property name registered for klass
Returns:
TRUE when property is a link to another type, FALSE otherwise
FALSE is returned when property is not found as member of a class or if class is not registered within GType system.

Definition at line 84 of file midgard_object_property.c.

References _MgdSchemaPropertyAttr::is_link.

gboolean midgard_object_property_is_linked const gchar *  classname,
const gchar *  name
 

Checks if property is linked with another type.

Parameters:
classname name of the registered class
name property name registered for klass
Returns:
TRUE when property is linked to another type, FALSE otherwise
FALSE is returned when property is not found as member of a class or if class is not registered within GType system.

Definition at line 97 of file midgard_object_property.c.

References _MgdSchemaPropertyAttr::is_linked.

gboolean midgard_object_property_is_multilang const gchar *  classname,
const gchar *  name
 

Checks if property is multilingual.

Parameters:
classname name of the registered class
name property name registered for klass
Returns:
TRUE if property is multilingual , FALSE otherwise
FALSE is returned when property is not found as member of a class or if class is not registered within GType system.

Property's multilang attribute should be defined in xml schema file.

Definition at line 143 of file midgard_object_property.c.

References _MgdSchemaPropertyAttr::is_multilang.


Generated on Thu Feb 22 06:15:20 2007 for midgard-core by  doxygen 1.4.6