<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Geany: plugindata.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Geany
 <span id="projectnumber">1.24.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">plugindata.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This file defines the plugin API, the interface between Geany and its plugins.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyData.html">GeanyData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This contains pointers to global variables owned by Geany for plugins to use. <a href="structGeanyData.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyFunctions.html">GeanyFunctions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This contains pointers to functions owned by Geany for plugins to use. <a href="structGeanyFunctions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyKeyGroupInfo.html">GeanyKeyGroupInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyPlugin.html">GeanyPlugin</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Basic information for the plugin and identification. <a href="structGeanyPlugin.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPluginCallback.html">PluginCallback</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Callback array entry type used with the <a class="el" href="pluginsymbols_8c.html#a753d2b26ab82f3a842f79de59b4fbc0d">plugin_callbacks</a> symbol. <a href="structPluginCallback.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPluginFields.html">PluginFields</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPluginInfo.html">PluginInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Basic information about a plugin available to Geany without loading the plugin. <a href="structPluginInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSciFuncs.html">SciFuncs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper functions for Scintilla messages. <a href="structSciFuncs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structScintillaFuncs.html">ScintillaFuncs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">See <a href="http://scintilla.org">http://scintilla.org</a> for the full documentation. <a href="structScintillaFuncs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa2c852f06e6539b50b8c2ced261cdc06"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#aa2c852f06e6539b50b8c2ced261cdc06">DOC_IDX</a>(doc_ptr)   (doc_ptr ? doc_ptr->index : -1)</td></tr>
<tr class="separator:aa2c852f06e6539b50b8c2ced261cdc06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69d30df92bfae95283506199fdd1ce7c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a69d30df92bfae95283506199fdd1ce7c">geany</a>   <a class="el" href="pluginsymbols_8c.html#afc005e8bf9cdd3d61185166b8626c9f1">geany_data</a></td></tr>
<tr class="memdesc:a69d30df92bfae95283506199fdd1ce7c"><td class="mdescLeft"> </td><td class="mdescRight">Simple macro for <code>geany_data</code> that reduces typing. <a href="#a69d30df92bfae95283506199fdd1ce7c">More...</a><br /></td></tr>
<tr class="separator:a69d30df92bfae95283506199fdd1ce7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81ace29a6d7fb7cce2b59100fe3f6d71"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a81ace29a6d7fb7cce2b59100fe3f6d71">GEANY_ABI_VERSION</a>   (69 << GEANY_ABI_SHIFT)</td></tr>
<tr class="memdesc:a81ace29a6d7fb7cce2b59100fe3f6d71"><td class="mdescLeft"> </td><td class="mdescRight">The Application Binary Interface (ABI) version, incremented whenever existing fields in the plugin data types have to be changed or reordered. <a href="#a81ace29a6d7fb7cce2b59100fe3f6d71">More...</a><br /></td></tr>
<tr class="separator:a81ace29a6d7fb7cce2b59100fe3f6d71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d1708483d7fa6382cbb70a611fe1edf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a0d1708483d7fa6382cbb70a611fe1edf">GEANY_API_VERSION</a>   217</td></tr>
<tr class="memdesc:a0d1708483d7fa6382cbb70a611fe1edf"><td class="mdescLeft"> </td><td class="mdescRight">The Application Programming Interface (API) version, incremented whenever any plugin data types are modified or appended to. <a href="#a0d1708483d7fa6382cbb70a611fe1edf">More...</a><br /></td></tr>
<tr class="separator:a0d1708483d7fa6382cbb70a611fe1edf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2eb3065bda0a491378cce54d59c77ab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#ae2eb3065bda0a491378cce54d59c77ab">PLUGIN_KEY_GROUP</a>(group_name, key_count)</td></tr>
<tr class="separator:ae2eb3065bda0a491378cce54d59c77ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38301c1368e7b8880da0a8b9850cd21c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a38301c1368e7b8880da0a8b9850cd21c">PLUGIN_SET_INFO</a>(p_name, p_description, p_version, p_author)</td></tr>
<tr class="memdesc:a38301c1368e7b8880da0a8b9850cd21c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the plugin name and some other basic information about a plugin. <a href="#a38301c1368e7b8880da0a8b9850cd21c">More...</a><br /></td></tr>
<tr class="separator:a38301c1368e7b8880da0a8b9850cd21c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a743dd012631a99ec7dad6945fd6d66a7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a743dd012631a99ec7dad6945fd6d66a7">PLUGIN_SET_TRANSLATABLE_INFO</a>(localedir, package, p_name, p_description, p_version, p_author)</td></tr>
<tr class="memdesc:a743dd012631a99ec7dad6945fd6d66a7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the plugin name and some other basic information about a plugin. <a href="#a743dd012631a99ec7dad6945fd6d66a7">More...</a><br /></td></tr>
<tr class="separator:a743dd012631a99ec7dad6945fd6d66a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68c850fc7108c65909f4340da8c16df9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a68c850fc7108c65909f4340da8c16df9">PLUGIN_VERSION_CHECK</a>(api_required)</td></tr>
<tr class="memdesc:a68c850fc7108c65909f4340da8c16df9"><td class="mdescLeft"> </td><td class="mdescRight">Defines a function to check the plugin is safe to load. <a href="#a68c850fc7108c65909f4340da8c16df9">More...</a><br /></td></tr>
<tr class="separator:a68c850fc7108c65909f4340da8c16df9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa8edbc789a7502baacdfa68775ee62f8"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structGeanyData.html">GeanyData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#aa8edbc789a7502baacdfa68775ee62f8">GeanyData</a></td></tr>
<tr class="memdesc:aa8edbc789a7502baacdfa68775ee62f8"><td class="mdescLeft"> </td><td class="mdescRight">This contains pointers to global variables owned by Geany for plugins to use. <a href="#aa8edbc789a7502baacdfa68775ee62f8">More...</a><br /></td></tr>
<tr class="separator:aa8edbc789a7502baacdfa68775ee62f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf82a06ce9f444abeb79302acc28365b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structGeanyFunctions.html">GeanyFunctions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#adf82a06ce9f444abeb79302acc28365b">GeanyFunctions</a></td></tr>
<tr class="memdesc:adf82a06ce9f444abeb79302acc28365b"><td class="mdescLeft"> </td><td class="mdescRight">This contains pointers to functions owned by Geany for plugins to use. <a href="#adf82a06ce9f444abeb79302acc28365b">More...</a><br /></td></tr>
<tr class="separator:adf82a06ce9f444abeb79302acc28365b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b5039d888394f7d2a202940383eb8a4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structGeanyKeyGroupInfo.html">GeanyKeyGroupInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a9b5039d888394f7d2a202940383eb8a4">GeanyKeyGroupInfo</a></td></tr>
<tr class="separator:a9b5039d888394f7d2a202940383eb8a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47a5615e008cf1c4cce34a467f04e55e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structGeanyPlugin.html">GeanyPlugin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a47a5615e008cf1c4cce34a467f04e55e">GeanyPlugin</a></td></tr>
<tr class="memdesc:a47a5615e008cf1c4cce34a467f04e55e"><td class="mdescLeft"> </td><td class="mdescRight">Basic information for the plugin and identification. <a href="#a47a5615e008cf1c4cce34a467f04e55e">More...</a><br /></td></tr>
<tr class="separator:a47a5615e008cf1c4cce34a467f04e55e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1892afde8d35b1622ee9d393ade33024"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPluginCallback.html">PluginCallback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a1892afde8d35b1622ee9d393ade33024">PluginCallback</a></td></tr>
<tr class="memdesc:a1892afde8d35b1622ee9d393ade33024"><td class="mdescLeft"> </td><td class="mdescRight">Callback array entry type used with the <a class="el" href="pluginsymbols_8c.html#a753d2b26ab82f3a842f79de59b4fbc0d">plugin_callbacks</a> symbol. <a href="#a1892afde8d35b1622ee9d393ade33024">More...</a><br /></td></tr>
<tr class="separator:a1892afde8d35b1622ee9d393ade33024"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f8742c1d3bb2b5067d68d332f9116f9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPluginFields.html">PluginFields</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a5f8742c1d3bb2b5067d68d332f9116f9">PluginFields</a></td></tr>
<tr class="separator:a5f8742c1d3bb2b5067d68d332f9116f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1093ecb5f3b307296d6db665e23a5a0b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structPluginInfo.html">PluginInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a1093ecb5f3b307296d6db665e23a5a0b">PluginInfo</a></td></tr>
<tr class="memdesc:a1093ecb5f3b307296d6db665e23a5a0b"><td class="mdescLeft"> </td><td class="mdescRight">Basic information about a plugin available to Geany without loading the plugin. <a href="#a1093ecb5f3b307296d6db665e23a5a0b">More...</a><br /></td></tr>
<tr class="separator:a1093ecb5f3b307296d6db665e23a5a0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada3741410865aad5bdc9fc174a3e5559"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structSciFuncs.html">SciFuncs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#ada3741410865aad5bdc9fc174a3e5559">SciFuncs</a></td></tr>
<tr class="memdesc:ada3741410865aad5bdc9fc174a3e5559"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper functions for Scintilla messages. <a href="#ada3741410865aad5bdc9fc174a3e5559">More...</a><br /></td></tr>
<tr class="separator:ada3741410865aad5bdc9fc174a3e5559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfefbb72d12b130013c1c6ab5036cebd"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structScintillaFuncs.html">ScintillaFuncs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#abfefbb72d12b130013c1c6ab5036cebd">ScintillaFuncs</a></td></tr>
<tr class="memdesc:abfefbb72d12b130013c1c6ab5036cebd"><td class="mdescLeft"> </td><td class="mdescRight">See <a href="http://scintilla.org">http://scintilla.org</a> for the full documentation. <a href="#abfefbb72d12b130013c1c6ab5036cebd">More...</a><br /></td></tr>
<tr class="separator:abfefbb72d12b130013c1c6ab5036cebd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a28260529f369340185f2e56eeea67e70"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="plugindata_8h.html#a28260529f369340185f2e56eeea67e70">PluginFlags</a> { <a class="el" href="plugindata_8h.html#a28260529f369340185f2e56eeea67e70a1e01ac9806c13eb36a0946434b45340d">PLUGIN_IS_DOCUMENT_SENSITIVE</a> = 1 << 0
}</td></tr>
<tr class="separator:a28260529f369340185f2e56eeea67e70"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file defines the plugin API, the interface between Geany and its plugins. </p>
<p>For detailed documentation of the plugin system please read the plugin API documentation. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="aa2c852f06e6539b50b8c2ced261cdc06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DOC_IDX</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">doc_ptr</td><td>)</td>
<td>   (doc_ptr ? doc_ptr->index : -1)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd><ul>
<li>copy into your plugin code if needed.</li>
</ul>
</dd></dl>
<p><code>NULL-safe</code> way to get the index of <em>doc_ptr</em> in the documents array. </p>
</div>
</div>
<a class="anchor" id="a69d30df92bfae95283506199fdd1ce7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define geany   <a class="el" href="pluginsymbols_8c.html#afc005e8bf9cdd3d61185166b8626c9f1">geany_data</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simple macro for <code>geany_data</code> that reduces typing. </p>
</div>
</div>
<a class="anchor" id="a81ace29a6d7fb7cce2b59100fe3f6d71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GEANY_ABI_VERSION   (69 << GEANY_ABI_SHIFT)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Application Binary Interface (ABI) version, incremented whenever existing fields in the plugin data types have to be changed or reordered. </p>
<p>Changing this forces all plugins to be recompiled before Geany can load them. </p>
</div>
</div>
<a class="anchor" id="a0d1708483d7fa6382cbb70a611fe1edf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GEANY_API_VERSION   217</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Application Programming Interface (API) version, incremented whenever any plugin data types are modified or appended to. </p>
<p>You can protect code that needs a higher API than e.g. 200 with: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  #if GEANY_API_VERSION >= 200</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  some_newer_function();</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> #endif </div>
</div><!-- fragment --><dl class="section warning"><dt>Warning</dt><dd>You should not test for values below 200 as previously <code>GEANY_API_VERSION</code> was defined as an enum value, not a macro. </dd></dl>
</div>
</div>
<a class="anchor" id="ae2eb3065bda0a491378cce54d59c77ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLUGIN_KEY_GROUP</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">group_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">key_count </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="comment">/* We have to declare this as a single element array.</span></div>
<div class="line"><span class="comment"> * Declaring as a pointer to a struct doesn't work with g_module_symbol(). */</span> <a class="code" href="plugindata_8h.html#a9b5039d888394f7d2a202940383eb8a4">\</a></div>
<div class="line"><a class="code" href="plugindata_8h.html#a9b5039d888394f7d2a202940383eb8a4"> GeanyKeyGroupInfo</a> plugin_key_group_info[1] = \</div>
<div class="line"> { \</div>
<div class="line"> {G_STRINGIFY(group_name), key_count} \</div>
<div class="line"> };<a class="code" href="keybindings_8h.html#aefa298762bfea498cd191d805754c008">\</a></div>
<div class="line"><a class="code" href="keybindings_8h.html#aefa298762bfea498cd191d805754c008"> GeanyKeyGroup</a> *<a class="code" href="pluginsymbols_8c.html#a134385720470fc5102cb63abd8dd4622">plugin_key_group</a> = NULL;</div>
<div class="ttc" id="keybindings_8h_html_aefa298762bfea498cd191d805754c008"><div class="ttname"><a href="keybindings_8h.html#aefa298762bfea498cd191d805754c008">GeanyKeyGroup</a></div><div class="ttdeci">struct GeanyKeyGroup GeanyKeyGroup</div><div class="ttdoc">A collection of keybindings grouped together. </div><div class="ttdef"><b>Definition:</b> keybindings.h:58</div></div>
<div class="ttc" id="plugindata_8h_html_a9b5039d888394f7d2a202940383eb8a4"><div class="ttname"><a href="plugindata_8h.html#a9b5039d888394f7d2a202940383eb8a4">GeanyKeyGroupInfo</a></div><div class="ttdeci">struct GeanyKeyGroupInfo GeanyKeyGroupInfo</div></div>
<div class="ttc" id="pluginsymbols_8c_html_a134385720470fc5102cb63abd8dd4622"><div class="ttname"><a href="pluginsymbols_8c.html#a134385720470fc5102cb63abd8dd4622">plugin_key_group</a></div><div class="ttdeci">KeyBindingGroup * plugin_key_group</div><div class="ttdoc">Plugins must use the PLUGIN_KEY_GROUP() macro to define it. </div><div class="ttdef"><b>Definition:</b> pluginsymbols.c:74</div></div>
</div><!-- fragment --><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd><ul>
<li>use <a class="el" href="pluginutils_8h.html#ae8eeecc54d81ce05457e04ad98028a68" title="Sets up or resizes a keybinding group for the plugin. ">plugin_set_key_group()</a> instead.</li>
</ul>
</dd></dl>
<p>Declare and initialise a keybinding group. </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> GeanyKeyGroup *plugin_key_group; </div>
</div><!-- fragment --><p> You must then set the <code>plugin_key_group::keys</code>[] entries for the group in <a class="el" href="pluginsymbols_8c.html#aa962b949eadd24aeaf003b1b290c6612" title="Called after loading the plugin. ">plugin_init()</a>, normally using <a class="el" href="keybindings_8h.html#a3b50ee5ee6000d83c8a93d8989daa551" title="Fills a GeanyKeyBinding struct item. ">keybindings_set_item()</a>. The <code>plugin_key_group::label</code> field is set by Geany after <code><a class="el" href="pluginsymbols_8c.html#aa962b949eadd24aeaf003b1b290c6612" title="Called after loading the plugin. ">plugin_init()</a></code> is called, to the name of the plugin. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">group_name</td><td>A unique group name (without quotes) to be used in the configuration file, such as <code>html_chars</code>. </td></tr>
<tr><td class="paramname">key_count</td><td>The number of keybindings the group will hold. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a38301c1368e7b8880da0a8b9850cd21c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLUGIN_SET_INFO</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">p_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_description, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_version, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_author </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="pluginsymbols_8c.html#a100a813dae754878057e25f0ea00c5ac">plugin_set_info</a>(<a class="code" href="structPluginInfo.html">PluginInfo</a> *info) \</div>
<div class="line"> { \</div>
<div class="line"> info->name = (p_name); \</div>
<div class="line"> info->description = (p_description); \</div>
<div class="line"> info->version = (p_version); \</div>
<div class="line"> info->author = (p_author); \</div>
<div class="line"> }</div>
<div class="ttc" id="pluginsymbols_8c_html_a100a813dae754878057e25f0ea00c5ac"><div class="ttname"><a href="pluginsymbols_8c.html#a100a813dae754878057e25f0ea00c5ac">plugin_set_info</a></div><div class="ttdeci">void plugin_set_info(PluginInfo *info)</div><div class="ttdoc">Use the PLUGIN_SET_INFO() macro to define it. </div></div>
<div class="ttc" id="structPluginInfo_html"><div class="ttname"><a href="structPluginInfo.html">PluginInfo</a></div><div class="ttdoc">Basic information about a plugin available to Geany without loading the plugin. </div><div class="ttdef"><b>Definition:</b> plugindata.h:94</div></div>
</div><!-- fragment -->
<p>Sets the plugin name and some other basic information about a plugin. </p>
<dl class="section note"><dt>Note</dt><dd>If you want some of the arguments to be translated, see <a class="el" href="plugindata_8h.html#a743dd012631a99ec7dad6945fd6d66a7">PLUGIN_SET_TRANSLATABLE_INFO()</a></dd></dl>
<p>Example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> PLUGIN_SET_INFO("Cool Feature", "Adds cool feature support.", "0.1", "Joe Author") </div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a743dd012631a99ec7dad6945fd6d66a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLUGIN_SET_TRANSLATABLE_INFO</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">localedir, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">package, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_description, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_version, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">p_author </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="pluginsymbols_8c.html#a100a813dae754878057e25f0ea00c5ac">plugin_set_info</a>(<a class="code" href="structPluginInfo.html">PluginInfo</a> *info) \</div>
<div class="line"> { <a class="code" href="main_8h.html#a8b772d8f4006401807e76d4f57e6a5fc">\</a></div>
<div class="line"><a class="code" href="main_8h.html#a8b772d8f4006401807e76d4f57e6a5fc"> main_locale_init</a>((localedir), (package)); \</div>
<div class="line"> info->name = (p_name); \</div>
<div class="line"> info->description = (p_description); \</div>
<div class="line"> info->version = (p_version); \</div>
<div class="line"> info->author = (p_author); \</div>
<div class="line"> }</div>
<div class="ttc" id="pluginsymbols_8c_html_a100a813dae754878057e25f0ea00c5ac"><div class="ttname"><a href="pluginsymbols_8c.html#a100a813dae754878057e25f0ea00c5ac">plugin_set_info</a></div><div class="ttdeci">void plugin_set_info(PluginInfo *info)</div><div class="ttdoc">Use the PLUGIN_SET_INFO() macro to define it. </div></div>
<div class="ttc" id="main_8h_html_a8b772d8f4006401807e76d4f57e6a5fc"><div class="ttname"><a href="main_8h.html#a8b772d8f4006401807e76d4f57e6a5fc">main_locale_init</a></div><div class="ttdeci">void main_locale_init(const gchar *locale_dir, const gchar *gettext_package)</div><div class="ttdoc">Initialises the gettext translation system. </div><div class="ttdef"><b>Definition:</b> main.c:479</div></div>
<div class="ttc" id="structPluginInfo_html"><div class="ttname"><a href="structPluginInfo.html">PluginInfo</a></div><div class="ttdoc">Basic information about a plugin available to Geany without loading the plugin. </div><div class="ttdef"><b>Definition:</b> plugindata.h:94</div></div>
</div><!-- fragment -->
<p>Sets the plugin name and some other basic information about a plugin. </p>
<p>This macro is like <a class="el" href="plugindata_8h.html#a38301c1368e7b8880da0a8b9850cd21c">PLUGIN_SET_INFO()</a> but allows the passed information to be translated by setting up the translation mechanism with <a class="el" href="main_8h.html#a8b772d8f4006401807e76d4f57e6a5fc">main_locale_init()</a>. You therefore don't need to call it manually in <a class="el" href="pluginsymbols_8c.html#aa962b949eadd24aeaf003b1b290c6612" title="Called after loading the plugin. ">plugin_init()</a>.</p>
<p>Example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> PLUGIN_SET_TRANSLATABLE_INFO(LOCALEDIR, GETTEXT_PACKAGE, _("Cool Feature"), _("Adds a cool feature."), "0.1", "John Doe") </div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>0.19 </dd></dl>
</div>
</div>
<a class="anchor" id="a68c850fc7108c65909f4340da8c16df9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLUGIN_VERSION_CHECK</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">api_required</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">gint <a class="code" href="pluginsymbols_8c.html#a02238186945c26ea04e20410daf5b209">plugin_version_check</a>(gint abi_ver) \</div>
<div class="line"> { \</div>
<div class="line"> if (abi_ver != <a class="code" href="plugindata_8h.html#a81ace29a6d7fb7cce2b59100fe3f6d71">GEANY_ABI_VERSION</a>) \</div>
<div class="line"> return -1; \</div>
<div class="line"> return (api_required); \</div>
<div class="line"> }</div>
<div class="ttc" id="pluginsymbols_8c_html_a02238186945c26ea04e20410daf5b209"><div class="ttname"><a href="pluginsymbols_8c.html#a02238186945c26ea04e20410daf5b209">plugin_version_check</a></div><div class="ttdeci">gint plugin_version_check(gint)</div><div class="ttdoc">Use the PLUGIN_VERSION_CHECK() macro instead. </div></div>
<div class="ttc" id="plugindata_8h_html_a81ace29a6d7fb7cce2b59100fe3f6d71"><div class="ttname"><a href="plugindata_8h.html#a81ace29a6d7fb7cce2b59100fe3f6d71">GEANY_ABI_VERSION</a></div><div class="ttdeci">#define GEANY_ABI_VERSION</div><div class="ttdoc">The Application Binary Interface (ABI) version, incremented whenever existing fields in the plugin da...</div><div class="ttdef"><b>Definition:</b> plugindata.h:72</div></div>
</div><!-- fragment -->
<p>Defines a function to check the plugin is safe to load. </p>
<p>This performs runtime checks that try to ensure:</p><ul>
<li>Geany ABI data types are compatible with this plugin.</li>
<li>Geany sources provide the required API for this plugin. <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">api_required</td><td>The minimum API number your plugin requires. Look at the source for the value of <code>GEANY_API_VERSION</code> to use if you want your plugin to require the current Geany version on your machine. You should update this value when using any new API features. </td></tr>
</table>
</dd>
</dl>
</li>
</ul>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="aa8edbc789a7502baacdfa68775ee62f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structGeanyData.html">GeanyData</a>
<a class="el" href="structGeanyData.html">GeanyData</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This contains pointers to global variables owned by Geany for plugins to use. </p>
<p>Core variable pointers can be appended when needed by plugin authors, if appropriate. </p>
</div>
</div>
<a class="anchor" id="adf82a06ce9f444abeb79302acc28365b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structGeanyFunctions.html">GeanyFunctions</a>
<a class="el" href="structGeanyFunctions.html">GeanyFunctions</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This contains pointers to functions owned by Geany for plugins to use. </p>
<p>Functions from the core can be appended when needed by plugin authors, but may require some changes. </p>
</div>
</div>
<a class="anchor" id="a9b5039d888394f7d2a202940383eb8a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structGeanyKeyGroupInfo.html">GeanyKeyGroupInfo</a>
<a class="el" href="structGeanyKeyGroupInfo.html">GeanyKeyGroupInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd><ul>
<li>use <a class="el" href="pluginutils_8h.html#ae8eeecc54d81ce05457e04ad98028a68" title="Sets up or resizes a keybinding group for the plugin. ">plugin_set_key_group()</a> instead.</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="plugindata_8h.html#ae2eb3065bda0a491378cce54d59c77ab">PLUGIN_KEY_GROUP()</a> macro. </dd></dl>
</div>
</div>
<a class="anchor" id="a47a5615e008cf1c4cce34a467f04e55e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structGeanyPlugin.html">GeanyPlugin</a>
<a class="el" href="structGeanyPlugin.html">GeanyPlugin</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic information for the plugin and identification. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="pluginsymbols_8c.html#a7b50f49a0e368449584d4ff547a64c47" title="Basic information for the plugin and identification. ">geany_plugin</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a1892afde8d35b1622ee9d393ade33024"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPluginCallback.html">PluginCallback</a>
<a class="el" href="structPluginCallback.html">PluginCallback</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback array entry type used with the <a class="el" href="pluginsymbols_8c.html#a753d2b26ab82f3a842f79de59b4fbc0d">plugin_callbacks</a> symbol. </p>
</div>
</div>
<a class="anchor" id="a5f8742c1d3bb2b5067d68d332f9116f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPluginFields.html">PluginFields</a>
<a class="el" href="structPluginFields.html">PluginFields</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Use <a class="el" href="ui__utils_8h.html#a3b072394dd863cdacf0441d066b28184">ui_add_document_sensitive()</a> instead.</dd></dl>
<p>Fields set and owned by the plugin. </p>
</div>
</div>
<a class="anchor" id="a1093ecb5f3b307296d6db665e23a5a0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structPluginInfo.html">PluginInfo</a>
<a class="el" href="structPluginInfo.html">PluginInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic information about a plugin available to Geany without loading the plugin. </p>
<p>The fields are set in <a class="el" href="pluginsymbols_8c.html#a100a813dae754878057e25f0ea00c5ac" title="Use the PLUGIN_SET_INFO() macro to define it. ">plugin_set_info()</a>, usually with the <a class="el" href="plugindata_8h.html#a38301c1368e7b8880da0a8b9850cd21c" title="Sets the plugin name and some other basic information about a plugin. ">PLUGIN_SET_INFO()</a> macro. </p>
</div>
</div>
<a class="anchor" id="ada3741410865aad5bdc9fc174a3e5559"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structSciFuncs.html">SciFuncs</a>
<a class="el" href="structSciFuncs.html">SciFuncs</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrapper functions for Scintilla messages. </p>
<p>See <a class="el" href="sciwrappers_8h.html" title="Wrapper functions for the Scintilla editor widget SCI_* messages. ">sciwrappers.h</a> for the list of functions. </p>
</div>
</div>
<a class="anchor" id="abfefbb72d12b130013c1c6ab5036cebd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structScintillaFuncs.html">ScintillaFuncs</a>
<a class="el" href="structScintillaFuncs.html">ScintillaFuncs</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a href="http://scintilla.org">http://scintilla.org</a> for the full documentation. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a28260529f369340185f2e56eeea67e70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="plugindata_8h.html#a28260529f369340185f2e56eeea67e70">PluginFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Use <a class="el" href="ui__utils_8h.html#a3b072394dd863cdacf0441d066b28184">ui_add_document_sensitive()</a> instead.</dd></dl>
<p>Flags to be set by plugins in <a class="el" href="structPluginFields.html">PluginFields</a> struct. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a28260529f369340185f2e56eeea67e70a1e01ac9806c13eb36a0946434b45340d"></a>PLUGIN_IS_DOCUMENT_SENSITIVE </td><td class="fielddoc">
<p>Whether a plugin's menu item should be disabled when there are no open documents. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 17 2014 05:13:17 for Geany by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
0c00422fba9a46710101d04f3f3175e7
>
files
>
126
