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
|
<!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: API.md Source File</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('_a_p_i_8md.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">API.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="_a_p_i_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> # Writing Remmina plugins in Python</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> 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.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> ##### 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!</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> ## Constants</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> | C-Constant | Python | Description |</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> | ------ | ------ | ------ |</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> | GTK_BUTTONS_CANCEL | remmina.BUTTONS_CANCEL | A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. |</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> | GTK_BUTTONS_CLOSE | remmina.BUTTONS_CLOSE | A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. |</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> | GTK_BUTTONS_NONE | remmina.BUTTONS_NONE | A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. |</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> | GTK_BUTTONS_OK | remmina.BUTTONS_OK | A Gtk constant used to indicate which buttons to use in a dialog or which button has been pressed in an dialog event. |</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> | GTK_BUTTONS_OK_CANCEL | remmina.BUTTONS_OK_CANCEL | A Gtk constant used to indicate which buttons to use in a dialog. |</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> | GTK_BUTTONS_YES_NO | remmina.BUTTONS_YES_NO | A Gtk constant used to indicate which buttons to use in a dialog. |</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> | GTK_MESSAGE_ERROR | remmina.MESSAGE_ERROR | A Gtk constant used to indicate what kind of dialog should be shown. |</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> | GTK_MESSAGE_INFO | remmina.MESSAGE_INFO | A Gtk constant used to indicate what kind of dialog should be shown. |</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> | GTK_MESSAGE_OTHER | remmina.MESSAGE_OTHER | A Gtk constant used to indicate what kind of dialog should be shown. |</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> | GTK_MESSAGE_QUESTION | remmina.MESSAGE_QUESTION | A Gtk constant used to indicate what kind of dialog should be shown. |</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> | GTK_MESSAGE_WARNING | remmina.MESSAGE_WARNING | A Gtk constant used to indicate what kind of dialog should be shown. |</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> | REMMINA_PROTOCOL_FEATURE_PREF_CHECK | remmina.PROTOCOL_FEATURE_PREF_CHECK | Specifies that the feature preference should be shown as checkbox. |</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> | REMMINA_PROTOCOL_FEATURE_PREF_RADIO | remmina.PROTOCOL_FEATURE_PREF_RADIO | Specifies that the feature preference should be shown as radio buttons. |</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> | REMMINA_PROTOCOL_FEATURE_TYPE_DYNRESUPDATE | remmina.PROTOCOL_FEATURE_TYPE_DYNRESUPDATE | A constant for features handling dynamic resolution updates, used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> | REMMINA_PROTOCOL_FEATURE_TYPE_GTKSOCKET | remmina.PROTOCOL_FEATURE_TYPE_GTKSOCKET | A constant for features handling gtk sockets, used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> | REMMINA_PROTOCOL_FEATURE_TYPE_PREF | remmina.PROTOCOL_FEATURE_TYPE_PREF | A constant for features handling preferences, used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> | REMMINA_PROTOCOL_FEATURE_TYPE_SCALE | remmina.PROTOCOL_FEATURE_TYPE_SCALE | A constant for features handling ui-scaling, used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> | REMMINA_PROTOCOL_FEATURE_TYPE_TOOL | remmina.PROTOCOL_FEATURE_TYPE_TOOL | A constant for features handling tools (menu entries), used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> | REMMINA_PROTOCOL_FEATURE_TYPE_UNFOCUS | remmina.PROTOCOL_FEATURE_TYPE_UNFOCUS | A constant for features handling the unfocus event, used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> | REMMINA_PROTOCOL_FEATURE_TYPE_MULTIMON | remmina.PROTOCOL_FEATURE_TYPE_MULTIMON | A constant for features handling multi-monitor setup, used in **query_feature** and **call_feature**. |</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> | REMMINA_PROTOCOL_SETTING_TYPE_CHECK | remmina.PROTOCOL_SETTING_TYPE_CHECK | A constant for protocol settings shown as a checkbox. |</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> | REMMINA_PROTOCOL_SETTING_TYPE_COMBO | remmina.PROTOCOL_SETTING_TYPE_COMBO | A constant for protocol settings shown as a combobox. |</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> | REMMINA_PROTOCOL_SETTING_TYPE_FILE | remmina.PROTOCOL_SETTING_TYPE_FILE | A constant for protocol settings shown as a file browser. |</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> | REMMINA_PROTOCOL_SETTING_TYPE_FOLDER | remmina.PROTOCOL_SETTING_TYPE_FOLDER | A constant for protocol settings shown as a directory browser. |</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> | REMMINA_PROTOCOL_SETTING_TYPE_KEYMAP | remmina.PROTOCOL_SETTING_TYPE_KEYMAP | A constant for protocol settings shown as key mappings. |</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> | REMMINA_PROTOCOL_SETTING_TYPE_PASSWORD | remmina.PROTOCOL_SETTING_TYPE_PASSWORD | A constant for protocol settings shown as a password box. |</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> | REMMINA_PROTOCOL_SETTING_TYPE_RESOLUTION | remmina.PROTOCOL_SETTING_TYPE_RESOLUTION | A constant for protocol settings shown as a . |</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> | REMMINA_PROTOCOL_SETTING_TYPE_SELECT | remmina.PROTOCOL_SETTING_TYPE_SELECT | A constant for protocol settings shown as a custom selector dialog. |</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> | REMMINA_PROTOCOL_SETTING_TYPE_SERVER | remmina.PROTOCOL_SETTING_TYPE_SERVER | A constant for protocol settings shown as a hostname textbox. |</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> | REMMINA_PROTOCOL_SETTING_TYPE_TEXT | remmina.PROTOCOL_SETTING_TYPE_TEXT | A constant for protocol settings shown as a normal textbox. |</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> | REMMINA_PROTOCOL_SSH_SETTING_NONE | remmina.PROTOCOL_SSH_SETTING_NONE | A constant used to indicate no additional SSH settings. |</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> | REMMINA_PROTOCOL_SSH_SETTING_REVERSE_TUNNEL | remmina.PROTOCOL_SSH_SETTING_REVERSE_TUNNEL | A constant used to indicate SSH reverse tunnel configuration. |</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> | REMMINA_PROTOCOL_SSH_SETTING_SFTP | remmina.PROTOCOL_SSH_SETTING_SFTP | A constant used to indicate FTP over SSH configuration. |</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> | REMMINA_PROTOCOL_SSH_SETTING_SSH | remmina.PROTOCOL_SSH_SETTING_SSH | A constant used to indicate basic SSH configuration. |</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> | REMMINA_PROTOCOL_SSH_SETTING_TUNNEL | remmina.PROTOCOL_SSH_SETTING_TUNNEL | A constant used to indicate SSH tunnel configuration. |</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> | REMMINA_MESSAGE_PANEL_FLAG_DOMAIN | remmina.MESSAGE_PANEL_FLAG_DOMAIN | A constant used to tell the protocol connection dialog to show the domain textbox. |</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> | REMMINA_MESSAGE_PANEL_FLAG_SAVEPASSWORD | remmina.MESSAGE_PANEL_FLAG_SAVEPASSWORD | A constant used to tell the protocol connection dialog to enable the checkbox for storing the password. |</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> | REMMINA_MESSAGE_PANEL_FLAG_USERNAME | remmina.MESSAGE_PANEL_FLAG_USERNAME | A constant used to tell the protocol connection dialog to show the username textbox. |</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> | REMMINA_MESSAGE_PANEL_FLAG_USERNAME_READONLY | remmina.MESSAGE_PANEL_FLAG_USERNAME_READONLY | A constant used to tell the protocol connection dialog to make the username textbox read-only. |</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> ## Types</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> | Type | Summary |</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> | ------ | ------ |</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> | remmina.Setting | Contains information about plugin settings. Used to specify basic and advanced settings. |</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> | remmina.ProtocolFeature | Contains information of a feature specificly for protocol plugins. |</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> | remmina.RemminaScreenshotData | Contains information of a screenshot that can be passed to Remmina for storage. |</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> | remmina.Generic | If a parameter can have different types the generic offers information about the type next to the value. |</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> | remmina.RemminaFile | An API to allow the handling of files. Also used to store key/values in a protocol widget. |</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> | remmina.RemminaProtocolWidget | The widget that is placed in the connection window acting as a Gtk parent widget for the plugin's graphical output. |</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> ## Global functions</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> | Type | Summary |</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> | ------ | ------ |</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> | remmina.debug | Prints a message to the Remmina debug panel. |</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> | remmina.file_new | Creates a new RemminaFile instance. |</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> | remmina.get_datadir | Returns the data directory of Remmina. |</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> | remmina.get_main_window | Returns the Gtk instance of the connection window. | </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> | remmina.gtksocket_available | Indicates if Gtk.Socket is available under the current display manager (currently only X.Org is supported). |</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> | remmina.log_print | Prints a log message to standard output. |</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> | remmina.masterthread_exec_is_main_thread | Indicates if the current thread is the main thread of the application. |</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> | remmina.pref_get_scale_quality | Returns the scale quality preference of ther user. |</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> | remmina.pref_get_ssh_loglevel | Returns the ssh log level of ther user. |</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> | remmina.pref_get_ssh_parseconfig | Returns if the user prefers the ssh connection to use the user's ssh config. |</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> | remmina.pref_get_sshtunnel_port | Returns the user defined port for the ssh tunnel. |</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> | remmina.pref_get_value | Returns the value of the 'remmina_pref' file by its key. |</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> | remmina.pref_keymap_get_keyval | Returns the key value of a specific key according to the user's key mapping. |</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> | remmina.pref_set_value | Sets a value of the 'remmina_pref' file by its key. |</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> | remmina.protocol_plugin_init_auth | Shows the connection authentication dialog. See REMMINA_MESSAGE_PANEL_ constants for configuration. |</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> | remmina.protocol_plugin_signal_connection_closed | Notifies Remmina that the connection has been closed. |</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> | remmina.protocol_plugin_signal_connection_opened | Notifies Remmina that the connection has been opened. |</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> | remmina.protocol_widget_get_profile_remote_height | Returns the screen height according to the user's profile. |</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> | remmina.protocol_widget_get_profile_remote_width | Returns the screen width according to the user's profile. |</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> | remmina.public_get_server_port | Returns the port specified in a hostname string (e.g. localhost:8080). |</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> | remmina.rcw_open_from_file_full | Opens a connection window according to the settings specified in the RemminaFile instance. |</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> | remmina.register_plugin | Registeres a new Python plugin instance. |</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> | remmina.show_dialog | Shows a Gtk dialog to the user. |</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> | remmina.widget_pool_register | Registers a GtkWidget in the Remmina widget pool. |</div></div><!-- fragment --></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="_a_p_i_8md.html">API.md</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>
|
