Cairo-Dock
3.4.0
|
Functions | |
void | cairo_dock_update_conf_file (const gchar *cConfFilePath, GType iFirstDataType,...) |
void | cairo_dock_write_keys_to_conf_file (GKeyFile *pKeyFile, const gchar *cConfFilePath) |
gboolean | cairo_dock_export_current_theme (const gchar *cNewThemeName, gboolean bSaveBehavior, gboolean bSaveLaunchers) |
gboolean | cairo_dock_package_current_theme (const gchar *cThemeName, const gchar *cDirPath) |
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) |
GldiTask * | cairo_dock_import_theme_async (const gchar *cThemeName, gboolean bLoadBehavior, gboolean bLoadLaunchers, GFunc pCallback, gpointer data) |
void | cairo_dock_set_paths (gchar *cRootDataDirPath, gchar *cExtraDirPath, gchar *cThemesDirPath, gchar *cCurrentThemeDirPath, gchar *cLocalThemeDirPath, gchar *cDistantThemeDirName, gchar *cThemeServerAdress) |
This class defines the structure of the global theme (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.
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.
cConfFilePath | path to the conf file. |
iFirstDataType | type of the first value. |
void cairo_dock_write_keys_to_conf_file | ( | GKeyFile * | pKeyFile, |
const gchar * | cConfFilePath | ||
) |
Write a key file on the disk.
pKeyFile | the key-file |
cConfFilePath | its path on the disk |
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.
cNewThemeName | name to export the theme to. |
bSaveBehavior | whether to save the behavior parameters too. |
bSaveLaunchers | whether to save the launchers too. |
gboolean cairo_dock_package_current_theme | ( | const gchar * | cThemeName, |
const gchar * | cDirPath | ||
) |
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 cDirPath directory (or $HOME if cDirPath is wrong).
cThemeName | name of the package. |
cDirPath | path to the directory |
gchar* cairo_dock_depackage_theme | ( | const gchar * | cPackagePath | ) |
Extract a package into the themes folder. Does not load it.
cPackagePath | path of a package. If the package is distant, it is first downoladed. |
gboolean cairo_dock_delete_themes | ( | gchar ** | cThemesList | ) |
Remove some exported themes from the hard-disk.
cThemesList | a list of theme names, NULL-terminated. |
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.
cThemeName | name of the theme to import. |
bLoadBehavior | whether to import the behavior parameters too. |
bLoadLaunchers | whether to import the launchers too. |
GldiTask* 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). Note that only downloading or unpacking the theme is done asynchronously, actually copying the files in the current theme folder is not (because it couldn't be cancelled without first making a backup).
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. |
void cairo_dock_set_paths | ( | gchar * | cRootDataDirPath, |
gchar * | cExtraDirPath, | ||
gchar * | cThemesDirPath, | ||
gchar * | cCurrentThemeDirPath, | ||
gchar * | cLocalThemeDirPath, | ||
gchar * | cDistantThemeDirName, | ||
gchar * | cThemeServerAdress | ||
) |
Define the paths of themes. Do it just after 'gldi_init'.
cRootDataDirPath | path to the root folder of libgldi |
cExtraDirPath | path to the extras themes (plug-in themes) |
cThemesDirPath | path to the user themes |
cCurrentThemeDirPath | path to the current theme |
cLocalThemeDirPath | path to the installed themes (default themes) |
cDistantThemeDirName | folder of the themes on the server |
cThemeServerAdress | adress of the themes server |