cairo-dock-config.h File Reference

Defines
#define	cairo_dock_get_pango_weight_from_1_9(iWeight)
Functions
void	cairo_dock_load_config (const gchar *cConfFilePath)
gboolean	cairo_dock_is_loading (void)
void	cairo_dock_update_conf_file (const gchar *cConfFilePath, GType iFirstDataType,...)
void	cairo_dock_get_version_from_string (const gchar *cVersionString, int *iMajorVersion, int *iMinorVersion, int *iMicroVersion)
void	cairo_dock_decrypt_string (const gchar *cEncryptedString, gchar **cDecryptedString)
void	cairo_dock_encrypt_string (const gchar *cDecryptedString, gchar **cEncryptedString)
void	cairo_dock_load_current_theme (void)

---

Detailed Description

This class manages the configuration system of Cairo-Dock. Cairo-Dock and any items (icons, root docks, modules, etc) are configured by conf files. Conf files containes some information usable by the GUI manager to build a corresponding config panel and update the conf file automatically, which relieves you from this thankless task.

---

Define Documentation

#define cairo_dock_get_pango_weight_from_1_9

(

iWeight

)

Convert an integer in [0,9] into a Pango text weight.

Parameters:

iWeight

weight between 0 and 9.

---

Function Documentation

void cairo_dock_load_config

(

const gchar *

cConfFilePath

)

Load the Cairo-Dock's config and everything.

Parameters:

cConfFilePath

path to the main conf file.

gboolean cairo_dock_is_loading

(

void

)

Say if Cairo-Dock is loading.

Returns:

TRUE if the global config is being loaded (this happens when a theme is loaded).

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

Update a conf file with a list of values of the form : {type, name of the groupe, name of the key, value}. Must end with G_TYPE_INVALID.

Parameters:

cConfFilePath	path to the conf file.
iFirstDataType	type of the first value.

void cairo_dock_get_version_from_string	(	const gchar *	cVersionString,
		int *	iMajorVersion,
		int *	iMinorVersion,
		int *	iMicroVersion
	)

Get the 3 version numbers of a string.

Parameters:

cVersionString	the string of the form "x.y.z".
iMajorVersion	pointer to the major version.
iMinorVersion	pointer to the minor version.
iMicroVersion	pointer to the micro version.

void cairo_dock_decrypt_string	(	const gchar *	cEncryptedString,
		gchar **	cDecryptedString
	)

Decrypt a string (uses DES-encryption from libcrypt).

Parameters:

cEncryptedString	the encrypted string.
cDecryptedString	the decrypted string.

void cairo_dock_encrypt_string	(	const gchar *	cDecryptedString,
		gchar **	cEncryptedString
	)

Encrypt a string (uses DES-encryption from libcrypt).

Parameters:

cDecryptedString	the decrypted string.
cEncryptedString	the encrypted string.

void cairo_dock_load_current_theme

(

void

)

Load the current theme. This will (re)load all the parameters of Cairo-Dock and all the plug-ins, as if you just started the dock.