Contains functions and constants that are commonly used throughout the Python plugin implementation. More...

Data Structures
struct	PyRemminaProtocolWidget
	The Python abstraction of the protocol widget struct. More...

struct	PyPlugin
	Maps an instance of a Python plugin to a Remmina one. More...

struct	PyGeneric
	A struct used to communicate data between Python and C without strict data type. More...

Functions
PyGeneric *	remmina_plugin_python_generic_new (void)
	Creates a new instance of PyGeneric. More...

void	remmina_plugin_python_add_plugin (PyPlugin *plugin)
	Registers the given plugin if no other plugin with the same name has been already registered. More...

void	remmina_plugin_python_set_service (RemminaPluginService *service)
	Sets the pointer to the plugin service of Remmina. More...

RemminaTypeHint	remmina_plugin_python_to_generic (PyObject field, gpointer target)
	Extracts data from a PyObject instance to a generic pointer and returns a type hint if it could be determined. More...

PyObject *	remmina_plugin_python_last_result (void)
	Gets the result of the last python method call. More...

PyObject *	remmina_plugin_python_last_result_set (PyObject *result)
	Sets the result of the last python method call. More...

void	remmina_plugin_python_log_method_call (PyObject instance, const char method)
	Prints a log message to inform the user a python message has been called. More...

gboolean	remmina_plugin_python_check_error (void)
	Checks if an error has occurred and prints it. More...

long	remmina_plugin_python_get_attribute_long (PyObject instance, const char attr_name, long def)
	Gets the attribute as long value. More...

gboolean	remmina_plugin_python_check_attribute (PyObject instance, const char attr_name)
	Checks if a given attribute exists. More...

void *	remmina_plugin_python_malloc (int bytes)
	Allocates memory and checks for errors before returning. More...

char *	remmina_plugin_python_copy_string_from_python (PyObject *string, Py_ssize_t len)
	Copies a string from a Python object to a new point in memory. More...

PyPlugin *	remmina_plugin_python_get_plugin (const char *name)
	Tries to find the Python plugin matching to the given instance of RemminaPlugin. More...

GtkWidget *	new_pywidget (GObject *obj)
	Creates a new GtkWidget. More...

GtkWidget *	get_pywidget (PyObject *obj)
	Extracts a GtkWidget from a PyObject instance. More...

void	init_pygobject (void)
	Initializes the pygobject library. More...

Variables
G_BEGIN_DECLS const char *	ATTR_NAME

const char *	ATTR_ICON_NAME

const char *	ATTR_DESCRIPTION

const char *	ATTR_VERSION

const char *	ATTR_ICON_NAME_SSH

const char *	ATTR_FEATURES

const char *	ATTR_BASIC_SETTINGS

const char *	ATTR_ADVANCED_SETTINGS

const char *	ATTR_SSH_SETTING

const char *	ATTR_EXPORT_HINTS

const char *	ATTR_PREF_LABEL

const char *	ATTR_INIT_ORDER

Detailed Description

Contains functions and constants that are commonly used throughout the Python plugin implementation.

These functions should not be used outside of the Python plugin implementation, since everything is intended to be used with the Python engine.

Definition in file remmina_plugin_python_common.h.

Function Documentation

◆ get_pywidget()

GtkWidget* get_pywidget ( PyObject * obj )

Extracts a GtkWidget from a PyObject instance.

Parameters

obj

Returns

Definition at line 309 of file remmina_plugin_python_common.c.

◆ init_pygobject()

void init_pygobject ( void )

Initializes the pygobject library.

This needs to be called before any Python plugin is being initialized.

Definition at line 299 of file remmina_plugin_python_common.c.

◆ new_pywidget()

GtkWidget* new_pywidget ( GObject * obj )

Creates a new GtkWidget.

Parameters

obj

Returns

Definition at line 304 of file remmina_plugin_python_common.c.

◆ remmina_plugin_python_add_plugin()

void remmina_plugin_python_add_plugin ( PyPlugin * plugin )

Registers the given plugin if no other plugin with the same name has been already registered.

Definition at line 204 of file remmina_plugin_python_common.c.

◆ remmina_plugin_python_check_attribute()

gboolean remmina_plugin_python_check_attribute	(	PyObject *	instance,
		const char *	attr_name
	)

Checks if a given attribute exists.

Parameters

instance	The object to check for the attribute.
attr_name	The name of the attribute to check.

Returns: Returns TRUE if the attribute exists.

Definition at line 139 of file remmina_plugin_python_common.c.

◆ remmina_plugin_python_check_error()

gboolean remmina_plugin_python_check_error ( void )

Checks if an error has occurred and prints it.

Returns: Returns TRUE if an error has occurred.

Definition at line 98 of file remmina_plugin_python_common.c.

◆ remmina_plugin_python_copy_string_from_python()

char* remmina_plugin_python_copy_string_from_python	(	PyObject *	string,
		Py_ssize_t	len
	)

Copies a string from a Python object to a new point in memory.

Parameters

string	The python object, containing the string to copy.
len	The length of the string to copy.

Returns: A char pointer to the new copy of the string.

Definition at line 172 of file remmina_plugin_python_common.c.

◆ remmina_plugin_python_generic_new()

PyGeneric* remmina_plugin_python_generic_new ( void )

Creates a new instance of PyGeneric.

Definition at line 559 of file remmina_plugin_python_remmina.c.

◆ remmina_plugin_python_get_attribute_long()

long remmina_plugin_python_get_attribute_long	(	PyObject *	instance,
		const char *	attr_name,
		long	def
	)

Gets the attribute as long value.

Parameters

instance	The instance of the object to get the attribute.
constant_name	The name of the attribute to get.
def	The value to return if the attribute doesn't exist or is not set.