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
|
<!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: Writing Remmina plugins in Python</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('md__builds__remmina_remmina-ci__remmina_8wiki__development__plugin-_development__python__a_p_i.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="headertitle">
<div class="title">Writing Remmina plugins in Python </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Remmina provides a Python module called 'remmina' that contains all global constants, types and functions from the C-API (namely RemminaPluginService). That means you can access all of it by writing 'remmina.' and then the same name as in C. In the following you will see all available members of the remmina object.</p>
<h5>Be aware that the list might not be up-to-date and new members might be available. If you're missing something you can always execute 'print(dir(remmina))' to see the currently available members!</h5>
<h2>Constants</h2>
<table class="doxtable">
<tr>
<th>C-Constant </th><th>Python </th><th>Description </th></tr>
<tr>
<td>GTK_BUTTONS_CANCEL </td><td>remmina.BUTTONS_CANCEL </td><td>A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. </td></tr>
<tr>
<td>GTK_BUTTONS_CLOSE </td><td>remmina.BUTTONS_CLOSE </td><td>A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. </td></tr>
<tr>
<td>GTK_BUTTONS_NONE </td><td>remmina.BUTTONS_NONE </td><td>A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. </td></tr>
<tr>
<td>GTK_BUTTONS_OK </td><td>remmina.BUTTONS_OK </td><td>A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. </td></tr>
<tr>
<td>GTK_BUTTONS_OK_CANCEL </td><td>remmina.BUTTONS_OK_CANCEL </td><td>A Gtk constant used to indicate which buttons to use in a dialog. </td></tr>
<tr>
<td>GTK_BUTTONS_YES_NO </td><td>remmina.BUTTONS_YES_NO </td><td>A Gtk constant used to indicate which buttons to use in a dialog. </td></tr>
<tr>
<td>GTK_MESSAGE_ERROR </td><td>remmina.MESSAGE_ERROR </td><td>A Gtk constant used to indicate what kind of dialog should be shown. </td></tr>
<tr>
<td>GTK_MESSAGE_INFO </td><td>remmina.MESSAGE_INFO </td><td>A Gtk constant used to indicate what kind of dialog should be shown. </td></tr>
<tr>
<td>GTK_MESSAGE_OTHER </td><td>remmina.MESSAGE_OTHER </td><td>A Gtk constant used to indicate what kind of dialog should be shown. </td></tr>
<tr>
<td>GTK_MESSAGE_QUESTION </td><td>remmina.MESSAGE_QUESTION </td><td>A Gtk constant used to indicate what kind of dialog should be shown. </td></tr>
<tr>
<td>GTK_MESSAGE_WARNING </td><td>remmina.MESSAGE_WARNING </td><td>A Gtk constant used to indicate what kind of dialog should be shown. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_PREF_CHECK </td><td>remmina.PROTOCOL_FEATURE_PREF_CHECK </td><td>Specifies that the feature preference should be shown as checkbox. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_PREF_RADIO </td><td>remmina.PROTOCOL_FEATURE_PREF_RADIO </td><td>Specifies that the feature preference should be shown as radio buttons. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_DYNRESUPDATE </td><td>remmina.PROTOCOL_FEATURE_TYPE_DYNRESUPDATE </td><td>A constant for features handling dynamic resolution updates, used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_GTKSOCKET </td><td>remmina.PROTOCOL_FEATURE_TYPE_GTKSOCKET </td><td>A constant for features handling gtk sockets, used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_PREF </td><td>remmina.PROTOCOL_FEATURE_TYPE_PREF </td><td>A constant for features handling preferences, used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_SCALE </td><td>remmina.PROTOCOL_FEATURE_TYPE_SCALE </td><td>A constant for features handling ui-scaling, used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_TOOL </td><td>remmina.PROTOCOL_FEATURE_TYPE_TOOL </td><td>A constant for features handling tools (menu entries), used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_UNFOCUS </td><td>remmina.PROTOCOL_FEATURE_TYPE_UNFOCUS </td><td>A constant for features handling the unfocus event, used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_FEATURE_TYPE_MULTIMON </td><td>remmina.PROTOCOL_FEATURE_TYPE_MULTIMON </td><td>A constant for features handling multi-monitor setup, used in <b>query_feature</b> and <b>call_feature</b>. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_CHECK </td><td>remmina.PROTOCOL_SETTING_TYPE_CHECK </td><td>A constant for protocol settings shown as a checkbox. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_COMBO </td><td>remmina.PROTOCOL_SETTING_TYPE_COMBO </td><td>A constant for protocol settings shown as a combobox. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_FILE </td><td>remmina.PROTOCOL_SETTING_TYPE_FILE </td><td>A constant for protocol settings shown as a file browser. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_FOLDER </td><td>remmina.PROTOCOL_SETTING_TYPE_FOLDER </td><td>A constant for protocol settings shown as a directory browser. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_KEYMAP </td><td>remmina.PROTOCOL_SETTING_TYPE_KEYMAP </td><td>A constant for protocol settings shown as key mappings. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_PASSWORD </td><td>remmina.PROTOCOL_SETTING_TYPE_PASSWORD </td><td>A constant for protocol settings shown as a password box. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_RESOLUTION </td><td>remmina.PROTOCOL_SETTING_TYPE_RESOLUTION </td><td>A constant for protocol settings shown as a . </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_SELECT </td><td>remmina.PROTOCOL_SETTING_TYPE_SELECT </td><td>A constant for protocol settings shown as a custom selector dialog. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_SERVER </td><td>remmina.PROTOCOL_SETTING_TYPE_SERVER </td><td>A constant for protocol settings shown as a hostname textbox. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SETTING_TYPE_TEXT </td><td>remmina.PROTOCOL_SETTING_TYPE_TEXT </td><td>A constant for protocol settings shown as a normal textbox. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SSH_SETTING_NONE </td><td>remmina.PROTOCOL_SSH_SETTING_NONE </td><td>A constant used to indicate no additional SSH settings. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SSH_SETTING_REVERSE_TUNNEL </td><td>remmina.PROTOCOL_SSH_SETTING_REVERSE_TUNNEL </td><td>A constant used to indicate SSH reverse tunnel configuration. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SSH_SETTING_SFTP </td><td>remmina.PROTOCOL_SSH_SETTING_SFTP </td><td>A constant used to indicate FTP over SSH configuration. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SSH_SETTING_SSH </td><td>remmina.PROTOCOL_SSH_SETTING_SSH </td><td>A constant used to indicate basic SSH configuration. </td></tr>
<tr>
<td>REMMINA_PROTOCOL_SSH_SETTING_TUNNEL </td><td>remmina.PROTOCOL_SSH_SETTING_TUNNEL </td><td>A constant used to indicate SSH tunnel configuration. </td></tr>
<tr>
<td>REMMINA_MESSAGE_PANEL_FLAG_DOMAIN </td><td>remmina.MESSAGE_PANEL_FLAG_DOMAIN </td><td>A constant used to tell the protocol connection dialog to show the domain textbox. </td></tr>
<tr>
<td>REMMINA_MESSAGE_PANEL_FLAG_SAVEPASSWORD </td><td>remmina.MESSAGE_PANEL_FLAG_SAVEPASSWORD </td><td>A constant used to tell the protocol connection dialog to enable the checkbox for storing the password. </td></tr>
<tr>
<td>REMMINA_MESSAGE_PANEL_FLAG_USERNAME </td><td>remmina.MESSAGE_PANEL_FLAG_USERNAME </td><td>A constant used to tell the protocol connection dialog to show the username textbox. </td></tr>
<tr>
<td>REMMINA_MESSAGE_PANEL_FLAG_USERNAME_READONLY </td><td>remmina.MESSAGE_PANEL_FLAG_USERNAME_READONLY </td><td>A constant used to tell the protocol connection dialog to make the username textbox read-only. </td></tr>
</table>
<h2>Types</h2>
<table class="doxtable">
<tr>
<th>Type </th><th>Summary </th></tr>
<tr>
<td>remmina.Setting </td><td>Contains information about plugin settings. Used to specify basic and advanced settings. </td></tr>
<tr>
<td>remmina.ProtocolFeature </td><td>Contains information of a feature specificly for protocol plugins. </td></tr>
<tr>
<td>remmina.RemminaScreenshotData </td><td>Contains information of a screenshot that can be passed to Remmina for storage. </td></tr>
<tr>
<td>remmina.Generic </td><td>If a parameter can have different types the generic offers information about the type next to the value. </td></tr>
<tr>
<td>remmina.RemminaFile </td><td>An API to allow the handling of files. Also used to store key/values in a protocol widget. </td></tr>
<tr>
<td>remmina.RemminaProtocolWidget </td><td>The widget that is placed in the connection window acting as a Gtk parent widget for the plugin's graphical output. </td></tr>
</table>
<h2>Global functions</h2>
<table class="doxtable">
<tr>
<th>Type </th><th>Summary </th></tr>
<tr>
<td>remmina.debug </td><td>Prints a message to the Remmina debug panel. </td></tr>
<tr>
<td>remmina.file_new </td><td>Creates a new RemminaFile instance. </td></tr>
<tr>
<td>remmina.get_datadir </td><td>Returns the data directory of Remmina. </td></tr>
<tr>
<td>remmina.get_main_window </td><td>Returns the Gtk instance of the connection window. </td></tr>
<tr>
<td>remmina.gtksocket_available </td><td>Indicates if Gtk.Socket is available under the current display manager (currently only X.Org is supported). </td></tr>
<tr>
<td>remmina.log_print </td><td>Prints a log message to standard output. </td></tr>
<tr>
<td>remmina.masterthread_exec_is_main_thread </td><td>Indicates if the current thread is the main thread of the application. </td></tr>
<tr>
<td>remmina.pref_get_scale_quality </td><td>Returns the scale quality preference of ther user. </td></tr>
<tr>
<td>remmina.pref_get_ssh_loglevel </td><td>Returns the ssh log level of ther user. </td></tr>
<tr>
<td>remmina.pref_get_ssh_parseconfig </td><td>Returns if the user prefers the ssh connection to use the user's ssh config. </td></tr>
<tr>
<td>remmina.pref_get_sshtunnel_port </td><td>Returns the user defined port for the ssh tunnel. </td></tr>
<tr>
<td>remmina.pref_get_value </td><td>Returns the value of the 'remmina_pref' file by its key. </td></tr>
<tr>
<td>remmina.pref_keymap_get_keyval </td><td>Returns the key value of a specific key according to the user's key mapping. </td></tr>
<tr>
<td>remmina.pref_set_value </td><td>Sets a value of the 'remmina_pref' file by its key. </td></tr>
<tr>
<td>remmina.protocol_plugin_init_auth </td><td>Shows the connection authentication dialog. See REMMINA_MESSAGE_PANEL_ constants for configuration. </td></tr>
<tr>
<td>remmina.protocol_plugin_signal_connection_closed </td><td>Notifies Remmina that the connection has been closed. </td></tr>
<tr>
<td>remmina.protocol_plugin_signal_connection_opened </td><td>Notifies Remmina that the connection has been opened. </td></tr>
<tr>
<td>remmina.protocol_widget_get_profile_remote_height </td><td>Returns the screen height according to the user's profile. </td></tr>
<tr>
<td>remmina.protocol_widget_get_profile_remote_width </td><td>Returns the screen width according to the user's profile. </td></tr>
<tr>
<td>remmina.public_get_server_port </td><td>Returns the port specified in a hostname string (e.g. localhost:8080). </td></tr>
<tr>
<td>remmina.rcw_open_from_file_full </td><td>Opens a connection window according to the settings specified in the RemminaFile instance. </td></tr>
<tr>
<td>remmina.register_plugin </td><td>Registeres a new Python plugin instance. </td></tr>
<tr>
<td>remmina.show_dialog </td><td>Shows a Gtk dialog to the user. </td></tr>
<tr>
<td>remmina.widget_pool_register </td><td>Registers a GtkWidget in the Remmina widget pool. </td></tr>
</table>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
|
