cairo-dock-notifications.h File Reference

Defines
#define	CAIRO_DOCK_RUN_FIRST
	Use this in cairo_dock_register_notification_on_object to be called before the dock.
#define	CAIRO_DOCK_RUN_AFTER
	Use this in cairo_dock_register_notification_on_object to be called after the dock.
#define	CAIRO_DOCK_INTERCEPT_NOTIFICATION
	Return this in your callback to prevent the other callbacks from being called after you.
#define	CAIRO_DOCK_LET_PASS_NOTIFICATION
	Return this in your callback to let pass the notification to the other callbacks after you.
#define	cairo_dock_notify_on_object(pObject, iNotifType,...)
Typedefs
typedef gboolean(*	CairoDockNotificationFunc )(gpointer pUserData,...)
	Generic prototype of a notification callback.
typedef gboolean(*	CairoDockClickIconFunc )(gpointer pUserData, Icon *pIcon, CairoContainer *pContainer, int iState)
	prototype of the callback to the CAIRO_DOCK_CLICK_ICON notification.
typedef gboolean(*	CairoDockDoubleClickIconFunc )(gpointer pUserData, Icon *pIcon, CairoContainer *pContainer)
	prototype of the callback to the CAIRO_DOCK_DOUBLE_CLICK_ICON notification.
typedef gboolean(*	CairoDockMiddleClickIconFunc )(gpointer pUserData, Icon *pIcon, CairoContainer *pContainer)
	prototype of the callback to the CAIRO_DOCK_MIDDLE_CLICK_ICON notification.
typedef gboolean(*	CairoDockScrollIconFunc )(gpointer pUserData, Icon *pIcon, CairoContainer *pContainer, int iDirection)
	prototype of the callback to the CAIRO_DOCK_SCROLL_ICON notification.
typedef gboolean(*	CairoDockBuildMenuFunc )(gpointer pUserData, Icon *pIcon, CairoContainer *pContainer, GtkMenu *pMenu)
	prototype of the callback to the CAIRO_DOCK_BUILD_ICON_MENU notification.
typedef gboolean(*	CairoDockStartDragDataFunc )(gpointer pUserData, CairoContainer *pContainer, gboolean *bStartAnimation)
	prototype of the callback to the CAIRO_DOCK_START_DRAG_DATA notification.
typedef gboolean(*	CairoDockDropDataFunc )(gpointer pUserData, gchar *cData, Icon *pIcon, double fPosition, CairoContainer *pContainer)
	prototype of the callback to the CAIRO_DOCK_DROP_DATA notification.
typedef gboolean(*	CairoDockMouseMovedFunc )(gpointer pUserData, CairoContainer *pContainer, gboolean *bStartAnimation)
	prototype of the callback to the CAIRO_DOCK_MOUSE_MOVED notification.
typedef gboolean(*	CairoDockKeyPressedFunc )(gpointer pUserData, CairoDock *pDock, int keyval, int state, gchar *string)
	prototype of the callback to the CAIRO_DOCK_KEY_PRESSED notification.
typedef gboolean(*	CairoDockDesktopChangedFunc )(gpointer pUserData)
	prototype of the callback to the CAIRO_DOCK_DESKTOP_CHANGED notification.
typedef gboolean(*	CairoDockWindowConfiguredFunc )(gpointer pUserData, XConfigureEvent *pXEvent)
	prototype of the callback to the CAIRO_DOCK_WINDOW_CONFIGURED notification.
typedef gboolean(*	CairoDockScreenGeometryAlteredFunc )(gpointer pUserData)
	prototype of the callback to the CAIRO_DOCK_SCREEN_GEOMETRY_ALTERED notification.
typedef gboolean(*	CairoDockWindowActivatedFunc )(gpointer pUserData, Window *Xid)
	prototype of the callback to the CAIRO_DOCK_WINDOW_ACTIVATED notification.
typedef gboolean(*	CairoDockKeyboardStateChangedFunc )(gpointer pUserData, Window *Xid)
	prototype of the callback to the CAIRO_DOCK_KBD_STATE_CHANGED notification.
typedef gboolean(*	CairoDockInsertRemoveIconFunc )(gpointer pUserData, Icon *pIcon, CairoDock *pDock)
	prototype of the callback to the CAIRO_DOCK_INSERT_ICON and CAIRO_DOCK_REMOVE_ICON notifications.
typedef gboolean(*	CairoDockRequestAnimationFunc )(gpointer pUserData, Icon *pIcon, CairoDock *pDock, gchar *cAnimationName, gint iNbRounds)
	prototype of the callback to the CAIRO_DOCK_REQUEST_ICON_ANIMATION notification.
typedef gboolean(*	CairoDockEnterIconFunc )(gpointer pUserData, Icon *pIcon, CairoDock *pDock, gboolean *bStartAnimation)
	prototype of the callback to the CAIRO_DOCK_ENTER_ICON notification.
typedef gboolean(*	CairoDockUpdateIconFunc )(gpointer pUserData, Icon *pIcon, CairoDock *pDock, gboolean *bContinueAnimation)
	prototype of the callback to the CAIRO_DOCK_UPDATE_ICON and CAIRO_DOCK_UPDATE_ICON_SLOW notifications.
typedef gboolean(*	CairoDockPreRenderIconFunc )(gpointer pUserData, Icon *pIcon, CairoDock *pDock)
	prototype of the callback to the CAIRO_DOCK_PRE_RENDER_ICON notification.
typedef gboolean(*	CairoDockRenderIconFunc )(gpointer pUserData, Icon *pIcon, CairoDock *pDock, gboolean *bHasBeenRendered, cairo_t *pCairoContext)
	prototype of the callback to the CAIRO_DOCK_RENDER_ICON notification.
typedef gboolean(*	CairoDockStopIconFunc )(gpointer pUserData, Icon *pIcon)
	prototype of the callback to the CAIRO_DOCK_STOP_ICON notification.
typedef gboolean(*	CairoDockEnterContainerFunc )(gpointer pUserData, CairoContainer *pContainer, gboolean *bStartAnimation)
	prototype of the callback to the CAIRO_DOCK_ENTER_DOCK and CAIRO_DOCK_ENTER_DESKLET notifications.
typedef gboolean(*	CairoDockUpdateContainerFunc )(gpointer pUserData, CairoContainer *pContainer, gboolean *bContinueAnimation)
	prototype of the callback to the CAIRO_DOCK_UPDATE_DOCK, CAIRO_DOCK_UPDATE_DOCK_SLOW, CAIRO_DOCK_UPDATE_DESKLET, CAIRO_DOCK_UPDATE_DESKLET_SLOW, CAIRO_DOCK_UPDATE_DIALOG and CAIRO_DOCK_UPDATE_FLYING_CONTAINER notifications.
typedef gboolean(*	CairoDockRenderContainerFunc )(gpointer pUserData, CairoContainer *pContainer, cairo_t *pCairoContext)
	prototype of the callback to the CAIRO_DOCK_RENDER_DOCK, CAIRO_DOCK_RENDER_DESKLET, CAIRO_DOCK_RENDER_DIALOG, CAIRO_DOCK_RENDER_FLYING_CONTAINER notifications. 'pCairoContext' is NULL for an OpenGL rendering.
typedef gboolean(*	CairoDockStopContainerFunc )(gpointer pUserData, CairoContainer *pContainer)
	prototype of the callback to the CAIRO_DOCK_STOP_DOCK and CAIRO_DOCK_STOP_DESKLET notifications.
typedef gboolean(*	CairoDockLeaveContainerFunc )(gpointer pUserData, CairoContainer *pContainer, gboolean *bStartAnimation)
	prototype of the callback to the CAIRO_DOCK_LEAVE_DOCK and CAIRO_DOCK_LEAVE_DESKLET notifications.
Functions
void	cairo_dock_register_notification_on_object (gpointer pObject, CairoDockNotificationType iNotifType, CairoDockNotificationFunc pFunction, gboolean bRunFirst, gpointer pUserData)
void	cairo_dock_remove_notification_func_on_object (gpointer pObject, CairoDockNotificationType iNotifType, CairoDockNotificationFunc pFunction, gpointer pUserData)

---

Detailed Description

This class defines the notification system. Each time an event occurs (like an icon being clicked), Cairo-Dock broadcasts the corresponding notification. Anybody that has registered to it will be called then. Common objects that hold notifications are Managers, Icons, and Containers (and their derivatives Docks, Desklets, Dialogs, Flyings).

---

Define Documentation

#define cairo_dock_notify_on_object	(		pObject,
			iNotifType,
			...
	)

Broadcast a notification on a given object.

Parameters:

pObject	the object (Icon, Container, Manager).
iNotifType	type of the notification.
...	parameters to be passed to the callbacks that has registerd to this notification.

Returns:

whether the notification has been intercepted or not.

---

Function Documentation

void cairo_dock_register_notification_on_object	(	gpointer	pObject,
		CairoDockNotificationType	iNotifType,
		CairoDockNotificationFunc	pFunction,
		gboolean	bRunFirst,
		gpointer	pUserData
	)

Register an action to be called when a given notification is broadcasted from a given object.

Parameters:

pObject	the object (Icon, Container, Manager).
iNotifType	type of the notification.
pFunction	callback.
bRunFirst	CAIRO_DOCK_RUN_FIRST to be called before Cairo-Dock, CAIRO_DOCK_RUN_AFTER to be called after.
pUserData	data to be passed as the first parameter of the callback.

void cairo_dock_remove_notification_func_on_object	(	gpointer	pObject,
		CairoDockNotificationType	iNotifType,
		CairoDockNotificationFunc	pFunction,
		gpointer	pUserData
	)

Remove a callback from the list of callbacks of a given object for a given notification and a given data.

Parameters:

pObject	the object (Icon, Container, Manager) for which the action has been registered.
iNotifType	type of the notification.
pFunction	callback.
pUserData	data that was registerd with the callback.