_CssedPlugin Struct Reference

#include <plugin.h>


Detailed Description

This object represents a plugin.

One CssedPlugin object's pointer must be returned with the function CssedPlugin *init_plugin() exported by the module .

You can create this object static or reserve memory for it and then return it in the init_plugin() function .

[view example]

Definition at line 78 of file plugin.h.

Data Fields

gchar * name
 The plugin's name.
gchar * description
 Plugin short description.
gboolean(* load_plugin )(CssedPlugin *)
 Plugin load function.
void(* clean_plugin )(CssedPlugin *)
 Plugin clean function.
gpointer user_data
 Use this field to store plugin's needed data.
CssedPluginPrivpriv
 Private data.


Field Documentation

void(* _CssedPlugin::clean_plugin)(CssedPlugin *)
 

Plugin clean function.

It will be called by cssed before unloading the plugin, put all your UI destruction and free all memory here.

gchar* _CssedPlugin::description
 

Plugin short description.

One short description to show to users in the plugin's list.

Definition at line 83 of file plugin.h.

gboolean(* _CssedPlugin::load_plugin)(CssedPlugin *)
 

Plugin load function.

It will be called by cssed to initialize the plugin, put all your UI construction and initialization code here.

gchar* _CssedPlugin::name
 

The plugin's name.

One name to show to users in the plugin's list.

Definition at line 81 of file plugin.h.

CssedPluginPriv* _CssedPlugin::priv
 

Private data.

This field is opaque and should be ignored

Definition at line 91 of file plugin.h.

gpointer _CssedPlugin::user_data
 

Use this field to store plugin's needed data.

You can use this field to pass any data needed by your implementation.

Definition at line 89 of file plugin.h.


The documentation for this struct was generated from the following file:

Back to Index

This documentation is © Iago Rubio Sanfiz, 2004