Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/Remmina/remminadoc.gitlab.io.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntenore Gatta <antenore@simbiosi.org>2022-04-18 02:47:20 +0300
committerAntenore Gatta <antenore@simbiosi.org>2022-04-18 02:47:20 +0300
commit33426106b99c0a282bd6239371ae3ebe08166fab (patch)
tree14a882b109e5cc5b408908e63becac55480a3809 /public/remmina__plugin__python_8c.html
parentc3b3c7dd0c93f6f527bc8a53bbbd598d05701ea6 (diff)
Automatic doc build by remmina-ci
Diffstat (limited to 'public/remmina__plugin__python_8c.html')
-rw-r--r--public/remmina__plugin__python_8c.html81
1 files changed, 46 insertions, 35 deletions
diff --git a/public/remmina__plugin__python_8c.html b/public/remmina__plugin__python_8c.html
index 2066b78e7..0d243c4a4 100644
--- a/public/remmina__plugin__python_8c.html
+++ b/public/remmina__plugin__python_8c.html
@@ -83,15 +83,13 @@ $(document).ready(function(){initNavTree('remmina__plugin__python_8c.html','');}
<div class="header">
<div class="summary">
-<a href="#func-members">Functions</a> </div>
+<a href="#func-members">Functions</a> &#124;
+<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">remmina_plugin_python.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
-<p>Remmina Python plugin loader.
-<a href="#details">More...</a></p>
-
<p><a href="remmina__plugin__python_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
@@ -102,21 +100,16 @@ Functions</h2></td></tr>
<tr class="memitem:a8f7f30c4cfc8b9e89cc5ecbd0e0b1299"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="remmina__plugin__python_8c.html#a8f7f30c4cfc8b9e89cc5ecbd0e0b1299">remmina_plugin_python_init</a> (void)</td></tr>
<tr class="memdesc:a8f7f30c4cfc8b9e89cc5ecbd0e0b1299"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the Python plugin loaders. <a href="#a8f7f30c4cfc8b9e89cc5ecbd0e0b1299">More...</a><br /></td></tr>
<tr class="separator:a8f7f30c4cfc8b9e89cc5ecbd0e0b1299"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a4673d2aa6b360c81730144423b293d81"><td class="memItemLeft" align="right" valign="top">gboolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="remmina__plugin__python_8c.html#a4673d2aa6b360c81730144423b293d81">remmina_plugin_python_load</a> (<a class="el" href="plugin_8h.html#a078ccfc19f738c83e58bf7a81259eaff">RemminaPluginService</a> *service, const gchar *name)</td></tr>
-<tr class="memdesc:a4673d2aa6b360c81730144423b293d81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a plugin from the Remmina plugin folder with the given name. <a href="#a4673d2aa6b360c81730144423b293d81">More...</a><br /></td></tr>
-<tr class="separator:a4673d2aa6b360c81730144423b293d81"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abf7f5a0a2dad784fa39d35a6adcae48c"><td class="memItemLeft" align="right" valign="top">gboolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="remmina__plugin__python_8c.html#abf7f5a0a2dad784fa39d35a6adcae48c">remmina_plugin_python_load</a> (<a class="el" href="plugin_8h.html#a078ccfc19f738c83e58bf7a81259eaff">RemminaPluginService</a> *service, const char *name)</td></tr>
+<tr class="separator:abf7f5a0a2dad784fa39d35a6adcae48c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
+Variables</h2></td></tr>
+<tr class="memitem:a73e5c740732ba8f8ffbec1b0e8854d1a"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="remmina__plugin__python_8c.html#a73e5c740732ba8f8ffbec1b0e8854d1a">python_init_commands</a> []</td></tr>
+<tr class="memdesc:a73e5c740732ba8f8ffbec1b0e8854d1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">An null terminated array of commands that are executed after the initialization of the Python engine. <a href="#a73e5c740732ba8f8ffbec1b0e8854d1a">More...</a><br /></td></tr>
+<tr class="separator:a73e5c740732ba8f8ffbec1b0e8854d1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Remmina Python plugin loader. </p>
-<dl class="section author"><dt>Author</dt><dd>Mathias Winterhalter </dd></dl>
-<dl class="section date"><dt>Date</dt><dd>14.10.2020</dd></dl>
-<p>When Remmina discovers Python scripts in the plugin root folder the plugin manager passes the path to the Python plugin loader. There it gets executed and the plugin classes get mapped to "real" Remmina plugin instances.</p>
-<p>For the communication between Remmina and Python the python module called 'remmina' is initialized and loaded into the environment of the plugin script (</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="remmina__plugin__python__module_8c.html" title="Implementation of the Python module &#39;remmina&#39;. ">remmina_plugin_python_module.c</a>).</dd>
-<dd>
-<a href="http://www.remmina.org/wp">http://www.remmina.org/wp</a> for more information. </dd></dl>
-
-<p class="definition">Definition in file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
-</div><h2 class="groupheader">Function Documentation</h2>
+<h2 class="groupheader">Function Documentation</h2>
<a id="aa473cd9bb2ec9e627efd089f48a974da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa473cd9bb2ec9e627efd089f48a974da">&#9670;&nbsp;</a></span>basename_no_ext()</h2>
@@ -161,7 +154,7 @@ Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the filename extracted. </dd></dl>
-<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00131">131</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00069">69</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
</div>
</div>
@@ -182,14 +175,14 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<p>Initializes the Python plugin loaders. </p>
-<p>This does not load any plugins but initializes globals and the Python engine itself. </p>
+<p>This does not load any plugins but initializes the implementation (e.g. globals and the Python engine). </p>
-<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00076">76</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00104">104</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
</div>
</div>
-<a id="a4673d2aa6b360c81730144423b293d81"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a4673d2aa6b360c81730144423b293d81">&#9670;&nbsp;</a></span>remmina_plugin_python_load()</h2>
+<a id="abf7f5a0a2dad784fa39d35a6adcae48c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abf7f5a0a2dad784fa39d35a6adcae48c">&#9670;&nbsp;</a></span>remmina_plugin_python_load()</h2>
<div class="memitem">
<div class="memproto">
@@ -203,8 +196,8 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">const gchar *&#160;</td>
- <td class="paramname"><em>filename</em>&#160;</td>
+ <td class="paramtype">const char *&#160;</td>
+ <td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -214,17 +207,35 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Loads a plugin from the Remmina plugin folder with the given name. </p>
-<dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">service</td><td>The instance of the service providing an API between Remmina and its plugins. </td></tr>
- <tr><td class="paramname">filename</td><td>The filename of the plugin to load.</td></tr>
- </table>
- </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE otherwise. </dd></dl>
+<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00119">119</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="a73e5c740732ba8f8ffbec1b0e8854d1a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a73e5c740732ba8f8ffbec1b0e8854d1a">&#9670;&nbsp;</a></span>python_init_commands</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">const char* python_init_commands[]</td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">static</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+<b>Initial value:</b><div class="fragment"><div class="line">= { <span class="stringliteral">&quot;import sys&quot;</span>, <span class="stringliteral">&quot;sys.path.append(&#39;&quot;</span> REMMINA_RUNTIME_PLUGINDIR <span class="stringliteral">&quot;&#39;)&quot;</span>, NULL </div><div class="line">}</div></div><!-- fragment -->
+<p>An null terminated array of commands that are executed after the initialization of the Python engine. </p>
+<p>Every entry represents a line of Python code. </p>
-<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00090">90</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="remmina__plugin__python_8c_source.html#l00054">54</a> of file <a class="el" href="remmina__plugin__python_8c_source.html">remmina_plugin_python.c</a>.</p>
</div>
</div>