Référence du fichier src/cairo-dock-icons.h

Aller au code source de ce fichier.

Macros

#define CAIRO_DOCK_IS_APPLI(icon)   (icon != NULL && icon->iType == CAIRO_DOCK_APPLI)
#define CAIRO_DOCK_IS_LAUNCHER(icon)   (icon != NULL && icon->iType == CAIRO_DOCK_LAUNCHER)
#define CAIRO_DOCK_IS_SEPARATOR(icon)   (icon != NULL && icon->iType & 1)
#define CAIRO_DOCK_IS_APPLET(icon)   (icon != NULL && icon->iType == CAIRO_DOCK_APPLET)
#define CAIRO_DOCK_IS_NORMAL_LAUNCHER(icon)   (CAIRO_DOCK_IS_LAUNCHER (icon) && icon->acDesktopFileName != NULL)
#define CAIRO_DOCK_IS_URI_LAUNCHER(icon)   (CAIRO_DOCK_IS_LAUNCHER (icon) && icon->cBaseURI != NULL)
#define CAIRO_DOCK_IS_VALID_APPLI(icon)   (CAIRO_DOCK_IS_APPLI (icon) && icon->Xid != 0)
#define CAIRO_DOCK_IS_VALID_APPLET(icon)   (CAIRO_DOCK_IS_APPLET (icon) && icon->pModule != NULL)
#define cairo_dock_get_next_element(ic, list)   (ic->next == NULL ? list : ic->next)
#define cairo_dock_get_previous_element(ic, list)   (ic->prev == NULL ? g_list_last (list) : ic->prev)
#define cairo_dock_none_clicked(pIconList)   (cairo_dock_get_bouncing_icon (pIconList) == NULL)
#define cairo_dock_none_removed_or_inserted(pIconList)   (cairo_dock_get_removing_or_inserting_icon (pIconList) == NULL)
#define cairo_dock_none_animated(pIconList)   (cairo_dock_get_animated_icon (pIconList) == NULL)
#define cairo_dock_get_first_launcher(pIconList)   cairo_dock_get_first_icon_of_type (pIconList, CAIRO_DOCK_LAUNCHER)
#define cairo_dock_get_last_launcher(pIconList)   cairo_dock_get_last_icon_of_type (pIconList, CAIRO_DOCK_LAUNCHER)
#define cairo_dock_get_first_appli(pIconList)   cairo_dock_get_first_icon_of_type (pIconList, CAIRO_DOCK_APPLI)
#define cairo_dock_get_last_appli(pIconList)   cairo_dock_get_last_icon_of_type (pIconList, CAIRO_DOCK_APPLI)
#define cairo_dock_remove_all_applis(pDock)   cairo_dock_remove_icons_of_type (pDock, CAIRO_DOCK_APPLI)
#define cairo_dock_remove_all_applets(pDock)   cairo_dock_remove_icons_of_type (pDock, CAIRO_DOCK_APPLET)

Fonctions

void cairo_dock_free_icon (Icon *icon)
int cairo_dock_compare_icons_order (Icon *icon1, Icon *icon2)
GList * cairo_dock_sort_icons_by_order (GList *pIconList)
GList * cairo_dock_sort_icons_by_name (GList *pIconList)
Iconcairo_dock_get_first_icon (GList *pIconList)
Iconcairo_dock_get_last_icon (GList *pIconList)
Iconcairo_dock_get_first_drawn_icon (CairoDock *pDock)
Iconcairo_dock_get_last_drawn_icon (CairoDock *pDock)
Iconcairo_dock_get_first_icon_of_type (GList *pIconList, CairoDockIconType iType)
Iconcairo_dock_get_last_icon_of_type (GList *pIconList, CairoDockIconType iType)
Iconcairo_dock_get_pointed_icon (GList *pIconList)
Iconcairo_dock_get_bouncing_icon (GList *pIconList)
Iconcairo_dock_get_removing_or_inserting_icon (GList *pIconList)
Iconcairo_dock_get_animated_icon (GList *pIconList)
Iconcairo_dock_get_next_icon (GList *pIconList, Icon *pIcon)
Iconcairo_dock_get_previous_icon (GList *pIconList, Icon *pIcon)
Iconcairo_dock_get_icon_with_command (GList *pIconList, gchar *cCommand)
Iconcairo_dock_get_icon_with_base_uri (GList *pIconList, gchar *cBaseURI)
Iconcairo_dock_get_icon_with_subdock (GList *pIconList, CairoDock *pSubDock)
Iconcairo_dock_get_icon_with_module (GList *pIconList, CairoDockModule *pModule)
Iconcairo_dock_get_icon_with_class (GList *pIconList, gchar *cClass)
void cairo_dock_swap_icons (CairoDock *pDock, Icon *icon1, Icon *icon2)
void cairo_dock_move_icon_after_icon (CairoDock *pDock, Icon *icon1, Icon *icon2)
void cairo_dock_detach_icon_from_dock (Icon *icon, CairoDock *pDock, gboolean bCheckUnusedSeparator)
void cairo_dock_remove_one_icon_from_dock (CairoDock *pDock, Icon *icon)
void cairo_dock_remove_icon_from_dock (CairoDock *pDock, Icon *icon)
void cairo_dock_remove_icons_of_type (CairoDock *pDock, CairoDockIconType iType)
void cairo_dock_remove_all_separators (CairoDock *pDock)
void cairo_dock_insert_separator_between_launchers_and_applis (CairoDock *pDock)
GList * cairo_dock_calculate_icons_positions_at_rest_linear (GList *pIconList, int iMinDockWidth, int iXOffset)
Iconcairo_dock_calculate_wave_with_position_linear (GList *pIconList, GList *pFirstDrawnElement, int x_abs, gdouble fMagnitude, int iMinDockWidth, int iWidth, int iHeight, double fAlign, double fLateralFactor)
Iconcairo_dock_apply_wave_effect (CairoDock *pDock)
CairoDockMousePositionType cairo_dock_check_if_mouse_inside_linear (CairoDock *pDock)
void cairo_dock_manage_mouse_position (CairoDock *pDock, CairoDockMousePositionType iMousePositionType)
double cairo_dock_calculate_max_dock_width (CairoDock *pDock, GList *pFirstDrawnElement, int iFlatDockWidth, double fWidthConstraintFactor, double fExtraWidth)
void cairo_dock_mark_icons_as_avoiding_mouse (CairoDock *pDock, CairoDockIconType iType, double fMargin)
void cairo_dock_mark_avoiding_mouse_icons_linear (CairoDock *pDock)
void cairo_dock_stop_marking_icons (CairoDock *pDock)
void cairo_dock_update_icon_s_container_name (Icon *icon, const gchar *cNewParentDockName)


Documentation des macros

#define CAIRO_DOCK_IS_APPLI ( icon   )     (icon != NULL && icon->iType == CAIRO_DOCK_APPLI)

TRUE ssi l'icone est une icone de lanceur.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_LAUNCHER ( icon   )     (icon != NULL && icon->iType == CAIRO_DOCK_LAUNCHER)

TRUE ssi l'icone est une icone d'appli.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_SEPARATOR ( icon   )     (icon != NULL && icon->iType & 1)

TRUE ssi l'icone est une icone de separateur.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_APPLET ( icon   )     (icon != NULL && icon->iType == CAIRO_DOCK_APPLET)

TRUE ssi l'icone est une icone d'applet.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_NORMAL_LAUNCHER ( icon   )     (CAIRO_DOCK_IS_LAUNCHER (icon) && icon->acDesktopFileName != NULL)

TRUE ssi l'icone est une icone de lanceur defini par un fichier .desktop.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_URI_LAUNCHER ( icon   )     (CAIRO_DOCK_IS_LAUNCHER (icon) && icon->cBaseURI != NULL)

TRUE ssi l'icone est une icone de lanceur representant une URI.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_VALID_APPLI ( icon   )     (CAIRO_DOCK_IS_APPLI (icon) && icon->Xid != 0)

TRUE ssi l'icone est une icone d'appli correspondant a une ressource X valide.

Paramètres:
icon une icone.

#define CAIRO_DOCK_IS_VALID_APPLET ( icon   )     (CAIRO_DOCK_IS_APPLET (icon) && icon->pModule != NULL)

TRUE ssi l'icone est une icone d'applet possedant un module valide.

Paramètres:
icon une icone.

#define cairo_dock_get_next_element ( ic,
list   )     (ic->next == NULL ? list : ic->next)

Renvoie le prochain element dans la liste, en bouclant si necessaire.

Paramètres:
ic l'element courant.
list la liste d'icones. l'element suivant de la liste bouclee.

#define cairo_dock_get_previous_element ( ic,
list   )     (ic->prev == NULL ? g_list_last (list) : ic->prev)

Renvoie l'element precedent dans la liste, en bouclant si necessaire.

Paramètres:
ic l'element courant.
list la liste d'icones. l'element precedent de la liste bouclee.

#define cairo_dock_none_clicked ( pIconList   )     (cairo_dock_get_bouncing_icon (pIconList) == NULL)

#define cairo_dock_none_removed_or_inserted ( pIconList   )     (cairo_dock_get_removing_or_inserting_icon (pIconList) == NULL)

#define cairo_dock_none_animated ( pIconList   )     (cairo_dock_get_animated_icon (pIconList) == NULL)

#define cairo_dock_get_first_launcher ( pIconList   )     cairo_dock_get_first_icon_of_type (pIconList, CAIRO_DOCK_LAUNCHER)

#define cairo_dock_get_last_launcher ( pIconList   )     cairo_dock_get_last_icon_of_type (pIconList, CAIRO_DOCK_LAUNCHER)

#define cairo_dock_get_first_appli ( pIconList   )     cairo_dock_get_first_icon_of_type (pIconList, CAIRO_DOCK_APPLI)

#define cairo_dock_get_last_appli ( pIconList   )     cairo_dock_get_last_icon_of_type (pIconList, CAIRO_DOCK_APPLI)

#define cairo_dock_remove_all_applis ( pDock   )     cairo_dock_remove_icons_of_type (pDock, CAIRO_DOCK_APPLI)

Enleve et detruit toutes les icones d'applications.

Paramètres:
pDock le dock duquel supprimer les icones.

#define cairo_dock_remove_all_applets ( pDock   )     cairo_dock_remove_icons_of_type (pDock, CAIRO_DOCK_APPLET)

Enleve et detruit toutes les icones d'applets.

Paramètres:
pDock le dock duquel supprimer les icones.


Documentation des fonctions

void cairo_dock_free_icon ( Icon icon  ) 

Libere toutes les ressources liees a une icone, ainsi que cette derniere. Le sous-dock pointee par elle n'est pas dereferencee, cela doit etre fait au prealable.

Paramètres:
icon l'icone a liberer.

int cairo_dock_compare_icons_order ( Icon icon1,
Icon icon2 
)

Compare 2 icones grace a la relation d'ordre sur le couple (position du type , ordre).

Paramètres:
icon1 une icone.
icon2 une autre icone. -1 si icone1 < icone2, 1 si icone1 > icone2, 0 si icone1 = icone2 (au sens de la relation d'ordre).

GList* cairo_dock_sort_icons_by_order ( GList *  pIconList  ) 

Trie une liste en se basant sur la relation d'ordre sur le couple (position du type , ordre).

Paramètres:
pIconList la liste d'icones. la liste triee. Les elements sont les memes que ceux de la liste initiale, seul leur ordre a change.

GList* cairo_dock_sort_icons_by_name ( GList *  pIconList  ) 

Trie une liste en se basant sur la relation d'ordre alphanumerique sur le nom des icones.

Paramètres:
pIconList la liste d'icones. la liste triee. Les elements sont les memes que ceux de la liste initiale, seul leur ordre a change. Les ordres des icones sont mis a jour pour refleter le nouvel ordre global.

Icon* cairo_dock_get_first_icon ( GList *  pIconList  ) 

Renvoie la 1ere icone d'une liste d'icones.

Paramètres:
pIconList la liste d'icones. la 1ere icone, ou NULL si la liste est vide.

Icon* cairo_dock_get_last_icon ( GList *  pIconList  ) 

Renvoie la derniere icone d'une liste d'icones.

Paramètres:
pIconList la liste d'icones. la derniere icone, ou NULL si la liste est vide.

Icon* cairo_dock_get_first_drawn_icon ( CairoDock pDock  ) 

Renvoie la 1ere icone a etre dessinee d'une liste d'icones (qui n'est pas forcement la 1ere icone de la liste, si l'utilisateur a scrolle).

Paramètres:
pIconList la liste d'icones. la 1ere icone a etre dessinee, ou NULL si la liste est vide.

Icon* cairo_dock_get_last_drawn_icon ( CairoDock pDock  ) 

Renvoie la derniere icone a etre dessinee d'une liste d'icones (qui n'est pas forcement la derniere icone de la liste, si l'utilisateur a scrolle).

Paramètres:
pIconList la liste d'icones. la derniere icone a etre dessinee, ou NULL si la liste est vide.

Icon* cairo_dock_get_first_icon_of_type ( GList *  pIconList,
CairoDockIconType  iType 
)

Renvoie la 1ere icone du type donne.

Paramètres:
pIconList la liste d'icones.
iType le type d'icone recherche. la 1ere icone trouvee ayant ce type, ou NULL si aucune icone n'est trouvee.

Icon* cairo_dock_get_last_icon_of_type ( GList *  pIconList,
CairoDockIconType  iType 
)

Renvoie la derniere icone du type donne.

Paramètres:
pIconList la liste d'icones.
iType le type d'icone recherche. la derniere icone trouvee ayant ce type, ou NULL si aucune icone n'est trouvee.

Icon* cairo_dock_get_pointed_icon ( GList *  pIconList  ) 

Renvoie l'icone actuellement pointee parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones. l'icone dont le champ bPointed a TRUE, ou NULL si aucune icone n'est pointee.

Icon* cairo_dock_get_bouncing_icon ( GList *  pIconList  ) 

Renvoie l'icone actuellement en cours d'animation due a un clique parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones. la 1ere icone dont le champ iCount est > 0 ou NULL si aucune icone n'est en cours d'animation.

Icon * cairo_dock_get_removing_or_inserting_icon ( GList *  pIconList  ) 

Renvoie l'icone actuellement en cours d'insertion ou de suppression parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones. la 1ere icone dont le champ fPersonnalScale est non nul ou NULL si aucune icone n'est en cours d'insertion / suppression.

Icon* cairo_dock_get_animated_icon ( GList *  pIconList  ) 

Renvoie l'icone actuellement en cours d'animation (due a un clique ou a une insertion / suppression) parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones. la 1ere icone dont le champ iCount est > 0 ou le champ fPersonnalScale est non nul, ou NULL si aucune icone n'est en cours d'animation.

Icon* cairo_dock_get_next_icon ( GList *  pIconList,
Icon pIcon 
)

Renvoie l'icone suivante dans la liste d'icones. Cout en O(n).

Paramètres:
pIconList la liste d'icones. l'icone dont le voisin de gauche est pIcon, ou NULL si pIcon est la derniere icone de la liste.

Icon* cairo_dock_get_previous_icon ( GList *  pIconList,
Icon pIcon 
)

Renvoie l'icone precedente dans la liste d'icones. Cout en O(n).

Paramètres:
pIconList la liste d'icones. l'icone dont le voisin de droite est pIcon, ou NULL si pIcon est la 1ere icone de la liste.

Icon* cairo_dock_get_icon_with_command ( GList *  pIconList,
gchar *  cCommand 
)

Cherche l'icone ayant une commande donnee parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones.
cCommand la chaine de commande. la 1ere icone ayant le champ acExec identique a la commande fournie, ou NULL si aucune icone ne correspond.

Icon* cairo_dock_get_icon_with_base_uri ( GList *  pIconList,
gchar *  cBaseURI 
)

Cherche l'icone ayant une URI de base donnee parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones.
cBaseURI l'URI. la 1ere icone ayant le champ cBaseURI identique a l'URI fournie, ou NULL si aucune icone ne correspond.

Icon* cairo_dock_get_icon_with_subdock ( GList *  pIconList,
CairoDock pSubDock 
)

Cherche l'icone pointant sur un sous-dock donne parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones.
pSubDock le sous-dock. la 1ere icone ayant le champ pSubDock identique au sous-dock fourni, ou NULL si aucune icone ne correspond.

Icon* cairo_dock_get_icon_with_module ( GList *  pIconList,
CairoDockModule pModule 
)

Cherche l'icone correspondante a un module donne parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones.
pModule le module. la 1ere icone ayant le champ pModule identique au module fourni, ou NULL si aucune icone ne correspond.

Icon* cairo_dock_get_icon_with_class ( GList *  pIconList,
gchar *  cClass 
)

Cherche l'icone d'une application de la classe donnee parmi une liste d'icones.

Paramètres:
pIconList la liste d'icones.
pModule le module. la 1ere icone ayant le champ cClass identique a la classe fournie, ou NULL si aucune icone ne correspond.

void cairo_dock_swap_icons ( CairoDock pDock,
Icon icon1,
Icon icon2 
)

void cairo_dock_move_icon_after_icon ( CairoDock pDock,
Icon icon1,
Icon icon2 
)

void cairo_dock_detach_icon_from_dock ( Icon icon,
CairoDock pDock,
gboolean  bCheckUnusedSeparator 
)

Detache une icone de son dock, en enlevant les separateurs superflus si necessaires. L'icone n'est pas detruite, et peut etre re-inseree autre part telle qu'elle; elle garde son sous-dock, mais perd son dialogue.

Paramètres:
icon l'icone a detacher.
pDock le dock contenant l'icone.
bCheckUnusedSeparator si TRUE, alors teste si des separateurs sont devenus superflus, et les enleve le cas echeant.

void cairo_dock_remove_one_icon_from_dock ( CairoDock pDock,
Icon icon 
)

Detache une icone de son dock, sans verifier la presence de separateurs superflus. L'icone n'est pas detruite, et garde son sous-dock, mais perd son dialogue et est fermee (son .desktop est detruit, son module est desactive, et son Xid est effacee du registre (la classe est geree aussi)).

Paramètres:
pDock le dock contenant l'icone.
icon l'icone a detacher.

void cairo_dock_remove_icon_from_dock ( CairoDock pDock,
Icon icon 
)

Detache une icone de son dock, en enlevant les separateurs superflus si necessaires. L'icone n'est pas detruite, et garde son sous-dock, mais perd son dialogue et est fermee (son .desktop est detruit, son module est desactive, et son Xid est effacee du registre (la classe est geree aussi)).

Paramètres:
pDock le dock contenant l'icone.
icon l'icone a detacher.

void cairo_dock_remove_icons_of_type ( CairoDock pDock,
CairoDockIconType  iType 
)

Enleve et detruit toutes les icones dont le type est celui fourni.

Paramètres:
pDock le dock contenant l'icone.
iType le type d'icones a supprimer.

void cairo_dock_remove_all_separators ( CairoDock pDock  ) 

Enleve et detruit toutes les icones de separateurs.

Paramètres:
pDock le dock duquel supprimer les icones.

void cairo_dock_insert_separator_between_launchers_and_applis ( CairoDock pDock  ) 

Rajoute un separateur entre lanceurs et applis si necessaire.

Paramètres:
pDock le dock ou se situent les applis.

GList* cairo_dock_calculate_icons_positions_at_rest_linear ( GList *  pIconList,
int  iMinDockWidth,
int  iXOffset 
)

Icon* cairo_dock_calculate_wave_with_position_linear ( GList *  pIconList,
GList *  pFirstDrawnElement,
int  x_abs,
gdouble  fMagnitude,
int  iMinDockWidth,
int  iWidth,
int  iHeight,
double  fAlign,
double  fLateralFactor 
)

Icon* cairo_dock_apply_wave_effect ( CairoDock pDock  ) 

CairoDockMousePositionType cairo_dock_check_if_mouse_inside_linear ( CairoDock pDock  ) 

void cairo_dock_manage_mouse_position ( CairoDock pDock,
CairoDockMousePositionType  iMousePositionType 
)

double cairo_dock_calculate_max_dock_width ( CairoDock pDock,
GList *  pFirstDrawnElement,
int  iFlatDockWidth,
double  fWidthConstraintFactor,
double  fExtraWidth 
)

void cairo_dock_mark_icons_as_avoiding_mouse ( CairoDock pDock,
CairoDockIconType  iType,
double  fMargin 
)

void cairo_dock_mark_avoiding_mouse_icons_linear ( CairoDock pDock  ) 

void cairo_dock_stop_marking_icons ( CairoDock pDock  ) 

void cairo_dock_update_icon_s_container_name ( Icon icon,
const gchar *  cNewParentDockName 
)

Met a jour le fichier .desktop d'un lanceur avec le nom de son nouveau conteneur.

Paramètres:
icon l'icone du lanceur.
cNewParentDockName le nom de son nouveau conteneur.


Généré le Tue Dec 11 02:26:43 2007 pour Cairo-Dock par  doxygen 1.5.3