GeditPlugin

GeditPlugin

Synopsis

                    GeditPlugin;
void                gedit_plugin_activate               (GeditPlugin *plugin,
                                                         GeditWindow *window);
void                gedit_plugin_deactivate             (GeditPlugin *plugin,
                                                         GeditWindow *window);
void                gedit_plugin_update_ui              (GeditPlugin *plugin,
                                                         GeditWindow *window);
gboolean            gedit_plugin_is_configurable        (GeditPlugin *plugin);
GtkWidget *         gedit_plugin_create_configure_dialog
                                                        (GeditPlugin *plugin);
#define             GEDIT_PLUGIN_REGISTER_TYPE          (PluginName, plugin_name)

Object Hierarchy

  GObject
   +----GeditPlugin

Description

Details

GeditPlugin

typedef struct _GeditPlugin GeditPlugin;


gedit_plugin_activate ()

void                gedit_plugin_activate               (GeditPlugin *plugin,
                                                         GeditWindow *window);

Activates the plugin.

plugin :

a GeditPlugin

window :

a GeditWindow

gedit_plugin_deactivate ()

void                gedit_plugin_deactivate             (GeditPlugin *plugin,
                                                         GeditWindow *window);

Deactivates the plugin.

plugin :

a GeditPlugin

window :

a GeditWindow

gedit_plugin_update_ui ()

void                gedit_plugin_update_ui              (GeditPlugin *plugin,
                                                         GeditWindow *window);

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

plugin :

a GeditPlugin

window :

a GeditWindow

gedit_plugin_is_configurable ()

gboolean            gedit_plugin_is_configurable        (GeditPlugin *plugin);

Whether the plugin is configurable.

plugin :

a GeditPlugin

Returns :

TRUE if the plugin is configurable:

gedit_plugin_create_configure_dialog ()

GtkWidget *         gedit_plugin_create_configure_dialog
                                                        (GeditPlugin *plugin);

Creates the configure dialog widget for the plugin.

plugin :

a GeditPlugin

Returns :

the configure dialog widget for the plugin.

GEDIT_PLUGIN_REGISTER_TYPE()

#define             GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)

Utility macro used to register plugins.

PluginName :

plugin_name :