Spice Display: Spice-GTK Reference Manual

Signal Details

diff --git a/content-extra/api/spice-gtk/api-index-full.html b/content-extra/api/spice-gtk/api-index-full.html index 689d853..38916a2 100644 --- a/content-extra/api/spice-gtk/api-index-full.html +++ b/content-extra/api/spice-gtk/api-index-full.html @@ -91,6 +91,10 @@

+SpiceChannel:socket, object property in SpiceChannel +

SpiceChannel:spice-session, object property in SpiceChannel

@@ -325,6 +329,14 @@

+SpiceFileTransferTask:total-bytes, object property in SpiceFileTransferTask +

+SpiceFileTransferTask:transferred-bytes, object property in SpiceFileTransferTask +

spice_file_transfer_task_cancel, function in SpiceFileTransferTask

@@ -336,6 +348,14 @@ spice_file_transfer_task_get_progress, function in SpiceFileTransferTask

+spice_file_transfer_task_get_total_bytes, function in SpiceFileTransferTask +

+spice_file_transfer_task_get_transferred_bytes, function in SpiceFileTransferTask +

G

spice_get_option_group, function in SpiceSession diff --git a/content-extra/api/spice-gtk/spice-gtk-SpiceDisplay.html b/content-extra/api/spice-gtk/spice-gtk-SpiceDisplay.html new file mode 100644 index 0000000..fced72c --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk-SpiceDisplay.html @@ -0,0 +1,615 @@ + + + + +Spice Display: Spice-GTK Reference Manual + + + + + + + + + + + + + + + + +

+ + +

Spice Display

Spice Display — a GTK display widget

Stability Level

+Stable, unless otherwise indicated +

Functions

++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+SpiceDisplay * +	+spice_display_new () +
+SpiceDisplay * +	+spice_display_new_with_monitor () +
+void +	+spice_display_mouse_ungrab () +
+void +	+spice_display_set_grab_keys () +
+SpiceGrabSequence * +	+spice_display_get_grab_keys () +
+void +	+spice_display_send_keys () +
+GdkPixbuf * +	+spice_display_get_pixbuf () +
+SpiceGrabSequence * +	+spice_grab_sequence_new () +
+SpiceGrabSequence * +	+spice_grab_sequence_new_from_string () +
+SpiceGrabSequence * +	+spice_grab_sequence_copy () +
+void +	+spice_grab_sequence_free () +
+gchar * +	+spice_grab_sequence_as_string () +

Types and Values

++++ + + + + + + + + + + +

enum	SpiceDisplayKeyEvent
	SpiceGrabSequence

Object Hierarchy

    GBoxed
+    ╰── SpiceGrabSequence
+

Includes

#include <spice-client-gtk.h>
+

Description

A GTK widget that displays a SPICE server. It sends keyboard/mouse +events and can also share clipboard...

Arbitrary key events can be sent thanks to spice_display_send_keys().

The widget will optionally grab the keyboard and the mouse when +focused if the properties “grab-keyboard” and +“grab-mouse” are TRUE respectively. It can be +ungrabbed with spice_display_mouse_ungrab(), and by setting a key +combination with spice_display_set_grab_keys().

Finally, spice_display_get_pixbuf() will take a screenshot of the +current display and return an GdkPixbuf (that you can then easily +save to disk).

Functions

spice_display_new ()

SpiceDisplay *
+spice_display_new (SpiceSession *session,
+                   int channel_id);

Creates a new SpiceDisplay widget.

Parameters

+++++ + + + + + + + + + + + + +

session	a SpiceSession
channel_id	the display channel ID to associate with SpiceDisplay

Returns

a new SpiceDisplay widget.

spice_display_new_with_monitor ()

SpiceDisplay *
+spice_display_new_with_monitor (SpiceSession *session,
+                                gint channel_id,
+                                gint monitor_id);

Creates a new SpiceDisplay widget associated with the monitor id.

Parameters

+++++ + + + + + + + + + + + + + + + + + +

session	a SpiceSession
channel_id	the display channel ID to associate with SpiceDisplay
monitor_id	the monitor id within the display channel

Returns

a new SpiceDisplay widget.

Since: 0.13

spice_display_mouse_ungrab ()

void
+spice_display_mouse_ungrab (SpiceDisplay *display);

Ungrab the mouse.

Parameters

+++++ + + + + + +

display

a SpiceDisplay

spice_display_set_grab_keys ()

void
+spice_display_set_grab_keys (SpiceDisplay *display,
+                             SpiceGrabSequence *seq);

Set the key combination to grab/ungrab the keyboard. The default is +"Control L + Alt L".

Parameters

+++++ + + + + + + + + + + + + +

display	the display widget
seq	key sequence.	[transfer none]

spice_display_get_grab_keys ()

SpiceGrabSequence *
+spice_display_get_grab_keys (SpiceDisplay *display);

Finds the current grab key combination for the display +.

Parameters

+++++ + + + + + +

display

the display widget

Returns

the current grab key combination.

[transfer none]

spice_display_send_keys ()

void
+spice_display_send_keys (SpiceDisplay *display,
+                         const guint *keyvals,
+                         int nkeyvals,
+                         SpiceDisplayKeyEvent kind);

Send keyval press/release events to the display.

Parameters

+++++ + + + + + + + + + + + + + + + + + + + + + + +

display	The SpiceDisplay
keyvals	Keyval array.	[array length=nkeyvals]
nkeyvals	Length of keyvals
kind	SpiceDisplayKeyEvent action

spice_display_get_pixbuf ()

GdkPixbuf *
+spice_display_get_pixbuf (SpiceDisplay *display);

Take a screenshot of the display.

Parameters

+++++ + + + + + +

display

a SpiceDisplay

Returns

a GdkPixbuf with the screenshot image buffer.

[transfer full]

spice_grab_sequence_new ()

SpiceGrabSequence *
+spice_grab_sequence_new (guint nkeysyms,
+                         guint *keysyms);

Creates a new grab sequence from a list of keysym values

Parameters

+++++ + + + + + + + + + + + + +

nkeysyms	length of `keysyms` +
keysyms	the keysym values.	[array length=nkeysyms]

Returns

a new grab sequence object.

[transfer full]

spice_grab_sequence_new_from_string ()

SpiceGrabSequence *
+spice_grab_sequence_new_from_string (const gchar *str);

Creates a new SpiceGrabSequence from the string representation.

Parameters

+++++ + + + + + +

str

a string of '+' separated key names (ex: "Control_L+Alt_L")

Returns

a new SpiceGrabSequence.

spice_grab_sequence_copy ()

SpiceGrabSequence *
+spice_grab_sequence_copy (SpiceGrabSequence *sequence);

Creates a copy of the sequence +.

Parameters

+++++ + + + + + +

sequence

sequence to copy

Returns

a copy of sequence +.

[transfer full]

spice_grab_sequence_free ()

void
+spice_grab_sequence_free (SpiceGrabSequence *sequence);

Free sequence +.

Parameters

+++++ + + + + + +

sequence

a SpiceGrabSequence

spice_grab_sequence_as_string ()

gchar *
+spice_grab_sequence_as_string (SpiceGrabSequence *sequence);

Creates a string representing the sequence +.

Parameters

+++++ + + + + + +

sequence

a SpiceGrabSequence

Returns

a newly allocated string representing the key sequence.

[transfer full]

Types and Values

enum SpiceDisplayKeyEvent

Constants for key events.

Members

+++++ + + + + + + + + + + + + + + + + + +

SPICE_DISPLAY_KEY_EVENT_PRESS	+ key press +
SPICE_DISPLAY_KEY_EVENT_RELEASE	+ key release +
SPICE_DISPLAY_KEY_EVENT_CLICK	+ key click (press and release) +

SpiceGrabSequence

typedef struct _SpiceGrabSequence SpiceGrabSequence;

An opaque type that represents a grab sequence.

+ + + \ No newline at end of file diff --git a/content-extra/api/spice-gtk/spice-gtk-SpiceGtkSession.html b/content-extra/api/spice-gtk/spice-gtk-SpiceGtkSession.html new file mode 100644 index 0000000..330b2d7 --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk-SpiceGtkSession.html @@ -0,0 +1,190 @@ + + + + +Spice GTK Session: Spice-GTK Reference Manual + + + + + + + + + + + + + + + + +

+ + +

Spice GTK Session

Spice GTK Session — handles GTK connection details

Stability Level

+Stable, unless otherwise indicated +

Functions

++++ + + + + + + + + + + + + + + +

+SpiceGtkSession * +	+spice_gtk_session_get () +
+void +	+spice_gtk_session_copy_to_guest () +
+void +	+spice_gtk_session_paste_from_guest () +

Includes

#include <spice-client-gtk.h>
+

Description

The SpiceGtkSession class is the spice-client-gtk counter part of +SpiceSession. It contains functionality which should be handled per +session rather then per SpiceDisplay (one session can have multiple +displays), but which cannot live in SpiceSession as it depends on +GTK. For example the clipboard functionality.

There should always be a 1:1 relation between SpiceGtkSession objects +and SpiceSession objects. Therefor there is no spice_gtk_session_new, +instead there is spice_gtk_session_get() which ensures this 1:1 relation.

Client and guest clipboards will be shared automatically if +“auto-clipboard” is set to TRUE. Alternatively, you +can send / receive clipboard data from client to guest with +spice_gtk_session_copy_to_guest() / spice_gtk_session_paste_from_guest().

Functions

spice_gtk_session_get ()

SpiceGtkSession *
+spice_gtk_session_get (SpiceSession *session);

Gets the SpiceGtkSession associated with the passed in SpiceSession. +A new SpiceGtkSession instance will be created the first time this +function is called for a certain SpiceSession.

Note that this function returns a weak reference, which should not be used +after the SpiceSession itself has been unref-ed by the caller.

Parameters

+++++ + + + + + +

session

SpiceSession for which to get the SpiceGtkSession

Returns

a weak reference to the SpiceGtkSession associated with the passed in SpiceSession

Since 0.8.

[transfer none]

spice_gtk_session_copy_to_guest ()

void
+spice_gtk_session_copy_to_guest (SpiceGtkSession *self);

Copy client-side clipboard to guest clipboard.

Since 0.8

Parameters

+++++ + + + + + +

self

SpiceGtkSession

spice_gtk_session_paste_from_guest ()

void
+spice_gtk_session_paste_from_guest (SpiceGtkSession *self);

Copy guest clipboard to client-side clipboard.

Since 0.8

Parameters

+++++ + + + + + +

self

SpiceGtkSession

Types and Values

Spice USB device selection widget

Spice USB device selection widget — USB device selection widget

Stability Level

+Stable, unless otherwise indicated +

Functions

++++ + + + + +

+GtkWidget * +

+spice_usb_device_widget_new () +

Includes

#include <spice-client-gtk.h>
+

Description

SpiceUsbDeviceWidget is a gtk widget which apps can use to easily +add an UI to select USB devices to redirect (or unredirect).

Functions

spice_usb_device_widget_new ()

GtkWidget *
+spice_usb_device_widget_new (SpiceSession *session,
+                             const gchar *device_format_string);

Creates a new widget to control USB redirection.

Parameters

+++++ + + + + + + + + + + + + +

session	SpiceSession for which to widget will control USB redirection
device_format_string	String passed to +`spice_usb_device_get_description()`.	[allow-none]

Returns

a new SpiceUsbDeviceWidget instance

Types and Values

+ + + \ No newline at end of file diff --git a/content-extra/api/spice-gtk/spice-gtk-Version-Information.html b/content-extra/api/spice-gtk/spice-gtk-Version-Information.html index 9aaea27..46cff82 100644 --- a/content-extra/api/spice-gtk/spice-gtk-Version-Information.html +++ b/content-extra/api/spice-gtk/spice-gtk-Version-Information.html @@ -128,7 +128,7 @@ of Spice-Gtk is greater than the required one.

SPICE_GTK_MICRO_VERSION

#define SPICE_GTK_MICRO_VERSION              (30)
+#define SPICE_GTK_MICRO_VERSION              (0)
 
 Spice-Gtk micro version component (e.g. 3 if version is 1.2.3)
 Since: 0.24
@@ -136,7 +136,7 @@ of Spice-Gtk is greater than the required one.
 
 
 SPICE_GTK_MINOR_VERSION
-#define SPICE_GTK_MINOR_VERSION              (32)
+#define SPICE_GTK_MINOR_VERSION              (33-dirty)
 
 Spice-Gtk minor version component (e.g. 2 if version is 1.2.3)
 Since: 0.24
diff --git a/content-extra/api/spice-gtk/spice-gtk.devhelp2 b/content-extra/api/spice-gtk/spice-gtk.devhelp2
index 93305ff..72dabaf 100644
--- a/content-extra/api/spice-gtk/spice-gtk.devhelp2
+++ b/content-extra/api/spice-gtk/spice-gtk.devhelp2
@@ -111,6 +111,7 @@
     
     
     
+    
     
     
     
@@ -314,12 +315,16 @@
     
     
     
+    
+    
     
     
     
     
     
     
+    
+    
     
     
     
-- 
cgit v1.2.3

The “socket” property

The “spice-session” property

Returns

Returns

spice_file_transfer_task_get_total_bytes ()

Parameters

Returns

spice_file_transfer_task_get_transferred_bytes ()

Parameters

Returns

spice_file_transfer_task_cancel ()

The “progress” property

The “total-bytes” property

The “transferred-bytes” property

Signal Details

G

Spice Display

Stability Level

Functions

Types and Values

Object Hierarchy

Includes

Description

Functions

spice_display_new ()

Parameters

Returns

spice_display_new_with_monitor ()

Parameters

Returns

spice_display_mouse_ungrab ()

Parameters

spice_display_set_grab_keys ()

Parameters

spice_display_get_grab_keys ()

Parameters

Returns

spice_display_send_keys ()

Parameters

spice_display_get_pixbuf ()

Parameters

Returns

spice_grab_sequence_new ()

Parameters

Returns

spice_grab_sequence_new_from_string ()

Parameters

Returns

spice_grab_sequence_copy ()

Parameters

Returns

spice_grab_sequence_free ()

Parameters

spice_grab_sequence_as_string ()

Parameters

Returns

Types and Values

enum SpiceDisplayKeyEvent

Members

SpiceGrabSequence

Spice GTK Session

Stability Level

Functions

Includes

Description

Functions

spice_gtk_session_get ()

Parameters

Returns

spice_gtk_session_copy_to_guest ()

Parameters

spice_gtk_session_paste_from_guest ()

Parameters

Types and Values

See Also

Spice USB device selection widget

Stability Level

Functions

Includes

Description

The `“socket”` property

The `“spice-session”` property

The `“progress”` property

The `“total-bytes”` property

The `“transferred-bytes”` property