Référence du fichier /opt/cairo-dock/trunk/cairo-dock/src/cairo-dock-config.h

Aller au code source de ce fichier.

Macros

#define cairo_dock_edit_conf_file(pWindow, cConfFilePath, cTitle, iWindowWidth, iWindowHeight, iIdentifier, cPresentedGroup, pConfigFunc, data, pFreeUserDataFunc, cGettextDomain)   cairo_dock_edit_conf_file_full (pWindow, cConfFilePath, cTitle, iWindowWidth, iWindowHeight, iIdentifier, cPresentedGroup, pConfigFunc, data, pFreeUserDataFunc, NULL, NULL, NULL, NULL, cGettextDomain)

Fonctions

gboolean cairo_dock_get_boolean_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, gboolean bDefaultValue, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
int cairo_dock_get_integer_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, int iDefaultValue, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
double cairo_dock_get_double_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, double fDefaultValue, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
gchar * cairo_dock_get_string_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, const gchar *cDefaultValue, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
void cairo_dock_get_integer_list_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, int *iValueBuffer, int iNbElements, int *iDefaultValues, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
void cairo_dock_get_double_list_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, double *fValueBuffer, int iNbElements, double *fDefaultValues, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
gchar ** cairo_dock_get_string_list_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, gsize *length, gchar *cDefaultValues, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
CairoDockAnimationType cairo_dock_get_animation_type_key_value (GKeyFile *pKeyFile, gchar *cGroupName, gchar *cKeyName, gboolean *bFlushConfFileNeeded, CairoDockAnimationType iDefaultAnimation, gchar *cDefaultGroupName, gchar *cDefaultKeyName)
void cairo_dock_read_conf_file (gchar *cConfFilePath, CairoDock *pDock)
gboolean cairo_dock_is_loading (void)
gboolean cairo_dock_edit_conf_file_full (GtkWindow *pWindow, gchar *cConfFilePath, gchar *cTitle, int iWindowWidth, int iWindowHeight, gchar iIdentifier, gchar *cPresentedGroup, CairoDockConfigFunc pConfigFunc, gpointer data, GFunc pFreeUserDataFunc, CairoDockConfigFunc pConfigFunc2, gchar *cConfFilePath2, gchar *cButtonConvert, gchar *cButtonRevert, gchar *cGettextDomain)
void cairo_dock_update_conf_file (gchar *cConfFilePath, GType iFirstDataType,...)
void cairo_dock_update_conf_file_with_position (gchar *cConfFilePath, int x, int y)
CairoDockDesktopEnv cairo_dock_guess_environment (void)
void cairo_dock_copy_easy_conf_file (gchar *cEasyConfFilePath, GKeyFile *pMainKeyFile)
void cairo_dock_copy_to_easy_conf_file (GKeyFile *pMainKeyFile, gchar *cEasyConfFilePath)
void cairo_dock_build_easy_conf_file (gchar *cMainConfFilePath, gchar *cEasyConfFilePath)
void cairo_dock_read_easy_conf_file (gchar *cEasyConfFilePath, gpointer data)
gboolean cairo_dock_use_full_conf_file (void)
void cairo_dock_mark_prefered_conf_file (gchar *cConfFilePath)


Documentation des macros

#define cairo_dock_edit_conf_file ( pWindow,
cConfFilePath,
cTitle,
iWindowWidth,
iWindowHeight,
iIdentifier,
cPresentedGroup,
pConfigFunc,
data,
pFreeUserDataFunc,
cGettextDomain   )     cairo_dock_edit_conf_file_full (pWindow, cConfFilePath, cTitle, iWindowWidth, iWindowHeight, iIdentifier, cPresentedGroup, pConfigFunc, data, pFreeUserDataFunc, NULL, NULL, NULL, NULL, cGettextDomain)


Documentation des fonctions

gboolean cairo_dock_get_boolean_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
gboolean  bDefaultValue,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle booleene d'un fichier de cles.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
bDefaultValue valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.
Renvoie:
la valeur booleene de la cle.

int cairo_dock_get_integer_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
int  iDefaultValue,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle entiere d'un fichier de cles.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
iDefaultValue valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.
Renvoie:
la valeur entiere de la cle.

double cairo_dock_get_double_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
double  fDefaultValue,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle flottante d'un fichier de cles.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
fDefaultValue valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.
Renvoie:
la valeur flottante de la cle.

gchar* cairo_dock_get_string_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
const gchar *  cDefaultValue,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle d'un fichier de cles sous la forme d'une chaine de caractere.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
cDefaultValue valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.
Renvoie:
la chaine de caractere nouvellement allouee correspondante a la cle.

void cairo_dock_get_integer_list_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
int *  iValueBuffer,
int  iNbElements,
int *  iDefaultValues,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle d'un fichier de cles sous la forme d'un tableau d'entiers.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
iValueBuffer tableau qui sera rempli.
iNbElements nombre d'elements a recuperer; c'est le nombre d'elements du tableau passe en entree.
iDefaultValues valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.

void cairo_dock_get_double_list_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
double *  fValueBuffer,
int  iNbElements,
double *  fDefaultValues,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle d'un fichier de cles sous la forme d'un tableau de doubles.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
fValueBuffer tableau qui sera rempli.
iNbElements nombre d'elements a recuperer; c'est le nombre d'elements du tableau passe en entree.
fDefaultValues valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.

gchar** cairo_dock_get_string_list_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
gsize *  length,
gchar *  cDefaultValues,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle d'un fichier de cles sous la forme d'un tableau de chaines de caracteres.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
length nombre de chaines de caracteres recuperees.
cDefaultValues valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.
Renvoie:
un tableau de chaines de caracteres; a liberer avec g_strfreev().

CairoDockAnimationType cairo_dock_get_animation_type_key_value ( GKeyFile *  pKeyFile,
gchar *  cGroupName,
gchar *  cKeyName,
gboolean *  bFlushConfFileNeeded,
CairoDockAnimationType  iDefaultAnimation,
gchar *  cDefaultGroupName,
gchar *  cDefaultKeyName 
)

Recupere une cle d'un fichier de cles sous la forme d'un tableau de chaines de caracteres.

Paramètres:
pKeyFile le fichier de cles.
cGroupName le com du groupe.
cKeyName le nom de la cle.
bFlushConfFileNeeded est mis a TRUE si la cle est manquante.
iDefaultAnimation valeur par defaut a utiliser et a inserer dans le fichier de cles au cas ou la cle est manquante.
cDefaultGroupName nom de groupe alternatif, ou NULL si aucun autre.
cDefaultKeyName nom de cle alternative, ou NULL si aucune autre.
Renvoie:
le type de l'animation correspondante a la cle.

void cairo_dock_read_conf_file ( gchar *  cConfFilePath,
CairoDock pDock 
)

Lis le fichier de conf et recharge l'appli en consequence.

Paramètres:
cConfFilePath chemin du fichier de conf.
pDock le dock principal, cree prealablement si necessaire.

gboolean cairo_dock_is_loading ( void   ) 

Dis si l'appli est en cours de chargement.

Renvoie:
TRUE ssi le dock est en cours de rechargement.

gboolean cairo_dock_edit_conf_file_full ( GtkWindow *  pWindow,
gchar *  cConfFilePath,
gchar *  cTitle,
int  iWindowWidth,
int  iWindowHeight,
gchar  iIdentifier,
gchar *  cPresentedGroup,
CairoDockConfigFunc  pConfigFunc,
gpointer  data,
GFunc  pFreeUserDataFunc,
CairoDockConfigFunc  pConfigFunc2,
gchar *  cConfFilePath2,
gchar *  cButtonConvert,
gchar *  cButtonRevert,
gchar *  cGettextDomain 
)

Lis un fichier de conf, construit l'IHM appropriee, et la presente a l'utilisateur.

Paramètres:
pWindow fenetre pour laquelle le panneau de conf sera modal.
cConfFilePath chemin du fichier de conf.
cTitle titre du panneau de conf.
iWindowWidth largeur du panneau de conf.
iWindowHeight hauteur du panneau de conf.
iIdentifier identifiant des cles, ou 0 pour aucun.
cPresentedGroup onglet devant etre selectionne initialement.
pConfigFunc fonction appelee a l'appui sur le bouton "valider"
data donnees passees a la fonction.
pFreeUserDataFunc fonction liberant les donnees, ou NULL.
pConfigFunc2 2eme fonction dans le cas d'une config s'affichant sous 2 formes.
cConfFilePath2 2eme fichier de conf dans le cas d'une config s'affichant sous 2 formes.
cButtonConvert chaine a afficher dans le bouton permettant de passer d'une forme a l'autre.
cButtonRevert chaine a afficher dans le bouton permettant de passer d'une forme a l'autre dans l'autre sens.
cGettextDomain nom du domainde de traduction a utiliser, ou NULL pour utiliser celui du dock.
Renvoie:
TRUE si l'utilisateur a ferme le panneau de conf en appuyant sur OK, FALSE sinon.

void cairo_dock_update_conf_file ( gchar *  cConfFilePath,
GType  iFirstDataType,
  ... 
)

Met a jour un fichier de conf avec une liste de valeurs de la forme : type, nom du groupe, nom de la cle, valeur. Finir par G_TYPE_INVALID.

Paramètres:
cConfFilePath chemin du fichier de conf.
iFirstDataType type de la 1ere donnee.

void cairo_dock_update_conf_file_with_position ( gchar *  cConfFilePath,
int  x,
int  y 
)

CairoDockDesktopEnv cairo_dock_guess_environment ( void   ) 

Essaye de determiner l'environnement de bureau dela session courante.

Renvoie:
l'environnement de bureau (couramment Gnome et KDE son detectes).

void cairo_dock_copy_easy_conf_file ( gchar *  cEasyConfFilePath,
GKeyFile *  pMainKeyFile 
)

void cairo_dock_copy_to_easy_conf_file ( GKeyFile *  pMainKeyFile,
gchar *  cEasyConfFilePath 
)

void cairo_dock_build_easy_conf_file ( gchar *  cMainConfFilePath,
gchar *  cEasyConfFilePath 
)

void cairo_dock_read_easy_conf_file ( gchar *  cEasyConfFilePath,
gpointer  data 
)

gboolean cairo_dock_use_full_conf_file ( void   ) 

void cairo_dock_mark_prefered_conf_file ( gchar *  cConfFilePath  ) 


Généré le Wed Apr 16 03:27:16 2008 pour Cairo-Dock par  doxygen 1.5.3