cairo-dock-desklet-manager.h File Reference

Typedefs
typedef gboolean(*	GldiDeskletForeachFunc )(CairoDesklet *pDesklet, gpointer data)
	Definition of a function that runs through all desklets.

Enumerations
enum	CairoDeskletNotifications {   NOTIFICATION_ENTER_DESKLET,   NOTIFICATION_LEAVE_DESKLET,   NOTIFICATION_CONFIGURE_DESKLET }
	signals More...

Functions
CairoDesklet *	gldi_desklets_foreach (GldiDeskletForeachFunc pCallback, gpointer user_data)
void	gldi_desklets_foreach_icons (GldiIconFunc pFunction, gpointer pUserData)
void	gldi_desklets_set_visible (gboolean bOnWidgetLayerToo)
void	gldi_desklets_set_visibility_to_default (void)

Detailed Description

This file is a part of the Cairo-Dock project

Login : ctaf4.nosp@m.2@gm.nosp@m.ail.c.nosp@m.om Started on Sun Jan 27 18:35:38 2008 Cedric GESTES $Id$

Author(s)

• Cedric GESTES ctaf4.nosp@m.2@gm.nosp@m.ail.c.nosp@m.om
• Fabrice REY

Copyright (C) 2008 Cedric GESTES E-mail : see the 'copyright' file.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. 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_CONFIGURE_DESKLET	notification called when a desklet is resized or moved on the screen.

Function Documentation

CairoDesklet* gldi_desklets_foreach	(	GldiDeskletForeachFunc	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 gldi_desklets_foreach_icons	(	GldiIconFunc	pFunction,
		gpointer	pUserData
	)

Execute an action on all icons being inside a desklet.

Parameters

pFunction	the action.
pUserData	data passed to the callback.

void gldi_desklets_set_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 gldi_desklets_set_visibility_to_default

(

void

)

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