PeasUIConfigurable

PeasUIConfigurable — Interface for configurable plugins.

Synopsis

#define             PEAS_UI_CONFIGURABLE_IFACE          (obj)
                    PeasUIConfigurable;
                    PeasUIConfigurableInterface;
GtkWidget *         peas_ui_configurable_create_configure_widget
                                                        (PeasUIConfigurable *configurable);

Object Hierarchy

  GInterface
   +----PeasUIConfigurable

Prerequisites

PeasUIConfigurable requires GObject.

Description

The PeasUIConfigurable interface will allow a PeasPlugin to provide a graphical interface for the user to configure the plugin through the PeasUIPluginManager: the PeasUIPluginManager will make the “Configure Plugin” button active when the selected plugin implements the PeasUIConfigurable interface.

To do so, the plugin writer will just need to implement the create_configure_widget() method.

Details

PEAS_UI_CONFIGURABLE_IFACE()

#define PEAS_UI_CONFIGURABLE_IFACE(obj)        (G_TYPE_CHECK_CLASS_CAST ((obj), PEAS_UI_TYPE_CONFIGURABLE, PeasUIConfigurableInterface))

PeasUIConfigurable

typedef struct _PeasUIConfigurable PeasUIConfigurable;

PeasUIConfigurableInterface

typedef struct {
  GTypeInterface g_iface;

  GtkWidget  *(*create_configure_widget)  (PeasUIConfigurable  *configurable);
} PeasUIConfigurableInterface;

peas_ui_configurable_create_configure_widget ()

GtkWidget *         peas_ui_configurable_create_configure_widget
                                                        (PeasUIConfigurable *configurable);

Creates the configure widget widget for the plugin.

The default implementation returns NULL.

configurable :

A PeasUIConfigurable

Returns :

A GtkWindow used for configuration.