Main Page | File List | File Members

hildon-cp-plugin-interface.h File Reference

#include <libosso.h>

Go to the source code of this file.

Functions

G_BEGIN_DECLS osso_return_t execute (osso_context_t *osso, gpointer data, gboolean user_activated)
osso_return_t save_state (osso_context_t *osso, gpointer data)


Detailed Description

This file includes the control panel plugins interface, i.e. the prototypes for the execute() and reset() functions. This file is intended to be included by control panel plugins.

Function Documentation

G_BEGIN_DECLS osso_return_t execute osso_context_t *  osso,
gpointer  data,
gboolean  user_activated
 

The execute() function of the control panel plugin.

This function will be called by the osso_cp_plugin_execute() function.

Parameters:
osso The osso context of the application that executes the plugin.
data The GTK toplevel 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 gpointer so that the plugin does not need to depend on GTK (in which case it should ignore the parameter).
user_activated True iff plugin was launched by user, False if plugin is launched by the application while restoring its state.
Returns:
OSSO_OK on success, OSSO_ERR on error.


Generated on Thu Dec 21 18:18:50 2006 by  doxygen 1.4.2