cairo-dock-gui-manager.h File Reference

Data Structures
struct	_CairoDockGuiBackend
	Definition of the GUI interface for modules. More...

Macros
#define	cairo_dock_reload_current_module_widget(pModuleInstance)

Typedefs
typedef gboolean(*	CairoDockApplyConfigFunc )(gpointer data)
	Definition of the callback called when the user apply the config panel.

Functions
void	cairo_dock_set_status_message (GtkWidget *pWindow, const gchar *cMessage)
void	cairo_dock_set_status_message_printf (GtkWidget *pWindow, const gchar *cFormat,...) G_GNUC_PRINTF(2

Detailed Description

This class provides functions to act on configuration windows.

It also defines the interface that a GUI backend should implement.

Note: GUIs are built from a .conf file; .conf files are normal group/key files, but with some special indications in the comments. Each key will be represented by a pre-defined widget, that is defined by the first caracter of its comment. The comment also contains a description of the key, and an optionnal tooltip. See cairo-dock-gui-factory.h for the list of pre-defined widgets and a short explanation on how to use them inside a conf file. The file 'cairo-dock.conf' can be an useful example.

Macro Definition Documentation

#define cairo_dock_reload_current_module_widget

(

pModuleInstance

)

Reload the widget of a given module instance if it is currently opened (the current page is displayed). This is useful if the module has modified its conf file and wishes to display the changes.

Parameters

pModuleInstance

an instance of a module.

Function Documentation

void cairo_dock_set_status_message	(	GtkWidget *	pWindow,
		const gchar *	cMessage
	)

Display a message on a given window that has a status-bar. If no window is provided, the current config panel will be used.

Parameters

pWindow	window where the message should be displayed, or NULL to target the config panel.
cMessage	the message.

void cairo_dock_set_status_message_printf	(	GtkWidget *	pWindow,
		const gchar *	cFormat,
			...
	)

Display a message on a given window that has a status-bar. If no window is provided, the current config panel will be used.

Parameters

pWindow	window where the message should be displayed, or NULL to target the config panel.
cFormat	the message, in a printf-like format
...	arguments of the format.