cairo-dock-module-manager.h File Reference

Functions
CairoDockModule *	cairo_dock_find_module_from_name (const gchar *cModuleName)
CairoDockModule *	cairo_dock_load_module (const gchar *cSoFilePath)
void	cairo_dock_load_modules_in_directory (const gchar *cModuleDirPath, GError **erreur)

---

Detailed Description

This class manages the external modules of Cairo-Dock.

A module has an interface and a visit card :

• the visit card allows it to define itself (name, category, default icon, etc)
• the interface defines the entry points for init, stop, reload, read config, and reset datas.

Modules can be instanciated several times; each time they are, an instance is created. Each instance holds all a set of the data : the icon and its container, the config structure and its conf file, the data structure and a slot to plug datas into containers and icons. All these parameters are optionnal; a module that has an icon is also called an applet.

---

Function Documentation

CairoDockModule* cairo_dock_find_module_from_name

(

const gchar *

cModuleName

)

Get the module which has a given name.

Parameters:

cModuleName

the unique name of the module.

Returns:

the module, or NULL if not found.

CairoDockModule* cairo_dock_load_module

(

const gchar *

cSoFilePath

)

Load a module into the table of modules. The module is opened and its visit card and interface are retrieved.

Parameters:

cSoFilePath

path to the .so file.

Returns:

the newly allocated module.

void cairo_dock_load_modules_in_directory	(	const gchar *	cModuleDirPath,
		GError **	erreur
	)

Load all the modules of a given folder. If the path is NULL, plug-ins are taken in the gldi install dir.

Parameters:

cModuleDirPath	path to the a folder containing .so files.
erreur	error set if something bad happens.