hildon-home-plugin-interface.h File Reference

Definitions of Home Applet API. All applet applets use this public API. More...

#include <gtk/gtk.h>
#include <gtk/gtkwidget.h>

Go to the source code of this file.

Functions
G_BEGIN_DECLS void *	hildon_home_applet_lib_initialize (void *state_data, int *state_size, GtkWidget **widget)
int	hildon_home_applet_lib_save_state (void *applet_data, void **state_data, int *state_size)
void	hildon_home_applet_lib_background (void *applet_data)
void	hildon_home_applet_lib_foreground (void *applet_data)
void	hildon_home_applet_lib_deinitialize (void *applet_data)
GtkWidget *	hildon_home_applet_lib_settings (void *applet_data, GtkWindow *parent)

---

Detailed Description

Definitions of Home Applet API. All applet applets use this public API.

---

Function Documentation

void hildon_home_applet_lib_background (  void *  applet_data  )

Called when Home goes to backround. Applet should stop all timers when this is called. Parameters: applet_data  Applet data as returned by applet_initialize.

void hildon_home_applet_lib_deinitialize (  void *  applet_data  )

Called when Home unloads the applet from memory. Applet should deallocate all the resources needed. Parameters: applet_data  Applet data as returned by applet_initialize.

void hildon_home_applet_lib_foreground (  void *  applet_data  )

Called when Home goes to foreground. Applet should start periodic UI updates again if needed. Parameters: applet_data  Applet data as returned by applet_initialize.

G_BEGIN_DECLS void* hildon_home_applet_lib_initialize (  void *  state_data, int *  state_size, GtkWidget **  widget )

Applet initialization. This is called when Home loads the applet. It may load it self in initial state or in state given. It creates a GtkWidget that Home will use to display the applet. Parameters: state_data  Statesaved data as returned by applet_save_state. NULL if applet is to be loaded in initial state. state_size  Size of the state data. widget  Return parameter the Applet should fill in with it's main widget. Returns: A pointer to applet specific data

int hildon_home_applet_lib_save_state (  void *  applet_data, void **  state_data, int *  state_size )

Method called to save the UI state of the applet Parameters: applet_data  Applet data as returned by applet_initialize. state_data  Applet allocates memory for state data and stores pointer here. Must be freed by the calling application Parameters: state_size  Applet stores the size of the state data allocated here. Returns: 1 if successfull.

GtkWidget* hildon_home_applet_lib_settings (  void *  applet_data, GtkWindow *  parent )

Called when the applet needs to be able to access settings of applet from Home menu.

---