PlumaPlugin

## PlumaPlugin PlumaPlugin |

## Synopsis

    struct              PlumaPlugin;
    void                pluma_plugin_activate               (PlumaPlugin *plugin,
                                                             PlumaWindow *window);
    void                pluma_plugin_deactivate             (PlumaPlugin *plugin,
                                                             PlumaWindow *window);
    void                pluma_plugin_update_ui              (PlumaPlugin *plugin,
                                                             PlumaWindow *window);
    gboolean            pluma_plugin_is_configurable        (PlumaPlugin *plugin);
    GtkWidget *         pluma_plugin_create_configure_dialog
                                                            (PlumaPlugin *plugin);
    #define             PLUMA_PLUGIN_REGISTER_TYPE          (PluginName,
                                                             plugin_name)

## Object Hierarchy

      GObject
       +----PlumaPlugin

## Properties

      "data-dir"                 gchar*                : Read
      "data-dir-name"            gchar*                : Write / Construct Only
      "install-dir"              gchar*                : Read / Write / Construct Only

## Description

## Details

### struct PlumaPlugin

    struct PlumaPlugin;

### pluma_plugin_activate ()

    void                pluma_plugin_activate               (PlumaPlugin *plugin,
                                                             PlumaWindow *window);

Activates the plugin.

`plugin` : | a PlumaPlugin
`window` : | a PlumaWindow

### pluma_plugin_deactivate ()

    void                pluma_plugin_deactivate             (PlumaPlugin *plugin,
                                                             PlumaWindow *window);

Deactivates the plugin.

`plugin` : | a PlumaPlugin
`window` : | a PlumaWindow

### pluma_plugin_update_ui ()

    void                pluma_plugin_update_ui              (PlumaPlugin *plugin,
                                                             PlumaWindow *window);

Triggers an update of the user interface to take into account state changes caused by the plugin.

`plugin` : | a PlumaPlugin
`window` : | a PlumaWindow

### pluma_plugin_is_configurable ()

    gboolean            pluma_plugin_is_configurable        (PlumaPlugin *plugin);

Whether the plugin is configurable.

`plugin` : | a PlumaPlugin
Returns : | TRUE if the plugin is configurable:

### pluma_plugin_create_configure_dialog ()

    GtkWidget *         pluma_plugin_create_configure_dialog
                                                            (PlumaPlugin *plugin);

Creates the configure dialog widget for the plugin.

`plugin` : | a PlumaPlugin
Returns : | the configure dialog widget for the plugin.

### PLUMA_PLUGIN_REGISTER_TYPE()

    #define             PLUMA_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)

## Property Details

### The `"data-dir"` property

      "data-dir"                 gchar*                : Read

The full path of the directory where the plugin should look for its data files.

Default value: NULL

### The `"data-dir-name"` property

      "data-dir-name"            gchar*                : Write / Construct Only

The basename of the directory where the plugin should look for its data files.

Default value: NULL

### The `"install-dir"` property

      "install-dir"              gchar*                : Read / Write / Construct Only

The directory where the plugin is installed.

Default value: NULL