Plugins


Functions

osso_return_t osso_cp_plugin_execute (osso_context_t *osso, const gchar *filename, gpointer data, gboolean user_activated)
osso_return_t osso_cp_plugin_save_state (osso_context_t *osso, const gchar *filename, gpointer data)

Function Documentation

osso_return_t osso_cp_plugin_execute osso_context_t osso,
const gchar *  filename,
gpointer  data,
gboolean  user_activated
 

Calls the execute() function of a plugin. The plugins are loaded using dlopen(3) and after the execute function returns, unloaded with dlclose(3).

Parameters:
osso The library context as returned by osso_initialize.
filename The shared object (.so) file of the plugin. It should include the ".so" prefix, but not a path.
data The GTK top-level widget. It is needed so that the widgets created by the plugin can be made a child of the main application that utilizes the plugin. Type is a gpointer so that the plugin does not need to depend on GTK (in which case it should ignore the parameter).
user_activated If the plugin was activated by a user (as opposed to activated by restoring software state), set to TRUE, else to FALSE.
Returns:
the return value of the plugin on success, or OSSO_ERROR on error.

osso_return_t osso_cp_plugin_save_state osso_context_t osso,
const gchar *  filename,
gpointer  data
 

This function is used to tell a plugin to save its state.

Parameters:
osso The library context as returned by osso_initialize.
filename Same as the filename parameter of osso_cp_plugin_execute
data A pointer that will be passed to the state save function of the plugin and ignored by Libosso.
Returns:
OSSO_OK if all goes well, OSSO_INVALID if a parameter is invalid, or OSSO_ERROR if some error occurred.


Generated on Thu Jul 6 13:33:57 2006 for LibOSSO by  doxygen 1.4.6