Writing Plugins

Writing Plugins —

Information for plugin writers

Synopsis


#include <libxfce4panel/libxfce4panel>

#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL (construct)
#define             XFCE_PANEL_PLUGIN_REGISTER_INTERNAL (construct)
#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK(construct,check)
#define             XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK(construct,check)

Description

Macros to register a plugin with the Xfce Panel.

Details

XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL()

#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL(construct)

Registers and initializes the plugin. This is the only thing that is required to create a panel plugin.

See also: Panel Plugin interface

construct :

name of a function that can be cast to an XfcePanelPluginFunc

XFCE_PANEL_PLUGIN_REGISTER_INTERNAL()

#define             XFCE_PANEL_PLUGIN_REGISTER_INTERNAL(construct)

Registers and initializes the plugin. This is the only thing that is required to create a panel plugin.

This macro is for plugins implemented as a loadable module. Generally it is preferred to create an external plugin, for which you have to use XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL() .

See also: Panel Plugin interface

construct :

name of a function that can be cast to an XfcePanelPluginFunc

XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK()

#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK(construct,check)

Registers and initializes the plugin. This is the only thing that is required to create a panel plugin. The check functions is run before creating the plugin, and should return FALSE if plugin creation is not possible.

See also: Panel Plugin interface

`construct` :	name of a function that can be cast to an XfcePanelPluginFunc
`check` :	name of a function that can be cast to an XfcePanelPluginCheck

XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK()

#define             XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK(construct,check)

Registers and initializes the plugin. This is the only thing that is required to create a panel plugin. The check function is run before creating the plugin, and should return FALSE if plugin creation is not possible.

This macro is for plugins implemented as a loadable module. Generally it is preferred to create an external plugin, for which you have to use XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL() .

See also: Panel Plugin interface

`construct` :	name of a function that can be cast to an XfcePanelPluginFunc
`check` :	name of a function that can be cast to an XfcePanelPluginCheck

			libxfce4panel Reference Manual
Top \| Description