geany  1.38
About: Geany is a text editor (using GTK2) with basic features of an integrated development environment (syntax highlighting, code folding, symbol name auto-completion, ...). F: office T: editor programming GTK+ IDE
  Fossies Dox: geany-1.38.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  
Public Attributes | List of all members
GeanyPluginFuncs Struct Reference

Callback functions that need to be implemented for every plugin. More...

#include <plugindata.h>

Collaboration diagram for GeanyPluginFuncs:
[legend]

Public Attributes

PluginCallback * callbacks
 Array of plugin-provided signal handlers. More...
 
gboolean(* init )(GeanyPlugin *plugin, gpointer pdata)
 Called to initialize the plugin, when the user activates it (must not be NULL) More...
 
GtkWidget *(* configure )(GeanyPlugin *plugin, GtkDialog *dialog, gpointer pdata)
 plugins configure dialog, optional (can be NULL) More...
 
void(* help )(GeanyPlugin *plugin, gpointer pdata)
 Called when the plugin should show some help, optional (can be NULL) More...
 
void(* cleanup )(GeanyPlugin *plugin, gpointer pdata)
 Called when the plugin is disabled or when Geany exits (must not be NULL) More...
 

Detailed Description

Callback functions that need to be implemented for every plugin.

These callbacks should be registered by the plugin within Geany's call to geany_load_module() by calling geany_plugin_register() with an instance of this type.

Geany will then call the callbacks at appropriate times. Each gets passed the plugin-defined data pointer as well as the corresponding GeanyPlugin instance pointer.

Since
1.26 (API 225)
See also
Plugin HowTo

Definition at line 295 of file plugindata.h.

Member Data Documentation

◆ callbacks

PluginCallback* GeanyPluginFuncs::callbacks

Array of plugin-provided signal handlers.

See also
PluginCallback

Definition at line 298 of file plugindata.h.

Referenced by geany_load_module(), plugin_load(), and register_legacy_plugin().

◆ cleanup

void(* GeanyPluginFuncs::cleanup) (GeanyPlugin *plugin, gpointer pdata)

Called when the plugin is disabled or when Geany exits (must not be NULL)

Definition at line 306 of file plugindata.h.

Referenced by demoproxy_load(), geany_load_module(), geany_plugin_register(), plugin_cleanup(), and register_legacy_plugin().

◆ configure

GtkWidget *(* GeanyPluginFuncs::configure) (GeanyPlugin *plugin, GtkDialog *dialog, gpointer pdata)

plugins configure dialog, optional (can be NULL)

Definition at line 302 of file plugindata.h.

Referenced by create_pref_page(), geany_load_module(), plugin_show_configure(), plugins_have_preferences(), pm_update_buttons(), and register_legacy_plugin().

◆ help

void(* GeanyPluginFuncs::help) (GeanyPlugin *plugin, gpointer pdata)

Called when the plugin should show some help, optional (can be NULL)

Definition at line 304 of file plugindata.h.

Referenced by demoproxy_load(), geany_load_module(), pm_on_plugin_button_clicked(), pm_update_buttons(), and register_legacy_plugin().

◆ init

gboolean(* GeanyPluginFuncs::init) (GeanyPlugin *plugin, gpointer pdata)

Called to initialize the plugin, when the user activates it (must not be NULL)

Definition at line 300 of file plugindata.h.

Referenced by demoproxy_load(), geany_load_module(), geany_plugin_register(), plugin_load(), and register_legacy_plugin().

The documentation for this struct was generated from the following file: