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


Fonctions

cairo_surface_t * cairo_dock_create_applet_surface (gchar *cIconFileName, cairo_t *pSourceContext, double fMaxScale, double *fWidth, double *fHeight)
Iconcairo_dock_create_icon_for_applet (CairoDock *pDock, int iWidth, int iHeight, gchar *cName, gchar *cIconFileName)
GKeyFile * cairo_dock_read_header_applet_conf_file (gchar *cConfFilePath, int *iWidth, int *iHeight, gchar **cName, gboolean *bFlushConfFileNeeded)
GHashTable * cairo_dock_list_themes (gchar *cThemesDir, GHashTable *hProvidedTable, GError **erreur)
gchar * cairo_dock_check_conf_file_exists (gchar *cUserDataDirName, gchar *cShareDataDir, gchar *cConfFileName)
void cairo_dock_set_icon_surface (cairo_t *pIconContext, cairo_surface_t *pSurface)
void cairo_dock_add_reflection_to_icon (cairo_t *pIconContext, Icon *pIcon, CairoDock *pDock)
void cairo_dock_set_icon_surface_with_reflect (cairo_t *pIconContext, cairo_surface_t *pSurface, Icon *pIcon, CairoDock *pDock)
void cairo_dock_set_icon_name (cairo_t *pSourceContext, const gchar *cIconName, Icon *pIcon, CairoDock *pDock)
void cairo_dock_set_quick_info (cairo_t *pSourceContext, const gchar *cQuickInfo, Icon *pIcon)
void cairo_dock_animate_icon (Icon *pIcon, CairoDock *pDock, CairoDockAnimationType iAnimationType, int iNbRounds)

Variables

gchar * g_cCurrentThemePath
 le chemin vers le repertoire du theme courant.
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.
double g_fAlbedo
 pouvoir reflechissant du plan.
int g_tMinIconAuthorizedSize [CAIRO_DOCK_NB_TYPES]
 les tailles min et max pour chaque type d'icone.
int g_tMaxIconAuthorizedSize [CAIRO_DOCK_NB_TYPES]
gboolean g_bUseGlitz

Documentation des fonctions

cairo_surface_t* cairo_dock_create_applet_surface gchar *  cIconFileName,
cairo_t *  pSourceContext,
double  fMaxScale,
double *  fWidth,
double *  fHeight
 

Cree une surface cairo qui pourra servir de zone de dessin pour une applet.

Paramètres:
cIconFileName le nom d'un fichier image a appliquer sur la surface, ou NULL pour creer une surface vide.
pSourceContext un contexte de dessin; n'est pas altere.
fMaxScale le zoom max auquel sera soumis la surface.
fWidth largeur de la surface obtenue.
fHeight hauteur de la surface obtenue.
Renvoie:
la surface nouvellement generee.

Icon* cairo_dock_create_icon_for_applet CairoDock pDock,
int  iWidth,
int  iHeight,
gchar *  cName,
gchar *  cIconFileName
 

Cree une icone destinee a une applet.

Paramètres:
pDock le dock ou sera inseree ulterieurement cette icone.
iWidth la largeur desiree de l'icone.
iHeight la hauteur desiree de l'icone.
cName le nom de l'icone, tel qu'il apparaitra en etiquette de l'icone.
cIconFileName le nom d'un fichier image a afficher dans l'icone, ou NULL si l'on souhaitera dessiner soi-meme dans l'icone.
Renvoie:
l'icone nouvellement cree. Elle n'est _pas_ inseree dans le dock, c'est le gestionnaire de module qui se charge d'inserer les icones renvoyees par les modules.

GKeyFile* cairo_dock_read_header_applet_conf_file gchar *  cConfFilePath,
int *  iWidth,
int *  iHeight,
gchar **  cName,
gboolean *  bFlushConfFileNeeded
 

Ouvre et lit certaines cles pre-definis d'un fichier de conf. Les cles sont : "width", "height", et "name", toutes dans le groupes "ICON".

Paramètres:
cConfFilePath le chemin du fichier de conf.
iWidth la valeur lue dans la cle "width".
iHeight la valeur lue dans la cle "height".
cName la valeur lue dans la cle "name".
bFlushConfFileNeeded est positionne a TRUE si une des cles est manquante et a ete rajoutee par defaut.
Renvoie:
le fichier de cles cree a partir du fichier de conf. A liberer avec g_keyfile_free apres utilisation.

GHashTable* cairo_dock_list_themes gchar *  cThemesDir,
GHashTable *  hProvidedTable,
GError **  erreur
 

Liste les themes disponibles. Un theme est un repertoire, et tous doivent etre places dans un meme repertoire.

Paramètres:
cThemesDir le repertoire contenant les themes.
hProvidedTable une table de hashage (string , string) qui sera remplie, ou NULL pour que la fonction vous la cree.
erreur : erreur positionnee au cas ou le repertoire serait illisible.
Renvoie:
la table de hashage contenant les doublets (nom_du_theme , chemin_du_theme). Si une table avait ete fournie en entree, c'est elle qui est retournee, sinon c'est une nouvelle table, a detruire avec 'g_hash_table_destroy' apres utilisation (tous les elements seront liberes).

gchar* cairo_dock_check_conf_file_exists gchar *  cUserDataDirName,
gchar *  cShareDataDir,
gchar *  cConfFileName
 

Verifie que le fichier de conf d'un plug-in est bien present dans le repertoire utilisateur du plug-in, sinon le copie a partir du fichier de conf fournit lors de l'installation. Cree au besoin le repertoire utilisateur du plug-in.

Paramètres:
cUserDataDirName le nom du repertoire utilisateur du plug-in.
cShareDataDir le chemin du repertoire d'installation du plug-in.
cConfFileName : le nom du fichier de conf fournit a l'installation.
Renvoie:
Le chemin du fichier de conf en espace utilisateur, ou NULL si le fichier n'a pu etre ni trouve, ni cree.

void cairo_dock_set_icon_surface cairo_t *  pIconContext,
cairo_surface_t *  pSurface
 

Applique une surface sur un contexte, en effacant tout au prealable.

Paramètres:
pIconContext le contexte du dessin; est modifie par la fonction.
pSurface la surface a appliquer

void cairo_dock_add_reflection_to_icon cairo_t *  pIconContext,
Icon pIcon,
CairoDock pDock
 

Cree les surfaces de reflection d'une icone.

Paramètres:
pIconContext le contexte de dessin lie a la surface de l'icone; est modifie par la fonction.
pIcon l'icone.
pDock le dock contenant l'icone.

void cairo_dock_set_icon_surface_with_reflect cairo_t *  pIconContext,
cairo_surface_t *  pSurface,
Icon pIcon,
CairoDock pDock
 

Applique une surface sur le contexte d'une icone, en effacant tout au prealable et en creant les reflets correspondant.

Paramètres:
pIconContext le contexte de dessin lie a la surface de l'icone; est modifie par la fonction.
pSurface la surface a appliquer a l'icone.
pIcon l'icone.
pDock le dock contenant l'icone.

void cairo_dock_set_icon_name cairo_t *  pSourceContext,
const gchar *  cIconName,
Icon pIcon,
CairoDock pDock
 

Modifie l'etiquette d'une icone.

Paramètres:
pIconContext un contexte de dessin; n'est pas altere par la fonction.
cIconName la nouvelle etiquette de l'icone.
pIcon l'icone.
pDock le dock contenant l'icone.

void cairo_dock_set_quick_info cairo_t *  pSourceContext,
const gchar *  cQuickInfo,
Icon pIcon
 

Ecris une info-rapide sur l'icone. C'est un petit texte (quelques caracteres) qui vient se superposer sur l'icone, avec un fond fonce.

Paramètres:
pIconContext un contexte de dessin; n'est pas altere par la fonction.
cQuickInfo le texte de l'info-rapide.
pIcon l'icone.

void cairo_dock_animate_icon Icon pIcon,
CairoDock pDock,
CairoDockAnimationType  iAnimationType,
int  iNbRounds
 

Prepare l'animation d'une icone, et la lance immediatement.

Paramètres:
pIcon l'icone a animer.
pDock le dock contenant l'icone.
iAnimationType le type d'animation voulu, ou -1 pour utiliser l'animtion correspondante au type de l'icone.
iNbRounds le nombre de fois ou l'animation sera jouee, ou -1 pour utiliser la valeur correspondante au type de l'icone.


Documentation des variables

gchar* g_cCurrentThemePath
 

le chemin vers le repertoire du theme courant.

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.

double g_fAlbedo
 

pouvoir reflechissant du plan.

int g_tMinIconAuthorizedSize[CAIRO_DOCK_NB_TYPES]
 

les tailles min et max pour chaque type d'icone.

int g_tMaxIconAuthorizedSize[CAIRO_DOCK_NB_TYPES]
 

gboolean g_bUseGlitz
 


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