diff options
8 files changed, 1068 insertions, 6 deletions
diff --git a/content-extra/api/spice-gtk/SpiceChannel.html b/content-extra/api/spice-gtk/SpiceChannel.html index 7a48592..6ea1607 100644 --- a/content-extra/api/spice-gtk/SpiceChannel.html +++ b/content-extra/api/spice-gtk/SpiceChannel.html @@ -178,6 +178,12 @@ justifications. </tr> <tr> <td class="property_type"> +<a href="/usr/share/gtk-doc/html/gioGSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceChannel.html#SpiceChannel--socket" title="The “socket” property">socket</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</td> <td class="property_name"><a class="link" href="SpiceChannel.html#SpiceChannel--spice-session" title="The “spice-session” property">spice-session</a></td> <td class="property_flags">Read / Write / Construct Only</td> @@ -857,6 +863,17 @@ is in error state and can provide additional error details.</p> </div> <hr> <div class="refsect2"> +<a name="SpiceChannel--socket"></a><h3>The <code class="literal">“socket”</code> property</h3> +<pre class="programlisting"> “socket” <a href="/usr/share/gtk-doc/html/gioGSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</pre> +<p>Get the underlying <a href="/usr/share/gtk-doc/html/gioGSocket.html#GSocket-struct"><span class="type">GSocket</span></a>. Note that you should not read or +write any data to it directly since this will likely corrupt +the channel stream. This property is mainly useful to get some +connections details.</p> +<p>Flags: Read</p> +<p class="since">Since: 0.33</p> +</div> +<hr> +<div class="refsect2"> <a name="SpiceChannel--spice-session"></a><h3>The <code class="literal">“spice-session”</code> property</h3> <pre class="programlisting"> “spice-session” <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</pre> <p>Spice session.</p> diff --git a/content-extra/api/spice-gtk/SpiceFileTransferTask.html b/content-extra/api/spice-gtk/SpiceFileTransferTask.html index 5867d48..df37860 100644 --- a/content-extra/api/spice-gtk/SpiceFileTransferTask.html +++ b/content-extra/api/spice-gtk/SpiceFileTransferTask.html @@ -70,6 +70,22 @@ justifications. </tr> <tr> <td class="function_type"> +<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-total-bytes" title="spice_file_transfer_task_get_total_bytes ()">spice_file_transfer_task_get_total_bytes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-transferred-bytes" title="spice_file_transfer_task_get_transferred_bytes ()">spice_file_transfer_task_get_transferred_bytes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> @@ -116,6 +132,16 @@ justifications. <td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--progress" title="The “progress” property">progress</a></td> <td class="property_flags">Read</td> </tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> +<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--total-bytes" title="The “total-bytes” property">total-bytes</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> +<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--transferred-bytes" title="The “transferred-bytes” property">transferred-bytes</a></td> +<td class="property_flags">Read</td> +</tr> </tbody> </table></div> </div> @@ -178,7 +204,7 @@ transfer task.</p> </div> <div class="refsect3"> <a name="spice-file-transfer-task-get-progress.returns"></a><h4>Returns</h4> -<p> A percentage value between 0 and 100</p> +<p> A fractional value between 0 and 1.0</p> </div> <p class="since">Since: 0.31</p> </div> @@ -206,12 +232,68 @@ spice_file_transfer_task_get_filename (<em class="parameter"><code><a class="lin <div class="refsect3"> <a name="spice-file-transfer-task-get-filename.returns"></a><h4>Returns</h4> <p> The basename of the file. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: 0.31</p> </div> <hr> <div class="refsect2"> +<a name="spice-file-transfer-task-get-total-bytes"></a><h3>spice_file_transfer_task_get_total_bytes ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +spice_file_transfer_task_get_total_bytes + (<em class="parameter"><code><a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *self</code></em>);</pre> +<p>Gets the total size in bytes of the file transfer.</p> +<div class="refsect3"> +<a name="spice-file-transfer-task-get-total-bytes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a file transfer task</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-file-transfer-task-get-total-bytes.returns"></a><h4>Returns</h4> +<p> The total size of the file transfer</p> +</div> +<p class="since">Since: 0.33</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-file-transfer-task-get-transferred-bytes"></a><h3>spice_file_transfer_task_get_transferred_bytes ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +spice_file_transfer_task_get_transferred_bytes + (<em class="parameter"><code><a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *self</code></em>);</pre> +<p>Gets the number of bytes that have been transferred so far.</p> +<div class="refsect3"> +<a name="spice-file-transfer-task-get-transferred-bytes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a file transfer task</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-file-transfer-task-get-transferred-bytes.returns"></a><h4>Returns</h4> +<p> The number of transferred bytes</p> +</div> +<p class="since">Since: 0.33</p> +</div> +<hr> +<div class="refsect2"> <a name="spice-file-transfer-task-cancel"></a><h3>spice_file_transfer_task_cancel ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> spice_file_transfer_task_cancel (<em class="parameter"><code><a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *self</code></em>);</pre> @@ -279,13 +361,31 @@ in the cancellation of other tasks.</p> <a name="SpiceFileTransferTask--progress"></a><h3>The <code class="literal">“progress”</code> property</h3> <pre class="programlisting"> “progress” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> <p>The current state of the file transfer. This value indicates a -percentage, and ranges from 0 to 100. Listen for change notifications on +fraction, and ranges from 0 to 1.0. Listen for change notifications on this property to be updated whenever the file transfer progress changes.</p> <p>Flags: Read</p> -<p>Allowed values: [0,100]</p> +<p>Allowed values: [0,1]</p> <p>Default value: 0</p> <p class="since">Since: 0.31</p> </div> +<hr> +<div class="refsect2"> +<a name="SpiceFileTransferTask--total-bytes"></a><h3>The <code class="literal">“total-bytes”</code> property</h3> +<pre class="programlisting"> “total-bytes” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> +<p>The total size in bytes of this file transfer.</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +<p class="since">Since: 0.33</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceFileTransferTask--transferred-bytes"></a><h3>The <code class="literal">“transferred-bytes”</code> property</h3> +<pre class="programlisting"> “transferred-bytes” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> +<p>The number of bytes that have been transferred so far.</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +<p class="since">Since: 0.33</p> +</div> </div> <div class="refsect1"> <a name="SpiceFileTransferTask.signal-details"></a><h2>Signal Details</h2> 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 @@ </dt> <dd></dd> <dt> +<a class="link" href="SpiceChannel.html#SpiceChannel--socket" title="The “socket” property">SpiceChannel:socket</a>, object property in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> <a class="link" href="SpiceChannel.html#SpiceChannel--spice-session" title="The “spice-session” property">SpiceChannel:spice-session</a>, object property in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> </dt> <dd></dd> @@ -325,6 +329,14 @@ </dt> <dd></dd> <dt> +<a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--total-bytes" title="The “total-bytes” property">SpiceFileTransferTask:total-bytes</a>, object property in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--transferred-bytes" title="The “transferred-bytes” property">SpiceFileTransferTask:transferred-bytes</a>, object property in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> +</dt> +<dd></dd> +<dt> <a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-cancel" title="spice_file_transfer_task_cancel ()">spice_file_transfer_task_cancel</a>, function in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> </dt> <dd></dd> @@ -336,6 +348,14 @@ <a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-progress" title="spice_file_transfer_task_get_progress ()">spice_file_transfer_task_get_progress</a>, function in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> </dt> <dd></dd> +<dt> +<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-total-bytes" title="spice_file_transfer_task_get_total_bytes ()">spice_file_transfer_task_get_total_bytes</a>, function in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-transferred-bytes" title="spice_file_transfer_task_get_transferred_bytes ()">spice_file_transfer_task_get_transferred_bytes</a>, function in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> +</dt> +<dd></dd> <a name="idxG"></a><h3 class="title">G</h3> <dt> <a class="link" href="SpiceSession.html#spice-get-option-group" title="spice_get_option_group ()">spice_get_option_group</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Spice Display: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch03.html" title="GTK Widget, from spice-client-gtk"> +<link rel="prev" href="spice-gtk-SpiceGtkSession.html" title="Spice GTK Session"> +<link rel="next" href="spice-gtk-SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"> +<meta name="generator" content="GTK-Doc V1.25 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#spice-gtk-SpiceDisplay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#spice-gtk-SpiceDisplay.object-hierarchy" class="shortcut">Object Hierarchy</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="spice-gtk-SpiceGtkSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="spice-gtk-SpiceUsbDeviceWidget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="spice-gtk-SpiceDisplay"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="spice-gtk-SpiceDisplay.top_of_page"></a>Spice Display</span></h2> +<p>Spice Display — a GTK display widget</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.stability-level"></a><h2>Stability Level</h2> +<acronym title="The intention of a Stable interface is to enable arbitrary third parties to +develop applications to these interfaces, release them, and have confidence that +they will run on all minor releases of the product (after the one in which the +interface was introduced, and within the same major release). Even at a major +release, incompatible changes are expected to be rare, and to have strong +justifications. +"><span class="acronym">Stable</span></acronym>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">SpiceDisplay</span> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-new" title="spice_display_new ()">spice_display_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">SpiceDisplay</span> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-new-with-monitor" title="spice_display_new_with_monitor ()">spice_display_new_with_monitor</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-mouse-ungrab" title="spice_display_mouse_ungrab ()">spice_display_mouse_ungrab</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-set-grab-keys" title="spice_display_set_grab_keys ()">spice_display_set_grab_keys</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-get-grab-keys" title="spice_display_get_grab_keys ()">spice_display_get_grab_keys</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-send-keys" title="spice_display_send_keys ()">spice_display_send_keys</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="returnvalue">GdkPixbuf</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-get-pixbuf" title="spice_display_get_pixbuf ()">spice_display_get_pixbuf</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-grab-sequence-new" title="spice_grab_sequence_new ()">spice_grab_sequence_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-grab-sequence-new-from-string" title="spice_grab_sequence_new_from_string ()">spice_grab_sequence_new_from_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-grab-sequence-copy" title="spice_grab_sequence_copy ()">spice_grab_sequence_copy</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-grab-sequence-free" title="spice_grab_sequence_free ()">spice_grab_sequence_free</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceDisplay.html#spice-grab-sequence-as-string" title="spice_grab_sequence_as_string ()">spice_grab_sequence_as_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<a name="SpiceGrabSequence"></a><div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceDisplayKeyEvent" title="enum SpiceDisplayKeyEvent">SpiceDisplayKeyEvent</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence-struct" title="SpiceGrabSequence">SpiceGrabSequence</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> + <span class="lineart">╰──</span> SpiceGrabSequence +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client-gtk.h> +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.description"></a><h2>Description</h2> +<p>A GTK widget that displays a SPICE server. It sends keyboard/mouse +events and can also share clipboard...</p> +<p>Arbitrary key events can be sent thanks to <a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-send-keys" title="spice_display_send_keys ()"><code class="function">spice_display_send_keys()</code></a>.</p> +<p>The widget will optionally grab the keyboard and the mouse when +focused if the properties <span class="type">“grab-keyboard”</span> and +<span class="type">“grab-mouse”</span> are <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> respectively. It can be +ungrabbed with <a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-mouse-ungrab" title="spice_display_mouse_ungrab ()"><code class="function">spice_display_mouse_ungrab()</code></a>, and by setting a key +combination with <a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-set-grab-keys" title="spice_display_set_grab_keys ()"><code class="function">spice_display_set_grab_keys()</code></a>.</p> +<p>Finally, <a class="link" href="spice-gtk-SpiceDisplay.html#spice-display-get-pixbuf" title="spice_display_get_pixbuf ()"><code class="function">spice_display_get_pixbuf()</code></a> will take a screenshot of the +current display and return an <a href="/usr/share/gtk-doc/html/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> (that you can then easily +save to disk).</p> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-display-new"></a><h3>spice_display_new ()</h3> +<pre class="programlisting"><span class="returnvalue">SpiceDisplay</span> * +spice_display_new (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>, + <em class="parameter"><code><span class="type">int</span> channel_id</code></em>);</pre> +<p>Creates a new <span class="type">SpiceDisplay</span> widget.</p> +<div class="refsect3"> +<a name="spice-display-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>session</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_id</p></td> +<td class="parameter_description"><p>the display channel ID to associate with <span class="type">SpiceDisplay</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-display-new.returns"></a><h4>Returns</h4> +<p> a new <span class="type">SpiceDisplay</span> widget.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-new-with-monitor"></a><h3>spice_display_new_with_monitor ()</h3> +<pre class="programlisting"><span class="returnvalue">SpiceDisplay</span> * +spice_display_new_with_monitor (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> channel_id</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> monitor_id</code></em>);</pre> +<p>Creates a new <span class="type">SpiceDisplay</span> widget associated with the monitor id.</p> +<div class="refsect3"> +<a name="spice-display-new-with-monitor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>session</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_id</p></td> +<td class="parameter_description"><p>the display channel ID to associate with <span class="type">SpiceDisplay</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>monitor_id</p></td> +<td class="parameter_description"><p>the monitor id within the display channel</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-display-new-with-monitor.returns"></a><h4>Returns</h4> +<p> a new <span class="type">SpiceDisplay</span> widget.</p> +</div> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-mouse-ungrab"></a><h3>spice_display_mouse_ungrab ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_display_mouse_ungrab (<em class="parameter"><code><span class="type">SpiceDisplay</span> *display</code></em>);</pre> +<p>Ungrab the mouse.</p> +<div class="refsect3"> +<a name="spice-display-mouse-ungrab.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>display</p></td> +<td class="parameter_description"><p>a <span class="type">SpiceDisplay</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-set-grab-keys"></a><h3>spice_display_set_grab_keys ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_display_set_grab_keys (<em class="parameter"><code><span class="type">SpiceDisplay</span> *display</code></em>, + <em class="parameter"><code><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> *seq</code></em>);</pre> +<p>Set the key combination to grab/ungrab the keyboard. The default is +"Control L + Alt L".</p> +<div class="refsect3"> +<a name="spice-display-set-grab-keys.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>display</p></td> +<td class="parameter_description"><p>the display widget</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>seq</p></td> +<td class="parameter_description"><p> key sequence. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-get-grab-keys"></a><h3>spice_display_get_grab_keys ()</h3> +<pre class="programlisting"><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_display_get_grab_keys (<em class="parameter"><code><span class="type">SpiceDisplay</span> *display</code></em>);</pre> +<p>Finds the current grab key combination for the <em class="parameter"><code>display</code></em> +.</p> +<div class="refsect3"> +<a name="spice-display-get-grab-keys.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>display</p></td> +<td class="parameter_description"><p>the display widget</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-display-get-grab-keys.returns"></a><h4>Returns</h4> +<p> the current grab key combination. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-send-keys"></a><h3>spice_display_send_keys ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_display_send_keys (<em class="parameter"><code><span class="type">SpiceDisplay</span> *display</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> *keyvals</code></em>, + <em class="parameter"><code><span class="type">int</span> nkeyvals</code></em>, + <em class="parameter"><code><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceDisplayKeyEvent" title="enum SpiceDisplayKeyEvent"><span class="type">SpiceDisplayKeyEvent</span></a> kind</code></em>);</pre> +<p>Send keyval press/release events to the display.</p> +<div class="refsect3"> +<a name="spice-display-send-keys.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>display</p></td> +<td class="parameter_description"><p>The <span class="type">SpiceDisplay</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>keyvals</p></td> +<td class="parameter_description"><p> Keyval array. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=nkeyvals]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>nkeyvals</p></td> +<td class="parameter_description"><p>Length of keyvals</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceDisplayKeyEvent" title="enum SpiceDisplayKeyEvent"><span class="type">SpiceDisplayKeyEvent</span></a> action</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-get-pixbuf"></a><h3>spice_display_get_pixbuf ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="returnvalue">GdkPixbuf</span></a> * +spice_display_get_pixbuf (<em class="parameter"><code><span class="type">SpiceDisplay</span> *display</code></em>);</pre> +<p>Take a screenshot of the display.</p> +<div class="refsect3"> +<a name="spice-display-get-pixbuf.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>display</p></td> +<td class="parameter_description"><p>a <span class="type">SpiceDisplay</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-display-get-pixbuf.returns"></a><h4>Returns</h4> +<p> a <a href="/usr/share/gtk-doc/html/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> with the screenshot image buffer. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-grab-sequence-new"></a><h3>spice_grab_sequence_new ()</h3> +<pre class="programlisting"><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_grab_sequence_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> nkeysyms</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> *keysyms</code></em>);</pre> +<p>Creates a new grab sequence from a list of keysym values</p> +<div class="refsect3"> +<a name="spice-grab-sequence-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>nkeysyms</p></td> +<td class="parameter_description"><p>length of <em class="parameter"><code>keysyms</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>keysyms</p></td> +<td class="parameter_description"><p> the keysym values. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=nkeysyms]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-grab-sequence-new.returns"></a><h4>Returns</h4> +<p> a new grab sequence object. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-grab-sequence-new-from-string"></a><h3>spice_grab_sequence_new_from_string ()</h3> +<pre class="programlisting"><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_grab_sequence_new_from_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</pre> +<p>Creates a new <a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> from the string representation.</p> +<div class="refsect3"> +<a name="spice-grab-sequence-new-from-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>str</p></td> +<td class="parameter_description"><p>a string of '+' separated key names (ex: "Control_L+Alt_L")</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-grab-sequence-new-from-string.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-grab-sequence-copy"></a><h3>spice_grab_sequence_copy ()</h3> +<pre class="programlisting"><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_grab_sequence_copy (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> *sequence</code></em>);</pre> +<p>Creates a copy of the <em class="parameter"><code>sequence</code></em> +.</p> +<div class="refsect3"> +<a name="spice-grab-sequence-copy.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>sequence</p></td> +<td class="parameter_description"><p>sequence to copy</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-grab-sequence-copy.returns"></a><h4>Returns</h4> +<p> a copy of <em class="parameter"><code>sequence</code></em> +. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-grab-sequence-free"></a><h3>spice_grab_sequence_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_grab_sequence_free (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> *sequence</code></em>);</pre> +<p>Free <em class="parameter"><code>sequence</code></em> +.</p> +<div class="refsect3"> +<a name="spice-grab-sequence-free.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>sequence</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-grab-sequence-as-string"></a><h3>spice_grab_sequence_as_string ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_grab_sequence_as_string (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> *sequence</code></em>);</pre> +<p>Creates a string representing the <em class="parameter"><code>sequence</code></em> +.</p> +<div class="refsect3"> +<a name="spice-grab-sequence-as-string.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>sequence</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-grab-sequence-as-string.returns"></a><h4>Returns</h4> +<p> a newly allocated string representing the key sequence. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceDisplay.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceDisplayKeyEvent"></a><h3>enum SpiceDisplayKeyEvent</h3> +<p>Constants for key events.</p> +<div class="refsect3"> +<a name="SpiceDisplayKeyEvent.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="SPICE-DISPLAY-KEY-EVENT-PRESS:CAPS"></a>SPICE_DISPLAY_KEY_EVENT_PRESS</p></td> +<td class="enum_member_description"> +<p>key press</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-DISPLAY-KEY-EVENT-RELEASE:CAPS"></a>SPICE_DISPLAY_KEY_EVENT_RELEASE</p></td> +<td class="enum_member_description"> +<p>key release</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-DISPLAY-KEY-EVENT-CLICK:CAPS"></a>SPICE_DISPLAY_KEY_EVENT_CLICK</p></td> +<td class="enum_member_description"> +<p>key click (press and release)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceGrabSequence-struct"></a><h3>SpiceGrabSequence</h3> +<pre class="programlisting">typedef struct _SpiceGrabSequence SpiceGrabSequence;</pre> +<p>An opaque type that represents a grab sequence.</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Spice GTK Session: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch03.html" title="GTK Widget, from spice-client-gtk"> +<link rel="prev" href="ch03.html" title="GTK Widget, from spice-client-gtk"> +<link rel="next" href="spice-gtk-SpiceDisplay.html" title="Spice Display"> +<meta name="generator" content="GTK-Doc V1.25 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#spice-gtk-SpiceGtkSession.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="spice-gtk-SpiceDisplay.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="spice-gtk-SpiceGtkSession"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="spice-gtk-SpiceGtkSession.top_of_page"></a>Spice GTK Session</span></h2> +<p>Spice GTK Session — handles GTK connection details</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.stability-level"></a><h2>Stability Level</h2> +<acronym title="The intention of a Stable interface is to enable arbitrary third parties to +develop applications to these interfaces, release them, and have confidence that +they will run on all minor releases of the product (after the one in which the +interface was introduced, and within the same major release). Even at a major +release, incompatible changes are expected to be rare, and to have strong +justifications. +"><span class="acronym">Stable</span></acronym>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">SpiceGtkSession</span> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceGtkSession.html#spice-gtk-session-get" title="spice_gtk_session_get ()">spice_gtk_session_get</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceGtkSession.html#spice-gtk-session-copy-to-guest" title="spice_gtk_session_copy_to_guest ()">spice_gtk_session_copy_to_guest</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceGtkSession.html#spice-gtk-session-paste-from-guest" title="spice_gtk_session_paste_from_guest ()">spice_gtk_session_paste_from_guest</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client-gtk.h> +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.description"></a><h2>Description</h2> +<p>The <span class="type">SpiceGtkSession</span> class is the spice-client-gtk counter part of +<a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. It contains functionality which should be handled per +session rather then per <span class="type">SpiceDisplay</span> (one session can have multiple +displays), but which cannot live in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> as it depends on +GTK. For example the clipboard functionality.</p> +<p>There should always be a 1:1 relation between <span class="type">SpiceGtkSession</span> objects +and <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> objects. Therefor there is no spice_gtk_session_new, +instead there is <a class="link" href="spice-gtk-SpiceGtkSession.html#spice-gtk-session-get" title="spice_gtk_session_get ()"><code class="function">spice_gtk_session_get()</code></a> which ensures this 1:1 relation.</p> +<p>Client and guest clipboards will be shared automatically if +<span class="type">“auto-clipboard”</span> is set to <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>. Alternatively, you +can send / receive clipboard data from client to guest with +<a class="link" href="spice-gtk-SpiceGtkSession.html#spice-gtk-session-copy-to-guest" title="spice_gtk_session_copy_to_guest ()"><code class="function">spice_gtk_session_copy_to_guest()</code></a> / <a class="link" href="spice-gtk-SpiceGtkSession.html#spice-gtk-session-paste-from-guest" title="spice_gtk_session_paste_from_guest ()"><code class="function">spice_gtk_session_paste_from_guest()</code></a>.</p> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-gtk-session-get"></a><h3>spice_gtk_session_get ()</h3> +<pre class="programlisting"><span class="returnvalue">SpiceGtkSession</span> * +spice_gtk_session_get (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>Gets the <span class="type">SpiceGtkSession</span> associated with the passed in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. +A new <span class="type">SpiceGtkSession</span> instance will be created the first time this +function is called for a certain <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>.</p> +<p>Note that this function returns a weak reference, which should not be used +after the <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> itself has been unref-ed by the caller.</p> +<div class="refsect3"> +<a name="spice-gtk-session-get.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>session</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> for which to get the <span class="type">SpiceGtkSession</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-gtk-session-get.returns"></a><h4>Returns</h4> +<p> a weak reference to the <span class="type">SpiceGtkSession</span> associated with the passed in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a></p> +<p>Since 0.8. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-gtk-session-copy-to-guest"></a><h3>spice_gtk_session_copy_to_guest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_gtk_session_copy_to_guest (<em class="parameter"><code><span class="type">SpiceGtkSession</span> *self</code></em>);</pre> +<p>Copy client-side clipboard to guest clipboard.</p> +<p>Since 0.8</p> +<div class="refsect3"> +<a name="spice-gtk-session-copy-to-guest.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p><span class="type">SpiceGtkSession</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-gtk-session-paste-from-guest"></a><h3>spice_gtk_session_paste_from_guest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_gtk_session_paste_from_guest (<em class="parameter"><code><span class="type">SpiceGtkSession</span> *self</code></em>);</pre> +<p>Copy guest clipboard to client-side clipboard.</p> +<p>Since 0.8</p> +<div class="refsect3"> +<a name="spice-gtk-session-paste-from-guest.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p><span class="type">SpiceGtkSession</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.other_details"></a><h2>Types and Values</h2> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceGtkSession.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>, and the GTK widget <span class="type">SpiceDisplay</span></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/spice-gtk-SpiceUsbDeviceWidget.html b/content-extra/api/spice-gtk/spice-gtk-SpiceUsbDeviceWidget.html new file mode 100644 index 0000000..01820a6 --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk-SpiceUsbDeviceWidget.html @@ -0,0 +1,115 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Spice USB device selection widget: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch03.html" title="GTK Widget, from spice-client-gtk"> +<link rel="prev" href="spice-gtk-SpiceDisplay.html" title="Spice Display"> +<link rel="next" href="application-support.html" title="Application Support, from spice-client-glib"> +<meta name="generator" content="GTK-Doc V1.25 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#spice-gtk-SpiceUsbDeviceWidget.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="spice-gtk-SpiceDisplay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="application-support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="spice-gtk-SpiceUsbDeviceWidget"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="spice-gtk-SpiceUsbDeviceWidget.top_of_page"></a>Spice USB device selection widget</span></h2> +<p>Spice USB device selection widget — USB device selection widget</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="spice-gtk-SpiceUsbDeviceWidget.stability-level"></a><h2>Stability Level</h2> +<acronym title="The intention of a Stable interface is to enable arbitrary third parties to +develop applications to these interfaces, release them, and have confidence that +they will run on all minor releases of the product (after the one in which the +interface was introduced, and within the same major release). Even at a major +release, incompatible changes are expected to be rare, and to have strong +justifications. +"><span class="acronym">Stable</span></acronym>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceUsbDeviceWidget.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/gtk3GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceUsbDeviceWidget.html#spice-usb-device-widget-new" title="spice_usb_device_widget_new ()">spice_usb_device_widget_new</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceUsbDeviceWidget.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client-gtk.h> +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceUsbDeviceWidget.description"></a><h2>Description</h2> +<p><span class="type">SpiceUsbDeviceWidget</span> is a gtk widget which apps can use to easily +add an UI to select USB devices to redirect (or unredirect).</p> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceUsbDeviceWidget.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-usb-device-widget-new"></a><h3>spice_usb_device_widget_new ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +spice_usb_device_widget_new (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *device_format_string</code></em>);</pre> +<p>Creates a new widget to control USB redirection.</p> +<div class="refsect3"> +<a name="spice-usb-device-widget-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>session</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> for which to widget will control USB redirection</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device_format_string</p></td> +<td class="parameter_description"><p> String passed to +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-get-description" title="spice_usb_device_get_description ()"><code class="function">spice_usb_device_get_description()</code></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="spice-usb-device-widget-new.returns"></a><h4>Returns</h4> +<p> a new <span class="type">SpiceUsbDeviceWidget</span> instance</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceUsbDeviceWidget.other_details"></a><h2>Types and Values</h2> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html>
\ 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.</p> <hr> <div class="refsect2"> <a name="SPICE-GTK-MICRO-VERSION:CAPS"></a><h3>SPICE_GTK_MICRO_VERSION</h3> -<pre class="programlisting">#define SPICE_GTK_MICRO_VERSION (30) +<pre class="programlisting">#define SPICE_GTK_MICRO_VERSION (0) </pre> <p>Spice-Gtk micro version component (e.g. 3 if version is 1.2.3)</p> <p class="since">Since: 0.24</p> @@ -136,7 +136,7 @@ of Spice-Gtk is greater than the required one.</p> <hr> <div class="refsect2"> <a name="SPICE-GTK-MINOR-VERSION:CAPS"></a><h3>SPICE_GTK_MINOR_VERSION</h3> -<pre class="programlisting">#define SPICE_GTK_MINOR_VERSION (32) +<pre class="programlisting">#define SPICE_GTK_MINOR_VERSION (33-dirty) </pre> <p>Spice-Gtk minor version component (e.g. 2 if version is 1.2.3)</p> <p class="since">Since: 0.24</p> 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 @@ <keyword type="struct" name="SpiceChannelClass" link="SpiceChannel.html#SpiceChannelClass"/> <keyword type="property" name="The “channel-id” property" link="SpiceChannel.html#SpiceChannel--channel-id"/> <keyword type="property" name="The “channel-type” property" link="SpiceChannel.html#SpiceChannel--channel-type"/> + <keyword type="property" name="The “socket” property" link="SpiceChannel.html#SpiceChannel--socket"/> <keyword type="property" name="The “spice-session” property" link="SpiceChannel.html#SpiceChannel--spice-session"/> <keyword type="property" name="The “total-read-bytes” property" link="SpiceChannel.html#SpiceChannel--total-read-bytes"/> <keyword type="signal" name="The “channel-event” signal" link="SpiceChannel.html#SpiceChannel-channel-event"/> @@ -314,12 +315,16 @@ <keyword type="struct" name="SpiceURI" link="spice-gtk-SpiceURI.html#SpiceURI"/> <keyword type="function" name="spice_file_transfer_task_get_progress ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-get-progress" since="0.31"/> <keyword type="function" name="spice_file_transfer_task_get_filename ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-get-filename" since="0.31"/> + <keyword type="function" name="spice_file_transfer_task_get_total_bytes ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-get-total-bytes" since="0.33"/> + <keyword type="function" name="spice_file_transfer_task_get_transferred_bytes ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-get-transferred-bytes" since="0.33"/> <keyword type="function" name="spice_file_transfer_task_cancel ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-cancel" since="0.31"/> <keyword type="property" name="The “cancellable” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--cancellable"/> <keyword type="property" name="The “channel” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--channel"/> <keyword type="property" name="The “file” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--file"/> <keyword type="property" name="The “id” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--id"/> <keyword type="property" name="The “progress” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--progress"/> + <keyword type="property" name="The “total-bytes” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--total-bytes"/> + <keyword type="property" name="The “transferred-bytes” property" link="SpiceFileTransferTask.html#SpiceFileTransferTask--transferred-bytes"/> <keyword type="signal" name="The “finished” signal" link="SpiceFileTransferTask.html#SpiceFileTransferTask-finished"/> <keyword type="constant" name="SPICE_SESSION_MIGRATION_NONE" link="SpiceSession.html#SPICE-SESSION-MIGRATION-NONE:CAPS"/> <keyword type="constant" name="SPICE_SESSION_MIGRATION_SWITCHING" link="SpiceSession.html#SPICE-SESSION-MIGRATION-SWITCHING:CAPS"/> |