[d80bc7]: doc / pluginsymbols.c Maximize Restore History

Download this file

pluginsymbols.c    110 lines (91 with data), 4.8 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
/*
* pluginsymbols.c - this file is part of Geany, a fast and lightweight IDE
*
* Copyright 2008-2012 Enrico Trรถger <enrico(dot)troeger(at)uvena(dot)de>
* Copyright 2008-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/* Note: this file is for Doxygen only. */
/**
* @file pluginsymbols.c
* Symbols declared from within plugins.
*
* Geany looks for these symbols (arrays, pointers and functions) when initializing
* plugins. Some of them are optional, i.e. they can be omitted; others are required
* and must be defined. Some symbols should only be declared using specific macros in
* @link plugindata.h @endlink.
*/
/** Use the PLUGIN_VERSION_CHECK() macro instead. Required by Geany.
* @return . */
gint plugin_version_check(gint);
/** Use the PLUGIN_SET_INFO() macro to define it. Required by Geany.
* This function is called before the plugin is initialized, so Geany
* can read the plugin's name.
* @param info The data struct which should be initialized by this function. */
void plugin_set_info(PluginInfo *info);
/** @deprecated Use @ref GeanyPlugin.info instead.
* Basic information about a plugin, which is set in plugin_set_info(). */
const PluginInfo *plugin_info;
/** Basic information for the plugin and identification. */
const GeanyPlugin *geany_plugin;
/** Geany owned data pointers.
* Example: @c assert(geany_data->app->configdir != NULL); */
const GeanyData *geany_data;
/** Geany owned function pointers, split into groups.
* Example: @code #include "geanyfunctions.h"
* ...
* document_new_file(NULL, NULL, NULL); @endcode
* This is equivalent of @c geany_functions->p_document->document_new_file(NULL, NULL, NULL); */
const GeanyFunctions *geany_functions;
/** @deprecated Use @ref ui_add_document_sensitive() instead.
* Plugin owned fields, including flags. */
PluginFields *plugin_fields;
/** An array for connecting GeanyObject events, which should be terminated with
* @c {NULL, NULL, FALSE, NULL}. See @link pluginsignals.c Signal documentation @endlink.
* @see plugin_signal_connect(). */
PluginCallback plugin_callbacks[];
/** Plugins must use the PLUGIN_KEY_GROUP() macro to define it.
* To setup a variable number of keybindings, e.g. based on the
* plugin's configuration file settings, use plugin_set_key_group() instead. */
KeyBindingGroup *plugin_key_group;
/** Called before showing the plugin preferences dialog for multiple plugins.
* Can be omitted when not needed.
* The dialog will show all plugins that support this symbol together.
* @param dialog The plugin preferences dialog widget - this should only be used to
* connect the @c "response" signal. If settings should be read from the dialog, the
* reponse will be either @c GTK_RESPONSE_OK or @c GTK_RESPONSE_APPLY.
* @return A container widget holding preference widgets.
* @note Using @link stash.h Stash @endlink can make implementing preferences easier.
* @see plugin_configure_single(). */
GtkWidget *plugin_configure(GtkDialog *dialog);
/** Called when a plugin should show a preferences dialog, if plugin_configure() has not been
* implemented.
* @warning It's better to implement plugin_configure() instead, but this is simpler.
* This does not integrate as well with the multiple-plugin dialog.
* @param parent Pass this as the parent widget if showing a dialog.
* @see plugin_configure(). */
void plugin_configure_single(GtkWidget *parent);
/** Called after loading the plugin.
* @param data The same as #geany_data. */
void plugin_init(GeanyData *data);
/** Called before unloading the plugin. Required for normal plugins - it should undo
* everything done in plugin_init() - e.g. destroy menu items, free memory. */
void plugin_cleanup();
/** Called whenever the plugin should show its documentation (if any). This may open a dialog,
* a browser with a website or a local installed HTML help file(see utils_open_browser())
* or something else.
* Can be omitted when not needed. */
void plugin_help();