cairo-dock-desklet-manager.h File Reference

Typedefs
typedef gboolean(*	CairoDockForeachDeskletFunc )(CairoDesklet *pDesklet, gpointer data)
	Definition of a function that runs through all desklets.
Enumerations
enum	CairoDeskletNotifications {   NOTIFICATION_ENTER_DESKLET,   NOTIFICATION_LEAVE_DESKLET,   NOTIFICATION_UPDATE_DESKLET,   NOTIFICATION_UPDATE_DESKLET_SLOW,   NOTIFICATION_RENDER_DESKLET,   NOTIFICATION_STOP_DESKLET,   NOTIFICATION_CONFIGURE_DESKLET,   NOTIFICATION_NEW_DESKLET }
	signals More...
Functions
CairoDesklet *	cairo_dock_create_desklet (Icon *pIcon, CairoDeskletAttribute *pAttributes)
void	cairo_dock_destroy_desklet (CairoDesklet *pDesklet)
CairoDesklet *	cairo_dock_foreach_desklet (CairoDockForeachDeskletFunc pCallback, gpointer user_data)
void	cairo_dock_foreach_icons_in_desklets (CairoDockForeachIconFunc pFunction, gpointer pUserData)
void	cairo_dock_reload_desklets_decorations (gboolean bDefaultThemeOnly)
void	cairo_dock_set_all_desklets_visible (gboolean bOnWidgetLayerToo)
void	cairo_dock_set_desklets_visibility_to_default (void)
CairoDesklet *	cairo_dock_get_desklet_by_Xid (Window Xid)
Icon *	cairo_dock_find_clicked_icon_in_desklet (CairoDesklet *pDesklet)

---

Detailed Description

This class manages the Desklets, that are Widgets placed directly on your desktop. A Desklet is a container that holds 1 applet's icon plus an optionnal list of other icons and an optionnal GTK widget, has a decoration, suports several accessibility types (like Compiz Widget Layer), and has a renderer. Desklets can be resized or moved directly with the mouse, and can be rotated in the 3 directions of space.

---

Enumeration Type Documentation

enum CairoDeskletNotifications

signals

Enumerator:

NOTIFICATION_ENTER_DESKLET	notification called when the mouse enters a desklet.
NOTIFICATION_LEAVE_DESKLET	notification called when the mouse leave a desklet.
NOTIFICATION_UPDATE_DESKLET	notification called when a desklet is updated in the fast rendering loop.
NOTIFICATION_UPDATE_DESKLET_SLOW	notification called when a desklet is updated in the slow rendering loop.
NOTIFICATION_RENDER_DESKLET	notification called when a desklet is rendered.
NOTIFICATION_STOP_DESKLET	notification called when a desklet is stopped, for instance before it is destroyed.
NOTIFICATION_CONFIGURE_DESKLET	notification called when a desklet is resized or moved on the screen.
NOTIFICATION_NEW_DESKLET	notification called when a new desklet is creayed.

---

Function Documentation

CairoDesklet* cairo_dock_create_desklet	(	Icon *	pIcon,
		CairoDeskletAttribute *	pAttributes
	)

Create a desklet linked to an Icon, and load its configuration.

Parameters:

pIcon	the main icon, or NULL.
pAttributes	the configuration attributes, or NULL.

Returns:

the newly allocated desklet.

void cairo_dock_destroy_desklet

(

CairoDesklet *

pDesklet

)

Destroy a desklet.

Parameters:

pDesklet

a desklet.

CairoDesklet* cairo_dock_foreach_desklet	(	CairoDockForeachDeskletFunc	pCallback,
		gpointer	user_data
	)

Run a function through all the desklets. If the callback returns TRUE, then the loop ends and the function returns the current desklet.

Parameters:

pCallback	function to be called on eash desklet. If it returns TRUE, the loop ends and the function returns the current desklet.
user_data	data to be passed to the callback.

Returns:

the found desklet, or NULL.

void cairo_dock_foreach_icons_in_desklets	(	CairoDockForeachIconFunc	pFunction,
		gpointer	pUserData
	)

Execute an action on all icons being inside a desklet.

Parameters:

pFunction	the action.
pUserData	data passed to the callback.

void cairo_dock_reload_desklets_decorations

(

gboolean

bDefaultThemeOnly

)

Reload the decorations of all the desklets.

Parameters:

bDefaultThemeOnly

whether to reload only the desklet that have the default decoration theme.

void cairo_dock_set_all_desklets_visible

(

gboolean

bOnWidgetLayerToo

)

Make all desklets visible. Their accessibility is set to CAIRO_DESKLET_NORMAL.

Parameters:

bOnWidgetLayerToo

TRUE if you want to act on the desklet that are on the WidgetLayer as well.

void cairo_dock_set_desklets_visibility_to_default

(

void

)

Reset the desklets accessibility to the state defined in their conf file.

CairoDesklet* cairo_dock_get_desklet_by_Xid

(

Window

Xid

)

Search the desklet whose X ID matches the given one.

Parameters:

Xid

an X ID.

Returns:

the desklet that matches, or NULL if none match.

Icon* cairo_dock_find_clicked_icon_in_desklet

(

CairoDesklet *

pDesklet

)

Find the currently pointed icon in a desklet, taking into account the 3D rotations.

Parameters:

pDesklet

the desklet.

Returns:

the pointed icon, or NULL if none.