API.md

Go to the documentation of this file.

# Writing Remmina plugins in Python

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.

##### 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!

## Constants

| C-Constant | Python | Description |
| ------ | ------ | ------ |
| 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. |
| 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. |
| 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. |
| 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. |
| GTK_BUTTONS_OK_CANCEL | remmina.BUTTONS_OK_CANCEL | A Gtk constant used to indicate which buttons to use in a dialog. |
| GTK_BUTTONS_YES_NO | remmina.BUTTONS_YES_NO | A Gtk constant used to indicate which buttons to use in a dialog. |
| GTK_MESSAGE_ERROR | remmina.MESSAGE_ERROR | A Gtk constant used to indicate what kind of dialog should be shown. |
| GTK_MESSAGE_INFO | remmina.MESSAGE_INFO | A Gtk constant used to indicate what kind of dialog should be shown. |
| GTK_MESSAGE_OTHER | remmina.MESSAGE_OTHER | A Gtk constant used to indicate what kind of dialog should be shown. |
| GTK_MESSAGE_QUESTION | remmina.MESSAGE_QUESTION | A Gtk constant used to indicate what kind of dialog should be shown. |
| GTK_MESSAGE_WARNING | remmina.MESSAGE_WARNING | A Gtk constant used to indicate what kind of dialog should be shown. |
| REMMINA_PROTOCOL_FEATURE_PREF_CHECK | remmina.PROTOCOL_FEATURE_PREF_CHECK | Specifies that the feature preference should be shown as checkbox. |
| REMMINA_PROTOCOL_FEATURE_PREF_RADIO | remmina.PROTOCOL_FEATURE_PREF_RADIO | Specifies that the feature preference should be shown as radio buttons. |
| 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**. |
| REMMINA_PROTOCOL_FEATURE_TYPE_GTKSOCKET | remmina.PROTOCOL_FEATURE_TYPE_GTKSOCKET | A constant for features handling gtk sockets, used in **query_feature** and **call_feature**. |
| REMMINA_PROTOCOL_FEATURE_TYPE_PREF | remmina.PROTOCOL_FEATURE_TYPE_PREF | A constant for features handling preferences, used in **query_feature** and **call_feature**. |
| REMMINA_PROTOCOL_FEATURE_TYPE_SCALE | remmina.PROTOCOL_FEATURE_TYPE_SCALE | A constant for features handling ui-scaling, used in **query_feature** and **call_feature**. |
| 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**. |
| 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**. |
| 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**. |
| REMMINA_PROTOCOL_SETTING_TYPE_CHECK | remmina.PROTOCOL_SETTING_TYPE_CHECK | A constant for protocol settings shown as a checkbox. |
| REMMINA_PROTOCOL_SETTING_TYPE_COMBO | remmina.PROTOCOL_SETTING_TYPE_COMBO | A constant for protocol settings shown as a combobox. |
| REMMINA_PROTOCOL_SETTING_TYPE_FILE | remmina.PROTOCOL_SETTING_TYPE_FILE | A constant for protocol settings shown as a file browser. |
| REMMINA_PROTOCOL_SETTING_TYPE_FOLDER | remmina.PROTOCOL_SETTING_TYPE_FOLDER | A constant for protocol settings shown as a directory browser. |
| REMMINA_PROTOCOL_SETTING_TYPE_KEYMAP | remmina.PROTOCOL_SETTING_TYPE_KEYMAP | A constant for protocol settings shown as key mappings. |
| REMMINA_PROTOCOL_SETTING_TYPE_PASSWORD | remmina.PROTOCOL_SETTING_TYPE_PASSWORD | A constant for protocol settings shown as a password box. |
| REMMINA_PROTOCOL_SETTING_TYPE_RESOLUTION | remmina.PROTOCOL_SETTING_TYPE_RESOLUTION | A constant for protocol settings shown as a . |
| REMMINA_PROTOCOL_SETTING_TYPE_SELECT | remmina.PROTOCOL_SETTING_TYPE_SELECT | A constant for protocol settings shown as a custom selector dialog. |
| REMMINA_PROTOCOL_SETTING_TYPE_SERVER | remmina.PROTOCOL_SETTING_TYPE_SERVER | A constant for protocol settings shown as a hostname textbox. |
| REMMINA_PROTOCOL_SETTING_TYPE_TEXT | remmina.PROTOCOL_SETTING_TYPE_TEXT | A constant for protocol settings shown as a normal textbox. |
| REMMINA_PROTOCOL_SSH_SETTING_NONE | remmina.PROTOCOL_SSH_SETTING_NONE | A constant used to indicate no additional SSH settings. |
| REMMINA_PROTOCOL_SSH_SETTING_REVERSE_TUNNEL | remmina.PROTOCOL_SSH_SETTING_REVERSE_TUNNEL | A constant used to indicate SSH reverse tunnel configuration. |
| REMMINA_PROTOCOL_SSH_SETTING_SFTP | remmina.PROTOCOL_SSH_SETTING_SFTP | A constant used to indicate FTP over SSH configuration. |
| REMMINA_PROTOCOL_SSH_SETTING_SSH | remmina.PROTOCOL_SSH_SETTING_SSH | A constant used to indicate basic SSH configuration. |
| REMMINA_PROTOCOL_SSH_SETTING_TUNNEL | remmina.PROTOCOL_SSH_SETTING_TUNNEL | A constant used to indicate SSH tunnel configuration. |
| REMMINA_MESSAGE_PANEL_FLAG_DOMAIN | remmina.MESSAGE_PANEL_FLAG_DOMAIN | A constant used to tell the protocol connection dialog to show the domain textbox. |
| 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. |
| REMMINA_MESSAGE_PANEL_FLAG_USERNAME | remmina.MESSAGE_PANEL_FLAG_USERNAME | A constant used to tell the protocol connection dialog to show the username textbox. |
| 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. |

## Types

| Type | Summary |
| ------ | ------ |
| remmina.Setting | Contains information about plugin settings. Used to specify basic and advanced settings. |
| remmina.ProtocolFeature | Contains information of a feature specificly for protocol plugins. |
| remmina.RemminaScreenshotData | Contains information of a screenshot that can be passed to Remmina for storage. |
| remmina.Generic | If a parameter can have different types the generic offers information about the type next to the value. |
| remmina.RemminaFile | An API to allow the handling of files. Also used to store key/values in a protocol widget. |
| remmina.RemminaProtocolWidget | The widget that is placed in the connection window acting as a Gtk parent widget for the plugin's graphical output. |

## Global functions

| Type | Summary |
| ------ | ------ |
| remmina.debug | Prints a message to the Remmina debug panel. |
| remmina.file_new | Creates a new RemminaFile instance. |
| remmina.get_datadir | Returns the data directory of Remmina. |
| remmina.get_main_window | Returns the Gtk instance of the connection window. | 
| remmina.gtksocket_available | Indicates if Gtk.Socket is available under the current display manager (currently only X.Org is supported). |
| remmina.log_print | Prints a log message to standard output. |
| remmina.masterthread_exec_is_main_thread | Indicates if the current thread is the main thread of the application. |
| remmina.pref_get_scale_quality | Returns the scale quality preference of ther user. |
| remmina.pref_get_ssh_loglevel | Returns the ssh log level of ther user. |
| remmina.pref_get_ssh_parseconfig | Returns if the user prefers the ssh connection to use the user's ssh config. |
| remmina.pref_get_sshtunnel_port | Returns the user defined port for the ssh tunnel. |
| remmina.pref_get_value | Returns the value of the 'remmina_pref' file by its key. |
| remmina.pref_keymap_get_keyval | Returns the key value of a specific key according to the user's key mapping. |
| remmina.pref_set_value | Sets a value of the 'remmina_pref' file by its key. |
| remmina.protocol_plugin_init_auth | Shows the connection authentication dialog. See REMMINA_MESSAGE_PANEL_ constants for configuration. |
| remmina.protocol_plugin_signal_connection_closed | Notifies Remmina that the connection has been closed. |
| remmina.protocol_plugin_signal_connection_opened | Notifies Remmina that the connection has been opened. |
| remmina.protocol_widget_get_profile_remote_height | Returns the screen height according to the user's profile. |
| remmina.protocol_widget_get_profile_remote_width | Returns the screen width according to the user's profile. |
| remmina.public_get_server_port | Returns the port specified in a hostname string (e.g. localhost:8080). |
| remmina.rcw_open_from_file_full | Opens a connection window according to the settings specified in the RemminaFile instance. |
| remmina.register_plugin | Registeres a new Python plugin instance. |
| remmina.show_dialog | Shows a Gtk dialog to the user. |
| remmina.widget_pool_register | Registers a GtkWidget in the Remmina widget pool. |