XfcePanelPlugin

typedef struct _XfcePanelPlugin XfcePanelPlugin;

The XfcePanelPlugin-struct is a purely virtual object to describe an instance of a widget implementing the panel plugin interface.

XfcePanelPluginFunc ()

void        (*XfcePanelPluginFunc)          (XfcePanelPlugin *plugin);

Callback function to create the plugin contents. It should be given as the argument to the registration macros.

See also: XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL() and XFCE_PANEL_PLUGIN_REGISTER_INTERNAL()

xfce_panel_plugin_get_name ()

const char* xfce_panel_plugin_get_name      (XfcePanelPlugin *plugin);

The plugin name identifies a plugin type and therefore must be unique.

xfce_panel_plugin_get_id ()

const char* xfce_panel_plugin_get_id        (XfcePanelPlugin *plugin);

The plugin id is a unique identifier string that is given to every instance of a panel plugin.

xfce_panel_plugin_get_display_name ()

const char* xfce_panel_plugin_get_display_name
                                            (XfcePanelPlugin *plugin);

The display name is the (translated) plugin name that can be used in a user interface, e.g. a dialog or a menu.

xfce_panel_plugin_get_size ()

int         xfce_panel_plugin_get_size      (XfcePanelPlugin *plugin);

xfce_panel_plugin_get_screen_position ()

XfceScreenPosition xfce_panel_plugin_get_screen_position
                                            (XfcePanelPlugin *plugin);

xfce_panel_plugin_set_expand ()

void        xfce_panel_plugin_set_expand    (XfcePanelPlugin *plugin,
                                             gboolean expand);

Sets whether to expand the plugin when the width of the panel increases.

xfce_panel_plugin_get_expand ()

gboolean    xfce_panel_plugin_get_expand    (XfcePanelPlugin *plugin);

xfce_panel_plugin_get_orientation ()

GtkOrientation xfce_panel_plugin_get_orientation
                                            (XfcePanelPlugin *plugin);

xfce_panel_plugin_add_action_widget ()

void        xfce_panel_plugin_add_action_widget
                                            (XfcePanelPlugin *plugin,
                                             GtkWidget *widget);

Attach the plugin menu to this widget. Plugin writers should call this for every widget that can receive mouse events. If you forget to call this the plugin will not have a right-click menu and the user won't be able to remove it.

xfce_panel_plugin_menu_insert_item ()

void        xfce_panel_plugin_menu_insert_item
                                            (XfcePanelPlugin *plugin,
                                             GtkMenuItem *item);

Insert custom menu item.

xfce_panel_plugin_menu_show_about ()

void        xfce_panel_plugin_menu_show_about
                                            (XfcePanelPlugin *plugin);

Show the 'About' item in the menu. Clicking on the menu item will emit the "about" signal.

xfce_panel_plugin_menu_show_configure ()

void        xfce_panel_plugin_menu_show_configure
                                            (XfcePanelPlugin *plugin);

Show the 'Configure' item in the menu. Clicking on the menu item will emit the "configure-plugin" signal.

xfce_panel_plugin_block_menu ()

void        xfce_panel_plugin_block_menu    (XfcePanelPlugin *plugin);

Temporarily block the menu from being shown. This can be used by plugin writers when the configuration dialog is active.

See also: xfce_panel_plugin_unblock_menu()

xfce_panel_plugin_unblock_menu ()

void        xfce_panel_plugin_unblock_menu  (XfcePanelPlugin *plugin);

Don't block the menu from being shown.

See also: xfce_panel_plugin_block_menu()

xfce_panel_plugin_register_menu ()

void        xfce_panel_plugin_register_menu (XfcePanelPlugin *plugin,
                                             GtkMenu *menu);

Register an open menu. This will make sure the panel will properly handle its autohide behaviour.

xfce_panel_plugin_lookup_rc_file ()

char*       xfce_panel_plugin_lookup_rc_file
                                            (XfcePanelPlugin *plugin);

Looks up unique filename associated with plugin in standard configuration locations. Uses xfce_resource_lookup() internally.

xfce_panel_plugin_save_location ()

char*       xfce_panel_plugin_save_location (XfcePanelPlugin *plugin,
                                             gboolean create);

Unique file location that can be used to store configuration information. Uses xfce_resource_save_location() internally.

The "display-name" property

  "display-name"         gchararray            : Read

Translated plugin name. This is the name that can be presented to the user, e.g. in dialogs or menus.

Default value: NULL

The "expand" property

  "expand"               gboolean              : Read / Write

Whether to expand the plugin when the panel width increases.

Default value: FALSE

The "id" property

  "id"                   gchararray            : Read

Unique identifier string created for every XfcePanelPlugin instance.

Default value: NULL

The "name" property

  "name"                 gchararray            : Read

Untranslated plugin name. This identifies the plugin type and therefore has to be unique.

Default value: NULL

The "screen-position" property

  "screen-position"      XfceScreenPosition    : Read

The current XfceScreenPosition of the panel.

Default value: XFCE_SCREEN_POSITION_S

The "size" property

  "size"                 gint                  : Read

The current panel size.

Allowed values: [10,128]

Default value: 32

The "about" signal

void        user_function                  (XfcePanelPlugin *plugin,
                                            gpointer user_data);

Emitted when the 'About' menu item is clicked. Plugin writers should connect to this signal to show information about their plugin (and its authors).

See also: xfce_panel_plugin_menu_show_about()

The "configure-plugin" signal

void        user_function                  (XfcePanelPlugin *plugin,
                                            gpointer user_data);

Emitted when the 'Configure' menu item is clicked. Plugin writers should connect to this signal to show a settings dialog.

See also: xfce_panel_plugin_menu_show_configure()

The "free-data" signal

void        user_function                  (XfcePanelPlugin *plugin,
                                            gpointer user_data);

Emitted when the panel is closing. Plugin writers should connect to this signal to free any allocated resources.

See also: XfcePanelPlugin::save

The "orientation-changed" signal

void        user_function                  (XfcePanelPlugin *plugin,
                                            GtkOrientation orientation,
                                            gpointer user_data);

Emitted when the panel orientation changes.

The "save" signal

void        user_function                  (XfcePanelPlugin *plugin,
                                            gpointer user_data);

Emitted before the panel is closing. May be called more than once while the panel is running. Plugin writers should connect to this signal to save the plugins configuration.

See also: xfce_panel_plugin_get_rc_file()

The "screen-position-changed" signal

void        user_function                  (XfcePanelPlugin *plugin,
                                            XfceScreenPosition position,
                                            gpointer user_data);

Emitted when the screen position changes. Most plugins will be more interested in the "orientation-changed" signal.

The "size-changed" signal

gboolean    user_function                  (XfcePanelPlugin *plugin,
                                            gint size,
                                            gpointer user_data);

Emitted when the panel size changes.