gobject.TypePlugin.TypePlugin Class Reference

List of all members.

Detailed Description

Description The GObject type system supports dynamic loading of types.

The GTypePlugin interface is used to handle the lifecycle of dynamically loaded types. It goes as follows: The type is initially introduced (usually upon loading the module the first time, or by your main application that knows what modules introduces what types), like this: new_type_id = g_type_register_dynamic (parent_type_id, "TypeName", new_type_plugin, type_flags); where new_type_plugin is an implementation of the GTypePlugin interface. The type's implementation is referenced, e.g. through g_type_class_ref() or through g_type_create_instance() (this is being called by g_object_new()) or through one of the above done on a type derived from new_type_id. This causes the type system to load the type's implementation by calling g_type_plugin_use() and g_type_plugin_complete_type_info() on new_type_plugin. At some point the type's implementation isn't required anymore, e.g. after g_type_class_unref() or g_type_free_instance() (called when the reference count of an instance drops to zero). This causes the type system to throw away the information retrieved from g_type_plugin_complete_type_info() and then it calls g_type_plugin_unuse() on new_type_plugin. Things may repeat from the second step. So basically, you need to implement a GTypePlugin type that carries a use_count, once use_count goes from zero to one, you need to load the implementation to successfully handle the upcoming g_type_plugin_complete_type_info() call. Later, maybe after succeeding use/unuse calls, once use_count drops to zero, you can unload the implementation again. The type system makes sure to call g_type_plugin_use() and g_type_plugin_complete_type_info() again when the type is needed again. GTypeModule is an implementation of GTypePlugin that already implements most of this except for the actual module loading and unloading. It even handles multiple registered types per module.


Public Member Functions

GTypePlugingetTypePluginStruct ()
 this (GTypePlugin *gTypePlugin)
 Sets our main struct and passes it to the parent class.
void use ()
 Calls the use_plugin function from the GTypePluginClass of plugin.
void unuse ()
 Calls the unuse_plugin function from the GTypePluginClass of plugin.
void completeTypeInfo (GType gType, GTypeInfo *info, GTypeValueTable *valueTable)
 Calls the complete_type_info function from the GTypePluginClass of plugin.
void completeInterfaceInfo (GType instanceType, GType interfaceType, GInterfaceInfo *info)
 Calls the complete_interface_info function from the GTypePluginClass of plugin.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GTypePlugingTypePlugin
 the main Gtk struct


Constructor & Destructor Documentation

gobject.TypePlugin.TypePlugin.this ( GTypePlugin gTypePlugin  ) 

Sets our main struct and passes it to the parent class.


Member Function Documentation

void gobject.TypePlugin.TypePlugin.completeInterfaceInfo ( GType  instanceType,
GType  interfaceType,
GInterfaceInfo info 
)

Calls the complete_interface_info function from the GTypePluginClass of plugin.

There should be no need to use this function outside of the GObject type system itself. plugin: the GTypePlugin instance_type: the GType of an instantiable type to which the interface is added interface_type: the GType of the interface whose info is completed info: the GInterfaceInfo to fill in See Also GTypeModule and g_type_register_dynamic().

void gobject.TypePlugin.TypePlugin.completeTypeInfo ( GType  gType,
GTypeInfo info,
GTypeValueTable valueTable 
)

Calls the complete_type_info function from the GTypePluginClass of plugin.

There should be no need to use this function outside of the GObject type system itself. plugin: a GTypePlugin g_type: the GType whose info is completed info: the GTypeInfo struct to fill in value_table: the GTypeValueTable to fill in

void* gobject.TypePlugin.TypePlugin.getStruct (  )  [protected]

the main Gtk struct as a void*

GTypePlugin* gobject.TypePlugin.TypePlugin.getTypePluginStruct (  ) 

void gobject.TypePlugin.TypePlugin.unuse (  ) 

Calls the unuse_plugin function from the GTypePluginClass of plugin.

There should be no need to use this function outside of the GObject type system itself. plugin: a GTypePlugin

void gobject.TypePlugin.TypePlugin.use (  ) 

Calls the use_plugin function from the GTypePluginClass of plugin.

There should be no need to use this function outside of the GObject type system itself. plugin: a GTypePlugin


Member Data Documentation

GTypePlugin* gobject.TypePlugin.TypePlugin.gTypePlugin [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo