cairo-dock-themes-manager.h File Reference

Functions
gboolean	cairo_dock_export_current_theme (const gchar *cNewThemeName, gboolean bSaveBehavior, gboolean bSaveLaunchers)
gboolean	cairo_dock_package_current_theme (const gchar *cThemeName)
gchar *	cairo_dock_depackage_theme (const gchar *cPackagePath)
gboolean	cairo_dock_delete_themes (gchar **cThemesList)
gboolean	cairo_dock_import_theme (const gchar *cThemeName, gboolean bLoadBehavior, gboolean bLoadLaunchers)
CairoDockTask *	cairo_dock_import_theme_async (const gchar *cThemeName, gboolean bLoadBehavior, gboolean bLoadLaunchers, GFunc pCallback, gpointer data)

---

Detailed Description

This class allows defines the structure of the global theme of the dock (launchers, icons, plug-ins, configuration files, etc). It also provides methods to manage the themes, like exporting the current theme, importing new themes, deleting themes, etc.

---

Function Documentation

gboolean cairo_dock_export_current_theme	(	const gchar *	cNewThemeName,
		gboolean	bSaveBehavior,
		gboolean	bSaveLaunchers
	)

Export the current theme to a given name. Exported themes can be imported directly from the Theme Manager.

Parameters:

cNewThemeName	name to export the theme to.
bSaveBehavior	whether to save the behavior paremeters too.
bSaveLaunchers	whether to save the launchers too.

Returns:

TRUE if the theme could be exported succefuly.

gboolean cairo_dock_package_current_theme

(

const gchar *

cThemeName

)

Create a package of the current theme. Packages can be distributed easily, and imported into the dock by a mere drag and drop into the Theme Manager. The package is placed in the Home.

Parameters:

cThemeName

name of the package.

Returns:

TRUE if the theme could be packaged succefuly.

gchar* cairo_dock_depackage_theme

(

const gchar *

cPackagePath

)

Extract a package into the themes folder. Does not load it.

Parameters:

cPackagePath

path of a package. If the package is distant, it is first downoladed.

Returns:

the path of the theme folder, or NULL if anerror occured.

gboolean cairo_dock_delete_themes

(

gchar **

cThemesList

)

Remove some exported themes from the hard-disk.

Parameters:

cThemesList

a list of theme names, NULL-terminated.

Returns:

TRUE if the themes has been succefuly deleted.

gboolean cairo_dock_import_theme	(	const gchar *	cThemeName,
		gboolean	bLoadBehavior,
		gboolean	bLoadLaunchers
	)

Import a theme, which can be : a local theme, a user theme, a distant theme, or even the path to a packaged theme.

Parameters:

cThemeName	name of the theme to import.
bLoadBehavior	whether to import the behavior parameters too.
bLoadLaunchers	whether to import the launchers too.

Returns:

TRUE if the theme could be imported succefuly.

CairoDockTask* cairo_dock_import_theme_async	(	const gchar *	cThemeName,
		gboolean	bLoadBehavior,
		gboolean	bLoadLaunchers,
		GFunc	pCallback,
		gpointer	data
	)

Asynchronously import a theme, which can be : a local theme, a user theme, a distant theme, or even the path to a packaged theme. This function is non-blocking, you'll get a CairoTask that you can discard at any time, and you'll get the result of the import as the first argument of the callback (the second being the data you passed to this function).

Parameters:

cThemeName	name of the theme to import.
bLoadBehavior	whether to import the behavior parameters too.
bLoadLaunchers	whether to import the launchers too.
pCallback	function called when the download is finished. It takes the result of the import (TRUE for a successful import) and the data you've set here.
data	data to be passed to the callback.

Returns:

the Task that is doing the job. Keep it and use cairo_dock_discard_task if you want to discard the download before it's completed (for instance if the user cancels it), or cairo_dock_free_task inside your callback.