Macros
#define	CD_APPLET_DEFINE_ALL_BEGIN(_cName, _iMajorVersion, _iMinorVersion, _iMicroVersion, _iAppletCategory, _cDescription, _cAuthor)

#define	CD_APPLET_DEFINE_END

#define	CD_APPLET_DEFINITION(cName, iMajorVersion, iMinorVersion, iMicroVersion, iAppletCategory, cDescription, cAuthor)

#define	CD_APPLET_INIT_ALL_BEGIN(pApplet)

#define	CD_APPLET_INIT_END

#define	CD_APPLET_STOP_BEGIN

#define	CD_APPLET_STOP_END

#define	CD_APPLET_RELOAD_ALL_BEGIN

#define	CD_APPLET_RELOAD_END

#define	CD_APPLET_GET_CONFIG_ALL_BEGIN

#define	CD_APPLET_GET_CONFIG_END

#define	CD_APPLET_RESET_CONFIG_ALL_BEGIN

#define	CD_APPLET_RESET_CONFIG_ALL_END

#define	CD_APPLET_RESET_DATA_BEGIN

#define	CD_APPLET_RESET_DATA_ALL_END

#define	CD_APPLET_ON_CLICK_BEGIN

#define	CD_APPLET_ON_CLICK_END

#define	CD_APPLET_ON_BUILD_MENU_BEGIN

#define	CD_APPLET_ON_BUILD_MENU_END

#define	CD_APPLET_ON_MIDDLE_CLICK_BEGIN

#define	CD_APPLET_ON_MIDDLE_CLICK_END

#define	CD_APPLET_ON_DOUBLE_CLICK_BEGIN

#define	CD_APPLET_ON_DOUBLE_CLICK_END

#define	CD_APPLET_ON_DROP_DATA_BEGIN

#define	CD_APPLET_ON_DROP_DATA_END

#define	CD_APPLET_ON_SCROLL_BEGIN

#define	CD_APPLET_ON_SCROLL_END

#define	CD_APPLET_ON_UPDATE_ICON_BEGIN

#define	CD_APPLET_ON_UPDATE_ICON_END

#define	CD_APPLET_SKIP_UPDATE_ICON

#define	CD_APPLET_STOP_UPDATE_ICON

#define	CD_APPLET_PAUSE_UPDATE_ICON

#define	CD_APPLET_REGISTER_FOR_CLICK_EVENT

#define	CD_APPLET_UNREGISTER_FOR_CLICK_EVENT

#define	CD_APPLET_REGISTER_FOR_BUILD_MENU_EVENT

#define	CD_APPLET_UNREGISTER_FOR_BUILD_MENU_EVENT

#define	CD_APPLET_REGISTER_FOR_MIDDLE_CLICK_EVENT

#define	CD_APPLET_UNREGISTER_FOR_MIDDLE_CLICK_EVENT

#define	CD_APPLET_REGISTER_FOR_DOUBLE_CLICK_EVENT

#define	CD_APPLET_UNREGISTER_FOR_DOUBLE_CLICK_EVENT

#define	CD_APPLET_REGISTER_FOR_DROP_DATA_EVENT

#define	CD_APPLET_UNREGISTER_FOR_DROP_DATA_EVENT

#define	CD_APPLET_REGISTER_FOR_SCROLL_EVENT

#define	CD_APPLET_UNREGISTER_FOR_SCROLL_EVENT

#define	CD_APPLET_REGISTER_FOR_UPDATE_ICON_SLOW_EVENT

#define	CD_APPLET_UNREGISTER_FOR_UPDATE_ICON_SLOW_EVENT

#define	CD_APPLET_REGISTER_FOR_UPDATE_ICON_EVENT

#define	CD_APPLET_UNREGISTER_FOR_UPDATE_ICON_EVENT

Detailed Description

This file defines numerous macros, that form a canvas for all the applets.

You probably won't need to dig into this file, since you can generate an applet with the 'generate-new-applet.sh' script, that will build the whole canvas for you. Moreover, you can have a look at an applet that has a similar functioning to yours.

Macro Definition Documentation

#define CD_APPLET_DEFINE_ALL_BEGIN	(	_cName,
		_iMajorVersion,
		_iMinorVersion,
		_iMicroVersion,
		_iAppletCategory,
		_cDescription,
		_cAuthor
	)

Debut de la fonction de pre-initialisation de l'applet (celle qui est appele a l'enregistrement de tous les plug-ins). Definit egalement les variables globales suivantes : myIcon, myDock, myDesklet, myContainer, et myDrawContext.

Parameters

_cName	nom de sous lequel l'applet sera enregistree par Cairo-Dock.
_iMajorVersion	version majeure du dock necessaire au bon fonctionnement de l'applet.
_iMinorVersion	version mineure du dock necessaire au bon fonctionnement de l'applet.
_iMicroVersion	version micro du dock necessaire au bon fonctionnement de l'applet.
_iAppletCategory	Categorie de l'applet (CAIRO_DOCK_CATEGORY_ACCESSORY, CAIRO_DOCK_CATEGORY_DESKTOP, CAIRO_DOCK_CATEGORY_CONTROLER)
_cDescription	description et mode d'emploi succint de l'applet.
_cAuthor	nom de l'auteur et eventuellement adresse mail.

#define CD_APPLET_DEFINE_END

Fin de la fonction de pre-initialisation de l'applet.

#define CD_APPLET_DEFINITION	(	cName,
		iMajorVersion,
		iMinorVersion,
		iMicroVersion,
		iAppletCategory,
		cDescription,
		cAuthor
	)

Fonction de pre-initialisation generique. Ne fais que definir l'applet (en appelant les 2 macros precedentes), la plupart du temps cela est suffisant.

#define CD_APPLET_INIT_ALL_BEGIN ( pApplet )

Debut de la fonction d'initialisation de l'applet (celle qui est appelee a chaque chargement de l'applet). Lis le fichier de conf de l'applet, et cree son icone ainsi que son contexte de dessin.

Parameters

pApplet une instance du module.

#define CD_APPLET_INIT_END

Fin de la fonction d'initialisation de l'applet.

#define CD_APPLET_STOP_BEGIN

Debut de la fonction d'arret de l'applet.

#define CD_APPLET_STOP_END

Fin de la fonction d'arret de l'applet.

#define CD_APPLET_RELOAD_ALL_BEGIN

Debut de la fonction de rechargement de l'applet.

#define CD_APPLET_RELOAD_END

Fin de la fonction de rechargement de l'applet.

#define CD_APPLET_GET_CONFIG_ALL_BEGIN

Debut de la fonction de configuration de l'applet (celle qui est appelee au debut de l'init).

#define CD_APPLET_GET_CONFIG_END

Fin de la fonction de configuration de l'applet.

#define CD_APPLET_RESET_CONFIG_ALL_BEGIN

Debut de la fonction de liberation des donnees de la config.

#define CD_APPLET_RESET_CONFIG_ALL_END

Fin de la fonction de liberation des donnees de la config.

#define CD_APPLET_RESET_DATA_BEGIN

Debut de la fonction de liberation des donnees internes.

#define CD_APPLET_RESET_DATA_ALL_END

Fin de la fonction de liberation des donnees internes.

#define CD_APPLET_ON_CLICK_BEGIN

Debut de la fonction de notification au clic gauche.

#define CD_APPLET_ON_CLICK_END

Fin de la fonction de notification au clic gauche. Par defaut elle intercepte la notification si elle l'a recue.

#define CD_APPLET_ON_BUILD_MENU_BEGIN

Debut de la fonction de notification de construction du menu.

#define CD_APPLET_ON_BUILD_MENU_END

Fin de la fonction de notification de construction du menu. Par defaut elle intercepte la notification si elle l'a recue.

#define CD_APPLET_ON_MIDDLE_CLICK_BEGIN

Debut de la fonction de notification du clic du milieu.

#define CD_APPLET_ON_MIDDLE_CLICK_END

Fin de la fonction de notification du clic du milieu. Par defaut elle intercepte la notification si elle l'a recue.

#define CD_APPLET_ON_DOUBLE_CLICK_BEGIN

Debut de la fonction de notification du clic du milieu.

#define CD_APPLET_ON_DOUBLE_CLICK_END

Fin de la fonction de notification du clic du milieu. Par defaut elle intercepte la notification si elle l'a recue.

#define CD_APPLET_ON_DROP_DATA_BEGIN

Debut de la fonction de notification du glisse-depose.

#define CD_APPLET_ON_DROP_DATA_END

Fin de la fonction de notification du glisse-depose. Par defaut elle intercepte la notification si elle l'a recue.

#define CD_APPLET_ON_SCROLL_BEGIN

Debut de la fonction de notification au scroll.

#define CD_APPLET_ON_SCROLL_END

Fin de la fonction de notification au scroll. Par defaut elle intercepte la notification si elle l'a recue.

#define CD_APPLET_ON_UPDATE_ICON_BEGIN

Debut de la fonction de notification d'update icon.

#define CD_APPLET_ON_UPDATE_ICON_END

Fin de la fonction de notification d'update icon.

#define CD_APPLET_SKIP_UPDATE_ICON

Quit the update function immediately and wait for the next update.

#define CD_APPLET_STOP_UPDATE_ICON

Quit the update function immediately with no more updates.

#define CD_APPLET_PAUSE_UPDATE_ICON

Quit the update function immediately with no more updates after redrawing the icon.

#define CD_APPLET_REGISTER_FOR_CLICK_EVENT

Abonne l'applet aux notifications du clic gauche. A effectuer lors de l'init de l'applet.

#define CD_APPLET_UNREGISTER_FOR_CLICK_EVENT

Desabonne l'applet aux notifications du clic gauche. A effectuer lors de l'arret de l'applet.

#define CD_APPLET_REGISTER_FOR_BUILD_MENU_EVENT

Abonne l'applet aux notifications de construction du menu. A effectuer lors de l'init de l'applet.

#define CD_APPLET_UNREGISTER_FOR_BUILD_MENU_EVENT

Desabonne l'applet aux notifications de construction du menu. A effectuer lors de l'arret de l'applet.

#define CD_APPLET_REGISTER_FOR_MIDDLE_CLICK_EVENT

Abonne l'applet aux notifications du clic du milieu. A effectuer lors de l'init de l'applet.

#define CD_APPLET_UNREGISTER_FOR_MIDDLE_CLICK_EVENT

Desabonne l'applet aux notifications du clic du milieu. A effectuer lors de l'arret de l'applet.

#define CD_APPLET_REGISTER_FOR_DOUBLE_CLICK_EVENT

Abonne l'applet aux notifications du double clic. A effectuer lors de l'init de l'applet.

#define CD_APPLET_UNREGISTER_FOR_DOUBLE_CLICK_EVENT

Desabonne l'applet aux notifications du double clic. A effectuer lors de l'arret de l'applet.

#define CD_APPLET_REGISTER_FOR_DROP_DATA_EVENT

Abonne l'applet aux notifications du glisse-depose. A effectuer lors de l'init de l'applet.

#define CD_APPLET_UNREGISTER_FOR_DROP_DATA_EVENT

Desabonne l'applet aux notifications du glisse-depose. A effectuer lors de l'arret de l'applet.

#define CD_APPLET_REGISTER_FOR_SCROLL_EVENT

Abonne l'applet aux notifications du clic gauche. A effectuer lors de l'init de l'applet.

#define CD_APPLET_UNREGISTER_FOR_SCROLL_EVENT

Desabonne l'applet aux notifications du clic gauche. A effectuer lors de l'arret de l'applet.

#define CD_APPLET_REGISTER_FOR_UPDATE_ICON_SLOW_EVENT

Register the applet to the 'update icon' notifications of the slow rendering loop.

#define CD_APPLET_UNREGISTER_FOR_UPDATE_ICON_SLOW_EVENT

Unregister the applet from the slow rendering loop.

#define CD_APPLET_REGISTER_FOR_UPDATE_ICON_EVENT

Register the applet to the 'update icon' notifications of the fast rendering loop.

#define CD_APPLET_UNREGISTER_FOR_UPDATE_ICON_EVENT

Unregister the applet from the fast rendering loop.

Macros

Detailed Description

Macro Definition Documentation