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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Remmina - The GTK+ Remote Desktop Client: python_wrapper_remmina.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectlogo"><img alt="Logo" src="org.remmina.Remmina.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Remmina - The GTK+ Remote Desktop Client
 <span id="projectnumber">v1.4.33</span>
</div>
<div id="projectbrief">Remmina is a remote desktop client written in GTK+, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large monitors or tiny netbooks. Remmina supports multiple network protocols in an integrated and consistent user interface. Currently RDP, VNC, NX, XDMCP and SSH are supported.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('python__wrapper__remmina_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">python_wrapper_remmina.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Contains the implementation of the Python module 'remmina', provided to interface with the application from the Python plugin source.
<a href="#details">More...</a></p>
<p><a href="python__wrapper__remmina_8h_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>
Functions</h2></td></tr>
<tr class="memitem:a3c64ffe58241dbb27605dee459e84b66"><td class="memItemLeft" align="right" valign="top">G_BEGIN_DECLS void </td><td class="memItemRight" valign="bottom"><a class="el" href="python__wrapper__remmina_8h.html#a3c64ffe58241dbb27605dee459e84b66">python_wrapper_module_init</a> (void)</td></tr>
<tr class="memdesc:a3c64ffe58241dbb27605dee459e84b66"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the 'remmina' module in the Python engine. <a href="#a3c64ffe58241dbb27605dee459e84b66">More...</a><br /></td></tr>
<tr class="separator:a3c64ffe58241dbb27605dee459e84b66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa82a4028546be1fc4f73499cb65e7a0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_py_plugin.html">PyPlugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="python__wrapper__remmina_8h.html#aa82a4028546be1fc4f73499cb65e7a0d">python_wrapper_module_get_plugin</a> (<a class="el" href="types_8h.html#a3fc3247f5a12b842032241d0cdde9cf4">RemminaProtocolWidget</a> *gp)</td></tr>
<tr class="memdesc:aa82a4028546be1fc4f73499cb65e7a0d"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the Python instance, mapped to the RemminaProtocolWidget or null if not found. <a href="#aa82a4028546be1fc4f73499cb65e7a0d">More...</a><br /></td></tr>
<tr class="separator:aa82a4028546be1fc4f73499cb65e7a0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0029840116ce2b2c4d7870d202ce6459"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="python__wrapper__remmina_8h.html#a0029840116ce2b2c4d7870d202ce6459">python_wrapper_to_protocol_setting</a> (<a class="el" href="types_8h.html#a41c04d02e6a15ad17be8065453cc4933">RemminaProtocolSetting</a> *dest, PyObject *setting)</td></tr>
<tr class="memdesc:a0029840116ce2b2c4d7870d202ce6459"><td class="mdescLeft"> </td><td class="mdescRight">Converts the PyObject to RemminaProtocolSetting. <a href="#a0029840116ce2b2c4d7870d202ce6459">More...</a><br /></td></tr>
<tr class="separator:a0029840116ce2b2c4d7870d202ce6459"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9cee26b804b78c89cd56e59d71b6250"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="python__wrapper__remmina_8h.html#ad9cee26b804b78c89cd56e59d71b6250">python_wrapper_to_protocol_feature</a> (<a class="el" href="types_8h.html#ade886ceb4d246765dc78cdc7fbabeb74">RemminaProtocolFeature</a> *dest, PyObject *feature)</td></tr>
<tr class="memdesc:ad9cee26b804b78c89cd56e59d71b6250"><td class="mdescLeft"> </td><td class="mdescRight">Converts the PyObject to RemminaProtocolFeature. <a href="#ad9cee26b804b78c89cd56e59d71b6250">More...</a><br /></td></tr>
<tr class="separator:ad9cee26b804b78c89cd56e59d71b6250"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Contains the implementation of the Python module 'remmina', provided to interface with the application from the Python plugin source. </p>
<p>In contrast to the wrapper functions that exist in the plugin specialisation files (e.g. <a class="el" href="python__wrapper__protocol_8c.html">python_wrapper_protocol.c</a> or <a class="el" href="python__wrapper__entry_8c.html" title="Contains the wiring of a Python pluing based on RemminaPluginProtocol. ">python_wrapper_entry.c</a>), this file contains the API for the communication in the direction, from Python to Remmina. This means, if in the Python plugin a function is called, that is defined in Remmina, C code, at least in this file, is executed. </p>
<p class="definition">Definition in file <a class="el" href="python__wrapper__remmina_8h_source.html">python_wrapper_remmina.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aa82a4028546be1fc4f73499cb65e7a0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa82a4028546be1fc4f73499cb65e7a0d">◆ </a></span>python_wrapper_module_get_plugin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_py_plugin.html">PyPlugin</a>* python_wrapper_module_get_plugin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3fc3247f5a12b842032241d0cdde9cf4">RemminaProtocolWidget</a> * </td>
<td class="paramname"><em>gp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to the Python instance, mapped to the RemminaProtocolWidget or null if not found. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gp</td><td>The widget that is owned by the plugin that should be found.</td></tr>
</table>
</dd>
</dl>
<p>Remmina expects this callback function to be part of one plugin, which is the reason no instance information is explicitly passed. To bridge that, this function can be used to retrieve the very plugin instance owning the given RemminaProtocolWidget. </p>
</div>
</div>
<a id="a3c64ffe58241dbb27605dee459e84b66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c64ffe58241dbb27605dee459e84b66">◆ </a></span>python_wrapper_module_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">G_BEGIN_DECLS void python_wrapper_module_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the 'remmina' module in the Python engine. </p>
<p>Initializes the 'remmina' module in the Python engine.</p>
<p>This </p>
<p class="definition">Definition at line <a class="el" href="python__wrapper__remmina_8c_source.html#l00720">720</a> of file <a class="el" href="python__wrapper__remmina_8c_source.html">python_wrapper_remmina.c</a>.</p>
</div>
</div>
<a id="ad9cee26b804b78c89cd56e59d71b6250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9cee26b804b78c89cd56e59d71b6250">◆ </a></span>python_wrapper_to_protocol_feature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void python_wrapper_to_protocol_feature </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ade886ceb4d246765dc78cdc7fbabeb74">RemminaProtocolFeature</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PyObject * </td>
<td class="paramname"><em>feature</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the PyObject to RemminaProtocolFeature. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>A target for the converted value. </td></tr>
<tr><td class="paramname">setting</td><td>The source value to convert. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="python__wrapper__remmina_8c_source.html#l01109">1109</a> of file <a class="el" href="python__wrapper__remmina_8c_source.html">python_wrapper_remmina.c</a>.</p>
</div>
</div>
<a id="a0029840116ce2b2c4d7870d202ce6459"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0029840116ce2b2c4d7870d202ce6459">◆ </a></span>python_wrapper_to_protocol_setting()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void python_wrapper_to_protocol_setting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a41c04d02e6a15ad17be8065453cc4933">RemminaProtocolSetting</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PyObject * </td>
<td class="paramname"><em>setting</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the PyObject to RemminaProtocolSetting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>A target for the converted value. </td></tr>
<tr><td class="paramname">setting</td><td>The source value to convert. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="python__wrapper__remmina_8c_source.html#l01093">1093</a> of file <a class="el" href="python__wrapper__remmina_8c_source.html">python_wrapper_remmina.c</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_38c8d24aef3972a7f87b834274e76e31.html">plugins</a></li><li class="navelem"><a class="el" href="dir_18347d302435f5d3ba20b085d9ec3813.html">python_wrapper</a></li><li class="navelem"><a class="el" href="python__wrapper__remmina_8h.html">python_wrapper_remmina.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|
