Cairo-Dock  3.4.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
cairo-dock-desklet-manager.h File Reference


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


enum  CairoDeskletNotifications {
 signals More...


CairoDeskletgldi_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 : Started on Sun Jan 27 18:35:38 2008 Cedric GESTES $Id$


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 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



notification called when the mouse enters a desklet.


notification called when the mouse leave a 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.

pCallbackfunction to be called on eash desklet. If it returns TRUE, the loop ends and the function returns the current desklet.
user_datadata to be passed to the callback.
the found desklet, or NULL.
void gldi_desklets_foreach_icons ( GldiIconFunc  pFunction,
gpointer  pUserData 

Execute an action on all icons being inside a desklet.

pFunctionthe action.
pUserDatadata passed to the callback.
void gldi_desklets_set_visible ( gboolean  bOnWidgetLayerToo)

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

bOnWidgetLayerTooTRUE 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.