Geany  0.20
Functions
pluginutils.h File Reference

Plugin utility functions. More...

Functions

void plugin_add_toolbar_item (struct GeanyPlugin *plugin, GtkToolItem *item)
 Inserts a toolbar item before the Quit button, or after the previous plugin toolbar item.
void plugin_module_make_resident (struct GeanyPlugin *plugin)
 Ensures that a plugin's module (*.so) will never be unloaded.
struct GeanyKeyGroupplugin_set_key_group (struct GeanyPlugin *plugin, const gchar *section_name, gsize count, GeanyKeyGroupCallback callback)
 Sets up or resizes a keybinding group for the plugin.
void plugin_show_configure (struct GeanyPlugin *plugin)
 Shows the plugin's configure dialog.
void plugin_signal_connect (struct GeanyPlugin *plugin, GObject *object, const gchar *signal_name, gboolean after, GCallback callback, gpointer user_data)
 Connects a signal which will be disconnected on unloading the plugin, to prevent a possible segfault.

Detailed Description

Plugin utility functions.

These functions all take the geany_plugin symbol as their first argument.


Function Documentation

void plugin_add_toolbar_item ( GeanyPlugin plugin,
GtkToolItem *  item 
)

Inserts a toolbar item before the Quit button, or after the previous plugin toolbar item.

A separator is added on the first call to this function, and will be shown when item is shown; hidden when item is hidden.

Note:
You should still destroy item yourself, usually in plugin_cleanup().
Parameters:
pluginMust be geany_plugin.
itemThe item to add.
void plugin_module_make_resident ( GeanyPlugin plugin)

Ensures that a plugin's module (*.so) will never be unloaded.

This is necessary if you register new GTypes in your plugin, e.g. when using own classes using the GObject system.

Parameters:
pluginMust be geany_plugin.
Since:
0.16
struct GeanyKeyGroup* plugin_set_key_group ( GeanyPlugin plugin,
const gchar *  section_name,
gsize  count,
GeanyKeyGroupCallback  callback 
) [read]

Sets up or resizes a keybinding group for the plugin.

You should then call keybindings_set_item() for each keybinding in the group.

Parameters:
pluginMust be geany_plugin.
section_nameName used in the configuration file, such as "html_chars".
countNumber of keybindings for the group.
callbackGroup callback, or NULL if you only want individual keybinding callbacks.
Returns:
The plugin's keybinding group.
Since:
0.19.
void plugin_show_configure ( GeanyPlugin plugin)

Shows the plugin's configure dialog.

The plugin must implement one of the plugin_configure() or plugin_configure_single() symbols.

Parameters:
pluginMust be geany_plugin.
Since:
0.19.
void plugin_signal_connect ( GeanyPlugin plugin,
GObject *  object,
const gchar *  signal_name,
gboolean  after,
GCallback  callback,
gpointer  user_data 
)

Connects a signal which will be disconnected on unloading the plugin, to prevent a possible segfault.

Parameters:
pluginMust be geany_plugin.
objectObject to connect to, or NULL when using Geany signals .
signal_nameThe name of the signal. For a list of available signals, please see the Signal documentation .
afterSet to TRUE to call your handler after the main signal handlers have been called (if supported by signal_name).
callbackThe function to call when the signal is emitted.
user_dataThe user data passed to the signal handler.
See also:
plugin_callbacks.