Référence du fichier src/cairo-dock-dock-factory.c


Fonctions

void cairo_dock_set_colormap_for_window (GtkWidget *pWidget)
CairoDockcairo_dock_create_new_dock (GdkWindowTypeHint iWmHint, gchar *cDockName, gchar *cRendererName)
const gchar * cairo_dock_search_dock_name (CairoDock *pDock)
CairoDockcairo_dock_search_dock_from_name (gchar *cDockName)
Iconcairo_dock_search_icon_pointing_on_dock (CairoDock *pDock, CairoDock **pParentDock)
CairoDockcairo_dock_search_container_from_icon (Icon *icon)
void cairo_dock_reserve_space_for_dock (CairoDock *pDock, gboolean bReserve)
void cairo_dock_update_dock_size (CairoDock *pDock)
void cairo_dock_insert_icon_in_dock (Icon *icon, CairoDock *pDock, gboolean bUpdateSize, gboolean bAnimated, gboolean bApplyRatio)
void cairo_dock_build_docks_tree_with_desktop_files (CairoDock *pMainDock, gchar *cDirectory)
void cairo_dock_free_all_docks (CairoDock *pMainDock)
void cairo_dock_destroy_dock (CairoDock *pDock, const gchar *cDockName, CairoDock *ReceivingDock, gchar *cReceivingDockName)
void cairo_dock_reference_dock (CairoDock *pDock)
CairoDockcairo_dock_create_subdock_from_scratch_with_type (GList *pIconList, gchar *cDockName, GdkWindowTypeHint iWindowTypeHint)

Variables

int g_iWmHint
CairoDockg_pMainDock
 pointeur sur le dock principal.
GHashTable * g_hDocksTable
 table des docks existant.
gboolean g_bSameHorizontality
 dit si les sous-docks ont la meme horizontalite que les docks racines.
double g_fSubDockSizeRatio
 ratio de la taille des icones des sous-docks par rapport a celles du dock principal.
gboolean g_bReserveSpace
gchar * g_cMainDockDefaultRendererName
gchar * g_cSubDockDefaultRendererName
int g_iMaxAuthorizedWidth
gint g_iDockLineWidth
 epaisseur du cadre (en pixels).
int g_iIconGap
 ecart en pixels entre les icones.
double g_fAmplitude
 amplitude de la siunsoide.
int g_iLabelSize
 taille de la police des etiquettes.
gchar * g_cLabelPolice
 police de caracteres des etiquettes.
gboolean g_bTextAlwaysHorizontal
 TRUE <=> etiquettes horizontales meme pour les docks verticaux.
gboolean g_bAutoHide
 TRUE si l'auto-hide est active.
gchar * g_cCurrentLaunchersPath
 le chemin vers le repertoire des lanceurs/icones du theme courant.
gboolean g_bDirectionUp
 la direction dans laquelle les icones grossissent. Vers le haut ou vers le bas.
int g_tIconTypeOrder [CAIRO_DOCK_NB_TYPES]
gchar * g_cConfFile
gboolean g_bKeepAbove
gboolean g_bSkipPager
gboolean g_bSkipTaskbar
gboolean g_bSticky
gboolean g_bUseGlitz

Documentation des fonctions

void cairo_dock_set_colormap_for_window GtkWidget *  pWidget  ) 
 

CairoDock* cairo_dock_create_new_dock GdkWindowTypeHint  iWmHint,
gchar *  cDockName,
gchar *  cRendererName
 

Cree un nouveau dock principal.

Paramètres:
iWmHint indicateur du type de fenetre pour le WM.
cDockName nom du dock, qui pourra etre utilise pour retrouver celui-ci rapidement.
cRendererName nom de la fonction de rendu a applisuer au dock. si NULL, le rendu par defaut sera applique.
Renvoie:
le dock nouvellement alloué, a detruire avec <cairo_dock_destroy_dock>

const gchar* cairo_dock_search_dock_name CairoDock pDock  ) 
 

Cherche le nom d'un dock, en parcourant la table des docks jusqu'a trouver celui passe en entree.

Paramètres:
pDock le dock.
Renvoie:
le nom du dock, ou NULL si ce dock n'existe pas. Ne _pas_ desallouer la chaine.

CairoDock* cairo_dock_search_dock_from_name gchar *  cDockName  ) 
 

Cherche un dock etant donne son nom.

Paramètres:
cDockName le nom du dock.
Renvoie:
le dock qui a ete enregistre sous ce nom, ou NULL si aucun ne correspond.

Icon* cairo_dock_search_icon_pointing_on_dock CairoDock pDock,
CairoDock **  pParentDock
 

Cherche l'icone pointant sur un dock. Si plusieurs icones pointent sur ce dock, la premiere sera renvoyee.

Paramètres:
pDock le dock.
pParentDock si non NULL, sera renseigne avec le dock contenant l'icone.
Renvoie:
l'icone pointant sur le dock.

CairoDock* cairo_dock_search_container_from_icon Icon icon  ) 
 

Cherche le dock contenant l'icone donnee, en parcourant la liste des icones de tous les docks jusqu'a trouver celle passee en entree.

Paramètres:
icon l'icone.
Renvoie:
le dock contenant cette icone, ou NULL si aucun n'a ete trouve.

void cairo_dock_reserve_space_for_dock CairoDock pDock,
gboolean  bReserve
 

Demande au WM d'empecher les autres fenetres d'empieter sur l'espace du dock. L'espace reserve est pris sur la taille minimale du dock, c'est-a-dire la taille de la zone de rappel si l'auto-hide est active, ou la taille du dock au repos sinon.

Paramètres:
pDock le dock.
bReserve TRUE pour reserver l'espace, FALSE pour annuler la reservation.

void cairo_dock_update_dock_size CairoDock pDock  ) 
 

Recalcule la taille maximale du dock, si par exemple une icone a ete enlevee/rajoutee. Met a jour la taille des decorations si necessaire. Le dock est deplace de maniere a rester centre sur la meme position, et les coordonnees des icones des applis sont recalculees et renvoyees au WM

Paramètres:
pDock le dock.

void cairo_dock_insert_icon_in_dock Icon icon,
CairoDock pDock,
gboolean  bUpdateSize,
gboolean  bAnimated,
gboolean  bApplyRatio
 

Insere une icone dans le dock, a la position indiquee par le champ /a fOrder. Insere un separateur si necessaire, et reserve l'espace correspondant aux nouvelles dimensions du dock si necessaire.

Paramètres:
icon l'icone a inserer.
pDock le dock dans lequel l'inserer.
bUpdateSize TRUE pour recalculer la taille du dock apres insertion.
bAnimated TRUE pour regler la taille de l'icone au minimum de facon a la faire grossir apres.
bApplyRatio TRUE pour appliquer le facteur de taille propre au sous-dock.
pDock->pFirstDrawnElement = cairo_dock_calculate_icons_positions_at_rest (pDock->icons, pDock->iFlatDockWidth, pDock->iScrollOffset);

void cairo_dock_build_docks_tree_with_desktop_files CairoDock pMainDock,
gchar *  cDirectory
 

Charge un ensemble de fichiers .desktop definissant des icones, et construit l'arborescence des docks. Toutes les icones sont creees et placees dans leur conteneur repectif, qui est cree si necessaire. Cette fonction peut tres bien s'utiliser pour A la fin du processus, chaque dock est calcule, et place a la position qui lui est assignee. Il faut fournir un dock pour avoir ujn contexte de dessin, car les icones sont crees avant leur conteneur.

Paramètres:
pMainDock un dock quelconque.
cDirectory le repertoire contenant les fichiers .desktop.

void cairo_dock_free_all_docks CairoDock pMainDock  ) 
 

Detruit tous les docks et toutes les icones contenues dedans, et libere la memoire qui leur etait allouee. Les applets sont stoppees au prealable, ainsi que la barre des taches.

Paramètres:
pMainDock le dock principal contenant les applets.
cairo_dock_pause_application_manager (); // sera fait lors de la liberation du dock.

void cairo_dock_destroy_dock CairoDock pDock,
const gchar *  cDockName,
CairoDock ReceivingDock,
gchar *  cReceivingDockName
 

Diminue le nombre d'icones pointant sur un dock de 1. Si aucune icone ne pointe plus sur lui apres ca, le detruit et libere la memoire qui lui etait allouee.

Paramètres:
pMainDock le dock a detruire.
cDockName son nom.
ReceivingDock un dock qui recuperera les icones, ou NULL pour detruire toutes les icones contenues dans le dock.
cReceivingDockName le nom du dock qui recuperera les icones, ou NULL si aucun n'est fourni.

void cairo_dock_reference_dock CairoDock pDock  ) 
 

Augmente la reference d'un dock, c'est-a-dire le nombre d'icones pointant sur ce dock. Si le dock etait auparavant un dock principal, il devient un sous-dock, prenant du meme coup les parametres propres aux sous-docks.

Paramètres:
pDock le dock.

CairoDock* cairo_dock_create_subdock_from_scratch_with_type GList *  pIconList,
gchar *  cDockName,
GdkWindowTypeHint  iWindowTypeHint
 

Cree un nouveau dock de type "sous-dock", et y insere la liste des icones fournie. La liste est appropriee par le dock, et ne doit donc _pas_ etre liberee apres cela. Chaque icone est chargee, et a donc juste besoin d'avoir un nom et un fichier d'image.

Paramètres:
pIconList une liste d'icones qui seront entierement chargees et inserees dans le dock.
cDockName le nom desire pour le dock.
iWindowTypeHint indicateur du type de fenetre pour le WM.
Renvoie:
le dock nouvellement alloue.


Documentation des variables

int g_iWmHint
 

CairoDock* g_pMainDock
 

pointeur sur le dock principal.

GHashTable* g_hDocksTable
 

table des docks existant.

gboolean g_bSameHorizontality
 

dit si les sous-docks ont la meme horizontalite que les docks racines.

double g_fSubDockSizeRatio
 

ratio de la taille des icones des sous-docks par rapport a celles du dock principal.

gboolean g_bReserveSpace
 

gchar* g_cMainDockDefaultRendererName
 

gchar* g_cSubDockDefaultRendererName
 

int g_iMaxAuthorizedWidth
 

gint g_iDockLineWidth
 

epaisseur du cadre (en pixels).

int g_iIconGap
 

ecart en pixels entre les icones.

double g_fAmplitude
 

amplitude de la siunsoide.

int g_iLabelSize
 

taille de la police des etiquettes.

gchar* g_cLabelPolice
 

police de caracteres des etiquettes.

gboolean g_bTextAlwaysHorizontal
 

TRUE <=> etiquettes horizontales meme pour les docks verticaux.

gboolean g_bAutoHide
 

TRUE si l'auto-hide est active.

gchar* g_cCurrentLaunchersPath
 

le chemin vers le repertoire des lanceurs/icones du theme courant.

gboolean g_bDirectionUp
 

la direction dans laquelle les icones grossissent. Vers le haut ou vers le bas.

int g_tIconTypeOrder[CAIRO_DOCK_NB_TYPES]
 

gchar* g_cConfFile
 

gboolean g_bKeepAbove
 

gboolean g_bSkipPager
 

gboolean g_bSkipTaskbar
 

gboolean g_bSticky
 

gboolean g_bUseGlitz
 


Généré le Fri Dec 7 13:11:02 2007 pour Cairo-Dock par  doxygen 1.4.6