hildon-home-plugin-loader.h File Reference

Definitions of Hildon Home Plugin Loader. More...

#include <glib.h>
#include <glib-object.h>
#include <gtk/gtkmenu.h>
#include <gtk/gtktoolbar.h>
#include <gdk/gdkx.h>
#include <libosso.h>

Go to the source code of this file.

Classes
struct	_HildonHomePluginLoader
struct	_HildonHomePluginLoaderClass
Defines
#define	HILDON_TYPE_HOME_PLUGIN_LOADER   (hildon_home_plugin_loader_get_type())
#define	HILDON_HOME_PLUGIN_LOADER(obj)
#define	HILDON_HOME_PLUGIN_LOADER_CLASS(klass)
#define	HILDON_IS_HOME_PLUGIN_LOADER(obj)
#define	HILDON_IS_HOME_PLUGIN_LOADER_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_HOME_PLUGIN_LOADER))
Typedefs
typedef void *(*	PluginInitializeFn )(void *state_data, int *state_size, GtkWidget **widget)
typedef int(*	PluginGetReqWidthFn )(void *data)
typedef int(*	PluginSaveStateFn )(void *data, void **state_data, int *state_size)
typedef void(*	PluginBackgroundFn )(void *data)
typedef void(*	PluginForegroundFn )(void *data)
typedef GtkWidget *(*	PluginPropertiesFn )(void *data, GtkWindow *parent)
typedef void(*	PluginDeinitializeFn )(void *data)
typedef _HildonHomePluginLoader	HildonHomePluginLoader
typedef _HildonHomePluginLoaderClass	HildonHomePluginLoaderClass
typedef _HildonHomePluginLoaderPrivate	HildonHomePluginLoaderPrivate
Functions
GType	hildon_home_plugin_loader_get_type (void)
HildonHomePluginLoader *	hildon_home_plugin_loader_new (const char *plugin_name, void *state_data, int *state_size, GtkWidget **applet)
int	hildon_home_plugin_get_applet_width (HildonHomePluginLoader *loader)
int	hildon_home_plugin_applet_save_state (HildonHomePluginLoader *loader, void **state_data, int *state_size)
void	hildon_home_plugin_applet_background (HildonHomePluginLoader *loader)
void	hildon_home_plugin_applet_foreground (HildonHomePluginLoader *loader)
GtkWidget *	hildon_home_plugin_applet_properties (HildonHomePluginLoader *loader, GtkWindow *parent)
void	hildon_home_plugin_deinitialize (HildonHomePluginLoader *loader)

---

Detailed Description

Definitions of Hildon Home Plugin Loader.

---

Define Documentation

#define HILDON_HOME_PLUGIN_LOADER (  obj   )

Value: (GTK_CHECK_CAST (obj, HILDON_TYPE_HOME_PLUGIN_LOADER, \ HildonHomePluginLoader))

#define HILDON_HOME_PLUGIN_LOADER_CLASS (  klass   )

Value: (GTK_CHECK_CLASS_CAST ((klass),\ HILDON_TYPE_HOME_PLUGIN_LOADER, HildonHomePluginLoaderClass))

#define HILDON_IS_HOME_PLUGIN_LOADER (  obj   )

Value: (GTK_CHECK_TYPE (obj, \ HILDON_TYPE_HOME_PLUGIN_LOADER))

---

Typedef Documentation

typedef struct _HildonHomePluginLoaderPrivate HildonHomePluginLoaderPrivate

HildonHomePluginLoaderPrivate: This structure contains just internal data. It should not be accessed directly.

---

Function Documentation

void hildon_home_plugin_applet_background (  HildonHomePluginLoader *  loader  )

Called when Home goes to backround. Applet should stop all timers when this is called. Parameters: loader  A plugin as returned by hildon_home_plugin_loader_new.

void hildon_home_plugin_applet_foreground (  HildonHomePluginLoader *  loader  )

Called when Home goes to foreground. Applet should start periodic UI updates again if needed. Parameters: loader  A plugin as returned by hildon_home_plugin_loader_new.

GtkWidget* hildon_home_plugin_applet_properties (  HildonHomePluginLoader *  loader, GtkWindow *  parent )

Called when the applet needs to open a properties dialog Parameters: loader  A plugin as returned by hildon_home_plugin_loader_new. parent  a parent window. Returns: usually gtkmenuitem

int hildon_home_plugin_applet_save_state (  HildonHomePluginLoader *  loader, void **  state_data, int *  state_size )

Method called to save the UI state of the applet Parameters: loader  A plugin as returned by hildon_home_plugin_loader_new. 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.

void hildon_home_plugin_deinitialize (  HildonHomePluginLoader *  loader  )

Called when Home unloads the applet from memory. Applet should deallocate all the resources needed. Parameters: loader  A plugin as returned by hildon_home_plugin_loader_new.

int hildon_home_plugin_get_applet_width (  HildonHomePluginLoader *  loader  )

Method that returns width that the applet needs to be displayed without any truncation. Home may set the width of the widget narower than this if needed. The priorities are listed in Home Layout Guide. Parameters: loader  A plugin as returned by hildon_home_plugin_loader_new. Returns: Requested width of the plugin applet.

GType hildon_home_plugin_loader_get_type (  void   )

hildon_home_plugin_loader_get_type: Returns: A GType of plugin loader

HildonHomePluginLoader* hildon_home_plugin_loader_new (  const char *  plugin_name, void *  state_data, int *  state_size, GtkWidget **  applet )

hildon_home_plugin_loader_new: This is called when Home loads the applet from plugin. Applet may load it self in initial state or in state given. It loads a GtkWidget that Home will use to display the applet. Parameters: plugin_name  The name of the plugin 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. applet  Return parameter the Applet should fill in with it's main widget. Returns: A .

---